Ansible Automation Platform · API Governance Rules

Ansible Automation Platform API Rules

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

12 Rules error 5 warn 7
View Rules File View on GitHub

Rule Categories

info no operation operationid response schema security servers

Rules

warn
info-title-prefix
Info title should start with "Ansible"
$.info
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
error
response-success-required
Operations must have success responses
$.paths[*][get,post,put,patch,delete].responses
error
security-global-defined
Global security must be defined
$
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
operationid-casing
Operation IDs should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
warn
schema-properties-casing
Schema properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑ 
# ansible-automation-platform — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
#   - servers-https-only: 100% of servers already https (error)
#   - operationid-casing: camel @ 100% (n=5)
#   - schema-names-casing: pascal @ 100% (n=9)
#   - schema-properties-casing: snake @ 100% (n=34)
#   - security: global (root) — NOT emitting operation-security-required
#   - pagination params observed: ['page', 'page_size']
#   - merge: kept 6 existing, added 6 measured, upgraded 0
#   - added: servers-https-only, operationid-casing, schema-names-casing, schema-properties-casing, security-schemes-defined, no-empty-descriptions
extends:
  - spectral:oas
rules:
  info-title-prefix:
    description: Info title should start with "Ansible"
    given: $.info
    severity: warn
    then:
      field: title
      function: pattern
      functionOptions:
        match: ^Ansible
  operation-operationId-required:
    description: Every operation must have an operationId
    given: $.paths[*][get,post,put,patch,delete]
    severity: error
    then:
      field: operationId
      function: truthy
  operation-summary-required:
    description: Every operation must have a summary
    given: $.paths[*][get,post,put,patch,delete]
    severity: error
    then:
      field: summary
      function: truthy
  operation-tags-required:
    description: Every operation must have tags
    given: $.paths[*][get,post,put,patch,delete]
    severity: warn
    then:
      field: tags
      function: truthy
  response-success-required:
    description: Operations must have success responses
    given: $.paths[*][get,post,put,patch,delete].responses
    severity: error
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
          - required:
            - '200'
          - required:
            - '201'
  security-global-defined:
    description: Global security must be defined
    given: $
    severity: error
    then:
      field: security
      function: truthy
  servers-https-only:
    description: Server URLs must use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  operationid-casing:
    description: Operation IDs should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: casing
      functionOptions:
        type: camel
  schema-names-casing:
    description: Component schema names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: pascal
  schema-properties-casing:
    description: Schema properties should be snake_case (the dominant convention in this API).
    severity: warn
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: snake
  security-schemes-defined:
    description: Security schemes should be defined in components.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy