Red Hat Ansible Automation Platform · API Governance Rules

Red Hat Ansible Automation Platform API Rules

Spectral linting rules defining API design standards and conventions for Red Hat Ansible Automation Platform.

59 Rules error 35 warn 11 info 13

Rules by declared severity: the level each rule assigns to a violation. These are not lint results.

Generated by API Evangelist Written by API Evangelist tooling for Red Hat Ansible Automation Platform's APIs. It is a starting point, not a ruleset Red Hat Ansible Automation Platform publishes or enforces.
View Rules File View on GitHub

Rule Categories

contact info license mediatype oauthflow operation operationid parameter path property requestbody response schema securityscheme server tag write

Rules

error
operation-has-operationid
Every operation declares an operationId (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
info
operationid-casing-snake
operationIds are snake case (measured: 83% of this contract)
$.paths[*][get,post,put,patch,delete].operationId
error
operation-has-summary
Every operation has a summary (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-tags
Every operation is tagged (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-success-response
Every operation declares a 2xx response (measured: 99% of this contract)
$.paths[*][get,post,put,patch,delete].responses
info
path-segment-casing-kebab
Path segments are kebab case (measured: 87% of this contract)
$.paths[*]~
error
path-params-in-braces
Path parameters use {braces}, not :colon (measured: 100% of this contract)
$.paths[*]~
info
write-declares-request-body
POST and PUT declare a request body (measured: 86% of this contract)
$.paths[*][post,put]
warn
response-media-type
Responses are served as application/json (measured: 99% of this contract)
$.paths[*][get,post,put,patch,delete].responses[*].content
warn
property-name-casing-snake
Schema property names are snake case (measured: 94% of this contract)
$.components.schemas[*].properties[*]~
warn
info-has-description
The contract's info block carries a description (measured: 97% of this contract)
$.info
info
info-has-contact-or-terms
The contract's info block names a contact or terms of service (measured: 82% of this contract)
$.info
error
info-title-present
Info declares title (measured: 100% of this contract)
$.info
warn
info-title-min-length
Info.title runs at least 19 characters (measured: 95% of this contract)
$.info.title
warn
info-description-present
Info declares description (measured: 97% of this contract)
$.info
error
info-description-min-length
Info.description runs at least 15 characters (measured: 100% of this contract)
$.info.description
info
info-contact-present
Info declares contact (measured: 82% of this contract)
$.info
info
info-license-present
Info declares license (measured: 82% of this contract)
$.info
error
info-version-present
Info declares version (measured: 100% of this contract)
$.info
error
info-version-semver
info.version is numeric (measured: 100% of this contract)
$.info.version
info
contact-name-present
Contact declares name (measured: 85% of this contract)
$.info.contact
info
contact-url-present
Contact declares url (measured: 85% of this contract)
$.info.contact
error
contact-url-https
Contact.url is https (measured: 100% of this contract)
$.info.contact.url
error
contact-email-present
Contact declares email (measured: 100% of this contract)
$.info.contact
error
license-name-present
License declares name (measured: 100% of this contract)
$.info.license
info
license-url-present
License declares url (measured: 85% of this contract)
$.info.license
error
license-url-https
License.url is https (measured: 100% of this contract)
$.info.license.url
error
server-url-present
Server declares url (measured: 100% of this contract)
$.servers[*]
error
server-description-min-length
Server.description runs at least 38 characters (measured: 100% of this contract)
$.servers[*].description
error
tag-name-present
Tag declares name (measured: 100% of this contract)
$.tags[*]
error
operation-tags-present
Operation declares tags (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-summary-present
Operation declares summary (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
warn
operation-summary-min-length
Operation.summary runs at least 11 characters (measured: 95% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].summary
warn
operation-description-min-length
Operation.description runs at least 19 characters (measured: 96% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].description
error
operation-operationid-present
Operation declares operationId (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
info
operation-operationid-casing-snake
Operation.operationId is snake case (measured: 83% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].operationId
info
operation-parameters-present
Operation declares parameters (measured: 83% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-responses-present
Operation declares responses (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
parameter-name-present
Parameter declares name (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-in-present
Parameter declares in (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-in-values
Parameter.in is one of path, query (measured: 99% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].in
info
parameter-description-present
Parameter declares description (measured: 82% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
warn
parameter-description-min-length
Parameter.description runs at least 17 characters (measured: 95% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].description
error
parameter-style-values
Parameter.style is one of form (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].style
error
parameter-schema-present
Parameter declares schema (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
requestbody-content-present
RequestBody declares content (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
info
requestbody-required-present
RequestBody declares required (measured: 87% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
error
mediatype-schema-present
MediaType declares schema (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].content[*]
error
response-description-present
Response declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
error
schema-type-present
Schema declares type (measured: 99% of this contract)
$.components.schemas[*]
warn
schema-type-values
Schema.type is one of object (measured: 98% of this contract)
$.components.schemas[*].type
warn
schema-description-min-length
Schema.description runs at least 27 characters (measured: 95% of this contract)
$.components.schemas[*].description
warn
schema-properties-present
Schema declares properties (measured: 97% of this contract)
$.components.schemas[*]
error
securityscheme-type-present
SecurityScheme declares type (measured: 100% of this contract)
$.components.securitySchemes[*]
error
securityscheme-type-values
SecurityScheme.type is one of apiKey, http, oauth2 (measured: 100% of this contract)
$.components.securitySchemes[*].type
error
securityscheme-in-values
SecurityScheme.in is one of cookie, header (measured: 100% of this contract)
$.components.securitySchemes[*].in
error
securityscheme-scheme-values
SecurityScheme.scheme is one of basic (measured: 100% of this contract)
$.components.securitySchemes[*].scheme
error
oauthflow-tokenurl-present
OAuthFlow declares tokenUrl (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*]
error
oauthflow-scopes-present
OAuthFlow declares scopes (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*]

Spectral Ruleset

Raw ↑ 
# authorship: generated by API Evangelist tooling (derive-rules.py, 2026-11-01). x-method: generated
# Every rule below was MEASURED against Red Hat Ansible Automation Platform's own contract before it was written; a rule is present only
# when the contract satisfies it at 80% or more. Severity: 100% -> error, >= 90% -> warn, else info.
# Provenance:
#   - operation-has-operationid: 100%
#   - operationid-casing-snake: 84%
#   - operation-has-summary: 100%
#   - operation-has-tags: 100%
#   - operation-has-success-response: 100%
#   - path-segment-casing-kebab: 88%
#   - path-params-in-braces: 100%
#   - write-declares-request-body: 86%
#   - response-media-type: 100%
#   - property-name-casing-snake: 94%
#   - info-has-description: 98%
#   - info-has-contact-or-terms: 83%
#   - info-title-present: 100%
#   - info-title-min-length: 96%
#   - info-description-present: 98%
#   - info-description-min-length: 100%
#   - info-contact-present: 83%
#   - info-license-present: 83%
#   - info-version-present: 100%
#   - info-version-semver: 100%
#   - contact-name-present: 85%
#   - contact-url-present: 85%
#   - contact-url-https: 100%
#   - contact-email-present: 100%
#   - license-name-present: 100%
#   - license-url-present: 85%
#   - license-url-https: 100%
#   - server-url-present: 100%
#   - server-description-min-length: 100%
#   - tag-name-present: 100%
#   - operation-tags-present: 100%
#   - operation-summary-present: 100%
#   - operation-summary-min-length: 95%
#   - operation-description-min-length: 96%
#   - operation-operationid-present: 100%
#   - operation-operationid-casing-snake: 84%
#   - operation-parameters-present: 84%
#   - operation-responses-present: 100%
#   - parameter-name-present: 100%
#   - parameter-in-present: 100%
#   - parameter-in-values: 100%
#   - parameter-description-present: 83%
#   - parameter-description-min-length: 95%
#   - parameter-style-values: 100%
#   - parameter-schema-present: 100%
#   - requestbody-content-present: 100%
#   - requestbody-required-present: 87%
#   - mediatype-schema-present: 100%
#   - response-description-present: 100%
#   - schema-type-present: 100%
#   - schema-type-values: 98%
#   - schema-description-min-length: 95%
#   - schema-properties-present: 98%
#   - securityscheme-type-present: 100%
#   - securityscheme-type-values: 100%
#   - securityscheme-in-values: 100%
#   - securityscheme-scheme-values: 100%
#   - oauthflow-tokenurl-present: 100%
#   - oauthflow-scopes-present: 100%
x-method: generated
x-generator: derive-rules.py
x-generated: '2026-11-01'
x-source:
- openapi/red-hat-ansible-automation-platform-aap-gateway-api-api-openapi.yml
- openapi/red-hat-ansible-automation-platform-access-policies-api-openapi.yml
- openapi/red-hat-ansible-automation-platform-acs-file-api-openapi.yml
- openapi/red-hat-ansible-automation-platform-activation-instances-api-openapi.yml
- openapi/red-hat-ansible-automation-platform-activations-api-openapi.yml
x-self-check:
  status: checked
  rules: 59
  dropped: {}
extends:
- - spectral:oas
  - recommended
formats:
- oas3
rules:
  operation-has-operationid:
    description: 'Every operation declares an operationId (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy
    x-pattern-key: Operation.operationId|present
  operationid-casing-snake:
    description: 'operationIds are snake case (measured: 83% of this contract)'
    severity: info
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z0-9]+(_[a-z0-9]+)*$
    x-pattern-key: Operation.operationId|pattern:^[a-z0-9]+(_[a-z0-9]+)*$
  operation-has-summary:
    description: 'Every operation has a summary (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: summary
      function: truthy
    x-pattern-key: Operation.summary|present
  operation-has-tags:
    description: 'Every operation is tagged (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: truthy
    x-pattern-key: Operation.tags|present
  operation-has-success-response:
    description: 'Every operation declares a 2xx response (measured: 99% of this contract)'
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          patternProperties:
            ^2\d\d$: {}
          minProperties: 1
    x-pattern-key: Operation.responses|schema:07e20b47
  path-segment-casing-kebab:
    description: 'Path segments are kebab case (measured: 87% of this contract)'
    severity: info
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        match: ^(/[a-z0-9]+(-[a-z0-9]+)*|/\{[^}]+\})+/?$
    x-pattern-key: Paths.{key}|pattern:^(/[a-z0-9]+(-[a-z0-9]+)*|/\{[^}]+\})+/?$
  path-params-in-braces:
    description: 'Path parameters use {braces}, not :colon (measured: 100% of this contract)'
    severity: error
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        notMatch: ':'
    x-pattern-key: 'Paths.{key}|pattern:!:'
  write-declares-request-body:
    description: 'POST and PUT declare a request body (measured: 86% of this contract)'
    severity: info
    given: $.paths[*][post,put]
    then:
      field: requestBody
      function: truthy
    x-pattern-key: Operation.requestBody|present
  response-media-type:
    description: 'Responses are served as application/json (measured: 99% of this contract)'
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].responses[*].content
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          required:
          - application/json
    x-pattern-key: Response.content|schema:2919cf38
  property-name-casing-snake:
    description: 'Schema property names are snake case (measured: 94% of this contract)'
    severity: warn
    given: $.components.schemas[*].properties[*]~
    then:
      function: pattern
      functionOptions:
        match: ^[a-z0-9]+(_[a-z0-9]+)*$
    x-pattern-key: Schema.properties{key}|pattern:^[a-z0-9]+(_[a-z0-9]+)*$
  info-has-description:
    description: 'The contract''s info block carries a description (measured: 97% of this contract)'
    severity: warn
    given: $.info
    then:
      field: description
      function: truthy
    x-pattern-key: Info.description|present
  info-has-contact-or-terms:
    description: 'The contract''s info block names a contact or terms of service (measured: 82% of this contract)'
    severity: info
    given: $.info
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
          - required:
            - contact
          - required:
            - termsOfService
    x-pattern-key: OpenAPI.info|schema:093268bf
  info-title-present:
    description: 'Info declares title (measured: 100% of this contract)'
    severity: error
    given: $.info
    then:
      field: title
      function: defined
    x-pattern-key: Info.title|present
  info-title-min-length:
    description: 'Info.title runs at least 19 characters (measured: 95% of this contract)'
    severity: warn
    given: $.info.title
    then:
      function: length
      functionOptions:
        min: 19
    x-pattern-key: Info.title|length
  info-description-present:
    description: 'Info declares description (measured: 97% of this contract)'
    severity: warn
    given: $.info
    then:
      field: description
      function: defined
    x-pattern-key: Info.description|present
  info-description-min-length:
    description: 'Info.description runs at least 15 characters (measured: 100% of this contract)'
    severity: error
    given: $.info.description
    then:
      function: length
      functionOptions:
        min: 15
    x-pattern-key: Info.description|length
  info-contact-present:
    description: 'Info declares contact (measured: 82% of this contract)'
    severity: info
    given: $.info
    then:
      field: contact
      function: defined
    x-pattern-key: Info.contact|present
  info-license-present:
    description: 'Info declares license (measured: 82% of this contract)'
    severity: info
    given: $.info
    then:
      field: license
      function: defined
    x-pattern-key: Info.license|present
  info-version-present:
    description: 'Info declares version (measured: 100% of this contract)'
    severity: error
    given: $.info
    then:
      field: version
      function: defined
    x-pattern-key: Info.version|present
  info-version-semver:
    description: 'info.version is numeric (measured: 100% of this contract)'
    severity: error
    given: $.info.version
    then:
      function: pattern
      functionOptions:
        match: ^v?\d+(\.\d+)*
    x-pattern-key: Info.version|pattern:^v?\d+(\.\d+)*
  contact-name-present:
    description: 'Contact declares name (measured: 85% of this contract)'
    severity: info
    given: $.info.contact
    then:
      field: name
      function: defined
    x-pattern-key: Contact.name|present
  contact-url-present:
    description: 'Contact declares url (measured: 85% of this contract)'
    severity: info
    given: $.info.contact
    then:
      field: url
      function: defined
    x-pattern-key: Contact.url|present
  contact-url-https:
    description: 'Contact.url is https (measured: 100% of this contract)'
    severity: error
    given: $.info.contact.url
    then:
      function: pattern
      functionOptions:
        match: ^https://
    x-pattern-key: Contact.url|pattern:^https://
  contact-email-present:
    description: 'Contact declares email (measured: 100% of this contract)'
    severity: error
    given: $.info.contact
    then:
      field: email
      function: defined
    x-pattern-key: Contact.email|present
  license-name-present:
    description: 'License declares name (measured: 100% of this contract)'
    severity: error
    given: $.info.license
    then:
      field: name
      function: defined
    x-pattern-key: License.name|present
  license-url-present:
    description: 'License declares url (measured: 85% of this contract)'
    severity: info
    given: $.info.license
    then:
      field: url
      function: defined
    x-pattern-key: License.url|present
  license-url-https:
    description: 'License.url is https (measured: 100% of this contract)'
    severity: error
    given: $.info.license.url
    then:
      function: pattern
      functionOptions:
        match: ^https://
    x-pattern-key: License.url|pattern:^https://
  server-url-present:
    description: 'Server declares url (measured: 100% of this contract)'
    severity: error
    given: $.servers[*]
    then:
      field: url
      function: defined
    x-pattern-key: Server.url|present
  server-description-min-length:
    description: 'Server.description runs at least 38 characters (measured: 100% of this contract)'
    severity: error
    given: $.servers[*].description
    then:
      function: length
      functionOptions:
        min: 38
    x-pattern-key: Server.description|length
  tag-name-present:
    description: 'Tag declares name (measured: 100% of this contract)'
    severity: error
    given: $.tags[*]
    then:
      field: name
      function: defined
    x-pattern-key: Tag.name|present
  operation-tags-present:
    description: 'Operation declares tags (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: tags
      function: defined
    x-pattern-key: Operation.tags|present
  operation-summary-present:
    description: 'Operation declares summary (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: summary
      function: defined
    x-pattern-key: Operation.summary|present
  operation-summary-min-length:
    description: 'Operation.summary runs at least 11 characters (measured: 95% of this contract)'
    severity: warn
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].summary
    then:
      function: length
      functionOptions:
        min: 11
    x-pattern-key: Operation.summary|length
  operation-description-min-length:
    description: 'Operation.description runs at least 19 characters (measured: 96% of this contract)'
    severity: warn
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].description
    then:
      function: length
      functionOptions:
        min: 19
    x-pattern-key: Operation.description|length
  operation-operationid-present:
    description: 'Operation declares operationId (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: operationId
      function: defined
    x-pattern-key: Operation.operationId|present
  operation-operationid-casing-snake:
    description: 'Operation.operationId is snake case (measured: 83% of this contract)'
    severity: info
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z0-9]+(_[a-z0-9]+)*$
    x-pattern-key: Operation.operationId|pattern:^[a-z0-9]+(_[a-z0-9]+)*$
  operation-parameters-present:
    description: 'Operation declares parameters (measured: 83% of this contract)'
    severity: info
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: parameters
      function: defined
    x-pattern-key: Operation.parameters|present
  operation-responses-present:
    description: 'Operation declares responses (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: responses
      function: defined
    x-pattern-key: Operation.responses|present
  parameter-name-present:
    description: 'Parameter declares name (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
    then:
      field: name
      function: defined
    x-pattern-key: Parameter.name|present
  parameter-in-present:
    description: 'Parameter declares in (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
    then:
      field: in
      function: defined
    x-pattern-key: Parameter.in|present
  parameter-in-values:
    description: 'Parameter.in is one of path, query (measured: 99% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].in
    then:
      function: enumeration
      functionOptions:
        values:
        - path
        - query
    x-pattern-key: Parameter.in|enum:path,query
  parameter-description-present:
    description: 'Parameter declares description (measured: 82% of this contract)'
    severity: info
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
    then:
      field: description
      function: defined
    x-pattern-key: Parameter.description|present
  parameter-description-min-length:
    description: 'Parameter.description runs at least 17 characters (measured: 95% of this contract)'
    severity: warn
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].description
    then:
      function: length
      functionOptions:
        min: 17
    x-pattern-key: Parameter.description|length
  parameter-style-values:
    description: 'Parameter.style is one of form (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].style
    then:
      function: enumeration
      functionOptions:
        values:
        - form
    x-pattern-key: Parameter.style|enum:form
  parameter-schema-present:
    description: 'Parameter declares schema (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
    then:
      field: schema
      function: defined
    x-pattern-key: Parameter.schema|present
  requestbody-content-present:
    description: 'RequestBody declares content (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
    then:
      field: content
      function: defined
    x-pattern-key: RequestBody.content|present
  requestbody-required-present:
    description: 'RequestBody declares required (measured: 87% of this contract)'
    severity: info
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
    then:
      field: required
      function: defined
    x-pattern-key: RequestBody.required|present
  mediatype-schema-present:
    description: 'MediaType declares schema (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].content[*]
    then:
      field: schema
      function: defined
    x-pattern-key: MediaType.schema|present
  response-description-present:
    description: 'Response declares description (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
    then:
      field: description
      function: defined
    x-pattern-key: Response.description|present
  schema-type-present:
    description: 'Schema declares type (measured: 99% of this contract)'
    severity: error
    given: $.components.schemas[*]
    then:
      field: type
      function: defined
    x-pattern-key: Schema.type|present
  schema-type-values:
    description: 'Schema.type is one of object (measured: 98% of this contract)'
    severity: warn
    given: $.components.schemas[*].type
    then:
      function: enumeration
      functionOptions:
        values:
        - object
    x-pattern-key: Schema.type|enum:object
  schema-description-min-length:
    description: 'Schema.description runs at least 27 characters (measured: 95% of this contract)'
    severity: warn
    given: $.components.schemas[*].description
    then:
      function: length
      functionOptions:
        min: 27
    x-pattern-key: Schema.description|length
  schema-properties-present:
    description: 'Schema declares properties (measured: 97% of this contract)'
    severity: warn
    given: $.components.schemas[*]
    then:
      field: properties
      function: defined
    x-pattern-key: Schema.properties|present
  securityscheme-type-present:
    description: 'SecurityScheme declares type (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*]
    then:
      field: type
      function: defined
    x-pattern-key: SecurityScheme.type|present
  securityscheme-type-values:
    description: 'SecurityScheme.type is one of apiKey, http, oauth2 (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*].type
    then:
      function: enumeration
      functionOptions:
        values:
        - apiKey
        - http
        - oauth2
    x-pattern-key: SecurityScheme.type|enum:apiKey,http,oauth2
  securityscheme-in-values:
    description: 'SecurityScheme.in is one of cookie, header (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*].in
    then:
      function: enumeration
      functionOptions:
        values:
        - cookie
        - header
    x-pattern-key: SecurityScheme.in|enum:cookie,header
  securityscheme-scheme-values:
    description: 'SecurityScheme.scheme is one of basic (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*].scheme
    then:
      function: enumeration
      functionOptions:
        values:
        - basic
    x-pattern-key: SecurityScheme.scheme|enum:basic
  oauthflow-tokenurl-present:
    description: 'OAuthFlow declares tokenUrl (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*].flows[*]
    then:
      field: tokenUrl
      function: defined
    x-pattern-key: OAuthFlow.tokenUrl|present
  oauthflow-scopes-present:
    description: 'OAuthFlow declares scopes (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*].flows[*]
    then:
      field: scopes
      function: defined
    x-pattern-key: OAuthFlow.scopes|present

Work with this as data

Every ruleset here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for spectral rules

4 MCP tools reach this
  • find_rulesBrowse and filter every ruleset in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This ruleset 
curl "https://apis.io/api/v1/rules/red-hat-ansible-automation-platform-rules"
All spectral rules 
curl "https://apis.io/api/v1/rules?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.