Ansible Automation Platform · API Governance Rules

Ansible Automation Platform API Rules

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

6 Rules error 4 warn 2
View Rules File View on GitHub

Rule Categories

info operation response security

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
$

Spectral Ruleset

ansible-automation-platform-spectral-rules.yml Raw ↑ 
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