Ubuntu · API Governance Rules

Ubuntu API Rules

Spectral linting rules defining API design standards and conventions for Ubuntu.

6 Rules error 1 warn 5

View Rules File View on GitHub

Rule Categories

ubuntu

Rules

warn

ubuntu-operation-id-camel-case

Operation IDs must use camelCase.

$.paths[*][get,post,put,patch,delete].operationId

warn

ubuntu-has-tags

All operations must have at least one tag.

$.paths[*][get,post,put,patch,delete]

error

ubuntu-has-operation-id

All operations must have an operationId.

$.paths[*][get,post,put,patch,delete]

warn

ubuntu-has-description

All operations must have a description.

$.paths[*][get,post,put,patch,delete]

warn

ubuntu-summary-title-case

Operation summaries must use Title Case.

$.paths[*][get,post,put,patch,delete].summary

warn

ubuntu-200-response-content

Successful GET responses should define a content schema.

$.paths[*].get.responses.200

Spectral Ruleset

extends: spectral:oas
rules:
  ubuntu-operation-id-camel-case:
    description: Operation IDs must use camelCase.
    message: "Operation ID '{{value}}' must use camelCase."
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].operationId"
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-zA-Z0-9]*$"

  ubuntu-has-tags:
    description: All operations must have at least one tag.
    message: Operation is missing tags.
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: tags
      function: truthy

  ubuntu-has-operation-id:
    description: All operations must have an operationId.
    message: Operation is missing operationId.
    severity: error
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: operationId
      function: truthy

  ubuntu-has-description:
    description: All operations must have a description.
    message: Operation is missing a description.
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: description
      function: truthy

  ubuntu-summary-title-case:
    description: Operation summaries must use Title Case.
    message: "Summary '{{value}}' should use Title Case."
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].summary"
    then:
      function: pattern
      functionOptions:
        match: "^[A-Z][a-zA-Z0-9 ]+$"

  ubuntu-200-response-content:
    description: Successful GET responses should define a content schema.
    message: GET 200 response at '{{path}}' should define content.
    severity: warn
    given: "$.paths[*].get.responses.200"
    then:
      field: content
      function: truthy