ClickPost · API Governance Rules

ClickPost API Rules

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

8 Rules error 4 warn 4
View Rules File View on GitHub

Rule Categories

clickpost

Rules

error
clickpost-info-contact
API contact information must be present.
$.info
warn
clickpost-info-license
API license must be declared.
$.info
error
clickpost-server-https
All server URLs must use HTTPS.
$.servers[*].url
error
clickpost-auth-required
A security scheme (apiKey for token authentication) must be declared.
$.components.securitySchemes
error
clickpost-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
clickpost-operation-tags
Every operation must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
clickpost-operation-summary
Every operation must include a short summary.
$.paths[*][get,post,put,patch,delete]
warn
clickpost-error-responses
Mutating operations should declare 4xx error responses.
$.paths[*][post,put,patch,delete].responses

Spectral Ruleset

Raw ↑ 
extends:
  - spectral:oas

# Spectral linting rules for ClickPost APIs.
rules:
  clickpost-info-contact:
    description: API contact information must be present.
    severity: error
    given: "$.info"
    then:
      field: contact
      function: truthy

  clickpost-info-license:
    description: API license must be declared.
    severity: warn
    given: "$.info"
    then:
      field: license
      function: truthy

  clickpost-server-https:
    description: All server URLs must use HTTPS.
    severity: error
    given: "$.servers[*].url"
    then:
      function: pattern
      functionOptions:
        match: "^https://"

  clickpost-auth-required:
    description: A security scheme (apiKey for token authentication) must be declared.
    severity: error
    given: "$.components.securitySchemes"
    then:
      function: truthy

  clickpost-operation-id:
    description: Every operation must declare a unique operationId.
    severity: error
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: operationId
      function: truthy

  clickpost-operation-tags:
    description: Every operation must declare at least one tag.
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: tags
      function: schema
      functionOptions:
        schema:
          type: array
          minItems: 1

  clickpost-operation-summary:
    description: Every operation must include a short summary.
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: summary
      function: truthy

  clickpost-error-responses:
    description: Mutating operations should declare 4xx error responses.
    severity: warn
    given: "$.paths[*][post,put,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
            - required: ["400"]
            - required: ["401"]
            - required: ["403"]
            - required: ["404"]