Manage OpenAPI via GitHub Demo · API Governance Rules

Manage OpenAPI via GitHub Demo API Rules

Spectral linting rules defining API design standards and conventions for Manage OpenAPI via GitHub Demo.

5 Rules error 1 warn 4

View Rules File View on GitHub

Rule Categories

apis

Rules

warn

apis-io-info-contact

API info should include a contact for APIs.io.

$.info

warn

apis-io-base-url

Servers should reference search-api.apis.io.

$.servers[*].url

error

apis-io-external-docs

OpenAPI should declare externalDocs.

warn

apis-io-search-resource

API should expose /search/apis as primary search resource.

$.paths

warn

apis-io-operation-tags

Operations should be tagged Search and APIs.

$.paths[*][*]

Spectral Ruleset

extends:
  - spectral:oas
rules:
  apis-io-info-contact:
    description: API info should include a contact for APIs.io.
    given: $.info
    severity: warn
    then:
      field: contact
      function: truthy
  apis-io-base-url:
    description: Servers should reference search-api.apis.io.
    given: $.servers[*].url
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "search-api\\.apis\\.io"
  apis-io-external-docs:
    description: OpenAPI should declare externalDocs.
    given: $
    severity: error
    then:
      field: externalDocs
      function: truthy
  apis-io-search-resource:
    description: API should expose /search/apis as primary search resource.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "/search/apis"
  apis-io-operation-tags:
    description: Operations should be tagged Search and APIs.
    given: $.paths[*][*]
    severity: warn
    then:
      field: tags
      function: truthy