Auth0 · API Governance Rules

Auth0 API Rules

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

3 Rules warn 3

View Rules File View on GitHub

Rule Categories

auth0

Rules

warn

auth0-authentication-summary-title-case

Summaries must use Title Case.

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

warn

auth0-authentication-tags-required

Authentication API operations should be tagged by flow (OAuth, OIDC, SAML, etc).

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

warn

auth0-no-trailing-slash

Paths must not end with a trailing slash.

$.paths

Spectral Ruleset

extends:
  - spectral:oas
rules:
  auth0-authentication-summary-title-case:
    description: Summaries must use Title Case.
    given: $.paths.*[get,post,put,patch,delete].summary
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "^[A-Z]"
  auth0-authentication-tags-required:
    description: Authentication API operations should be tagged by flow (OAuth, OIDC, SAML, etc).
    given: $.paths.*[get,post,put,patch,delete]
    severity: warn
    then:
      field: tags
      function: truthy
  auth0-no-trailing-slash:
    description: Paths must not end with a trailing slash.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        notMatch: "/$"