Auth0 · API Governance Rules

Auth0 API Rules

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

2 Rules warn 1 info 1
View Rules File View on GitHub

Rule Categories

fga

Rules

warn
fga-summary-title-case
OpenFGA summaries must use Title Case.
$.paths.*[get,post,put,patch,delete].summary
info
fga-store-scoped-paths
Most paths should be scoped to a store via /stores/{store_id}.
$.paths

Spectral Ruleset

Raw ↑ 
extends:
  - spectral:oas
rules:
  fga-summary-title-case:
    description: OpenFGA summaries must use Title Case.
    given: $.paths.*[get,post,put,patch,delete].summary
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "^[A-Z]"
  fga-store-scoped-paths:
    description: Most paths should be scoped to a store via /stores/{store_id}.
    given: $.paths
    severity: info
    then:
      function: pattern
      functionOptions:
        match: "stores/\\{store_id\\}|/stores$|/stores/\\{"