Academy Software Foundation · API Governance Rules

Academy Software Foundation API Rules

Spectral linting rules defining API design standards and conventions for Academy Software Foundation.

21 Rules error 14 warn 5 info 2
View Rules File View on GitHub

Rule Categories

delete get info no openapi operation parameter paths response schema servers

Rules

error
info-title-required
Info title must be present and start with "Academy Software Foundation"
$.info
error
info-description-required
Info description must be present and be descriptive
$.info
error
info-version-required
Info version must be present
$.info
error
openapi-version-3
Must use OpenAPI 3.0.x
$
error
servers-required
At least one server must be defined
$
warn
servers-description-required
Servers should have descriptions
$.servers[*]
warn
paths-kebab-case
Path segments should use kebab-case or snake_case
$.paths
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries should start with the provider name
$.paths[*][get,post,put,patch,delete]
error
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
error
parameter-description-required
Path and query parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
info
parameter-example-recommended
Parameters should have example values
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must have a 2xx success response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-description-recommended
Component schemas should have descriptions
$.components.schemas[*]
info
schema-property-description-recommended
Schema properties should have descriptions
$.components.schemas[*].properties[*]
error
get-no-request-body
GET operations must not have request bodies
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have request bodies
$.paths[*].delete
error
no-empty-descriptions
Descriptions must not be empty
$..description

Spectral Ruleset

Raw ↑ 
rules:

  # INFO / METADATA
  info-title-required:
    description: Info title must be present and start with "Academy Software Foundation"
    severity: error
    given: '$.info'
    then:
      field: title
      function: pattern
      functionOptions:
        match: '^Academy Software Foundation'

  info-description-required:
    description: Info description must be present and be descriptive
    severity: error
    given: '$.info'
    then:
      field: description
      function: truthy

  info-version-required:
    description: Info version must be present
    severity: error
    given: '$.info'
    then:
      field: version
      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: At least one server must be defined
    severity: error
    given: '$'
    then:
      field: servers
      function: truthy

  servers-description-required:
    description: Servers should have descriptions
    severity: warn
    given: '$.servers[*]'
    then:
      field: description
      function: truthy

  # PATHS
  paths-kebab-case:
    description: Path segments should use kebab-case or snake_case
    severity: warn
    given: '$.paths'
    then:
      field: '@key'
      function: pattern
      functionOptions:
        match: '^(\/[a-z0-9_\-\{\}]*)*$'

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

  operation-summary-prefix:
    description: Operation summaries should start with the provider name
    severity: warn
    given: '$.paths[*][get,post,put,patch,delete]'
    then:
      field: summary
      function: pattern
      functionOptions:
        match: '^Academy Software Foundation'

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

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

  operation-tags-required:
    description: Every operation must have at least one tag
    severity: error
    given: '$.paths[*][get,post,put,patch,delete]'
    then:
      field: tags
      function: truthy

  # PARAMETERS
  parameter-description-required:
    description: Path and query parameters must have descriptions
    severity: error
    given: '$.paths[*][get,post,put,patch,delete].parameters[*]'
    then:
      field: description
      function: truthy

  parameter-example-recommended:
    description: Parameters should have example values
    severity: info
    given: '$.paths[*][get,post,put,patch,delete].parameters[*]'
    then:
      field: example
      function: truthy

  # RESPONSES
  response-success-required:
    description: Every operation must have a 2xx success response
    severity: error
    given: '$.paths[*][get,post,put,patch,delete].responses'
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
            - required: ['200']
            - required: ['201']
            - required: ['204']

  response-description-required:
    description: Every response must have a description
    severity: error
    given: '$.paths[*][get,post,put,patch,delete].responses[*]'
    then:
      field: description
      function: truthy

  # SCHEMAS
  schema-description-recommended:
    description: Component schemas should have descriptions
    severity: warn
    given: '$.components.schemas[*]'
    then:
      field: description
      function: truthy

  schema-property-description-recommended:
    description: Schema properties should have descriptions
    severity: info
    given: '$.components.schemas[*].properties[*]'
    then:
      field: description
      function: truthy

  # HTTP CONVENTIONS
  get-no-request-body:
    description: GET operations must not have request bodies
    severity: error
    given: '$.paths[*].get'
    then:
      field: requestBody
      function: falsy

  delete-no-request-body:
    description: DELETE operations should not have request bodies
    severity: warn
    given: '$.paths[*].delete'
    then:
      field: requestBody
      function: falsy

  # GENERAL QUALITY
  no-empty-descriptions:
    description: Descriptions must not be empty
    severity: error
    given: '$..description'
    then:
      function: pattern
      functionOptions:
        match: '.+'