rules: # INFO / METADATA info-title-required: description: Info title must be defined severity: error given: "$.info" then: field: title function: truthy info-title-alaska-prefix: description: API title should start with 'Alaska' severity: warn given: "$.info.title" then: function: pattern functionOptions: match: "^Alaska " info-description-required: description: Info description must be defined severity: warn given: "$.info" then: field: description function: truthy info-version-required: description: Info version must be defined severity: error given: "$.info" then: field: version function: truthy info-contact-required: description: Info should include contact information severity: warn given: "$.info" then: field: contact function: truthy # OPENAPI VERSION openapi-version-3: description: Must use OpenAPI 3.0.x severity: error given: "$" then: field: openapi function: pattern functionOptions: match: "^3\\.0\\." # SERVERS servers-required: description: Servers must be defined severity: error given: "$" then: field: servers function: truthy servers-https-required: description: Server URLs must use HTTPS severity: error given: "$.servers[*]" then: field: url function: pattern functionOptions: match: "^https://" servers-alaskaair-domain: description: Server URLs should use alaskaair.com or alaskacargo.com domains severity: warn given: "$.servers[*]" then: field: url function: pattern functionOptions: match: "alaska(air|cargo)\\.com" # PATHS — NAMING CONVENTIONS paths-kebab-case: description: Path segments should use kebab-case severity: warn given: "$.paths[*]~" then: function: pattern functionOptions: match: "^(/[a-z0-9-{}]+)+$" paths-no-trailing-slash: description: Paths must not have a trailing slash severity: error given: "$.paths[*]~" then: function: pattern functionOptions: notMatch: "/$" paths-versioned: description: API paths should include a version prefix severity: warn given: "$.paths[*]~" then: function: pattern functionOptions: match: "^/v[0-9]" # OPERATIONS operation-summary-required: description: Operations must have a summary severity: error given: "$.paths[*][get,post,put,patch,delete]" then: field: summary function: truthy operation-summary-alaska-prefix: description: Operation summaries should start with 'Alaska Airlines' or 'Alaska Air' severity: warn given: "$.paths[*][get,post,put,patch,delete].summary" then: function: pattern functionOptions: match: "^Alaska (Airlines|Air) " operation-description-required: description: Operations should have a description severity: warn given: "$.paths[*][get,post,put,patch,delete]" then: field: description function: truthy operation-operationid-required: description: Operations must have an operationId severity: error given: "$.paths[*][get,post,put,patch,delete]" then: field: operationId function: truthy operation-operationid-camel-case: description: OperationId should use camelCase severity: warn given: "$.paths[*][get,post,put,patch,delete].operationId" then: function: pattern functionOptions: match: "^[a-z][a-zA-Z0-9]+$" operation-tags-required: description: Operations must have at least one tag severity: error given: "$.paths[*][get,post,put,patch,delete]" then: field: tags function: truthy # TAGS tags-defined: description: Tags should be defined at the global level severity: warn given: "$" then: field: tags function: truthy tags-description-required: description: Global tags should have descriptions severity: warn given: "$.tags[*]" then: field: description function: truthy # PARAMETERS parameter-description-required: description: Parameters must have a description severity: error given: "$.paths[*][*].parameters[*]" then: field: description function: truthy parameter-schema-required: description: Parameters must have a schema severity: error given: "$.paths[*][*].parameters[*]" then: field: schema function: truthy parameter-iata-uppercase: description: IATA airport code parameters should use enum or note valid format severity: info given: "$.paths[*][*].parameters[?(@.name == 'origin' || @.name == 'destination' || @.name == 'originAirport' || @.name == 'destinationAirport')]" then: field: schema.example function: pattern functionOptions: match: "^[A-Z]{3}$" # RESPONSES response-success-required: description: Operations must have at least one 2xx response severity: error given: "$.paths[*][get,post,put,patch,delete]" then: field: responses function: truthy response-description-required: description: All responses must have a description severity: error given: "$.paths[*][*].responses[*]" then: field: description function: truthy response-401-required: description: APIs should define 401 Unauthorized response severity: warn given: "$.paths[*][get,post,put,patch,delete]" then: field: responses.401 function: truthy # SCHEMAS schema-description-required: description: Top-level schemas should have descriptions severity: warn given: "$.components.schemas[*]" then: field: description function: truthy schema-type-required: description: Schemas should define a type severity: warn given: "$.components.schemas[*]" then: field: type function: truthy # SECURITY security-schemes-defined: description: Security schemes must be defined severity: error given: "$" then: field: components.securitySchemes function: truthy # HTTP METHOD CONVENTIONS get-no-request-body: description: GET operations must not have a request body severity: error given: "$.paths[*].get" then: field: requestBody function: falsy # GENERAL QUALITY no-empty-descriptions: description: Descriptions must not be empty strings severity: error given: "$..description" then: function: pattern functionOptions: match: ".+" examples-encouraged: description: Schema properties should have examples severity: info given: "$.components.schemas[*].properties[*]" then: field: example function: truthy