American Airlines · API Governance Rules

American Airlines API Rules

Spectral linting rules defining API design standards and conventions for American Airlines.

12 Rules error 8 warn 3 info 1
View Rules File View on GitHub

Rule Categories

get info operation parameter paths response schema servers

Rules

warn
info-title-prefix
API title must start with "American Airlines"
$.info.title
error
info-description-required
API must have a description
$.info
error
servers-defined
At least one server must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
error
operation-summary-required
Operations must have a summary
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Operations must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
error
response-success-required
Operations must have a success response
$.paths[*][get,post,put,patch,delete].responses
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
info
paths-kebab-case
Path segments should use kebab-case
$.paths[*]~
warn
schema-description-required
Component schemas should have descriptions
$.components.schemas[*]
warn
parameter-description-required
Parameters should have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]

Spectral Ruleset

Raw ↑ 
extends: spectral:oas
rules:
  info-title-prefix:
    description: API title must start with "American Airlines"
    severity: warn
    given: "$.info.title"
    then:
      function: pattern
      functionOptions:
        match: "^American Airlines"

  info-description-required:
    description: API must have a description
    severity: error
    given: "$.info"
    then:
      field: description
      function: truthy

  servers-defined:
    description: At least one server must be defined
    severity: error
    given: "$"
    then:
      field: servers
      function: truthy

  servers-https:
    description: Server URLs must use HTTPS
    severity: error
    given: "$.servers[*].url"
    then:
      function: pattern
      functionOptions:
        match: "^https://"

  operation-summary-required:
    description: Operations must have a summary
    severity: error
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: summary
      function: truthy

  operation-id-required:
    description: Operations must have an operationId
    severity: error
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: operationId
      function: truthy

  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

  response-success-required:
    description: Operations must have a success response
    severity: error
    given: "$.paths[*][get,post,put,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
            - required: ["200"]
            - required: ["201"]

  get-no-request-body:
    description: GET operations must not have a request body
    severity: error
    given: "$.paths[*].get"
    then:
      field: requestBody
      function: falsy

  paths-kebab-case:
    description: Path segments should use kebab-case
    severity: info
    given: "$.paths[*]~"
    then:
      function: pattern
      functionOptions:
        match: "^(\\/([a-z0-9-]+|\\{[a-zA-Z]+\\}))*$"

  schema-description-required:
    description: Component schemas should have descriptions
    severity: warn
    given: "$.components.schemas[*]"
    then:
      field: description
      function: truthy

  parameter-description-required:
    description: Parameters should have descriptions
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].parameters[*]"
    then:
      field: description
      function: truthy