experience-governance.html

Policy, ownership, and lifecycle signals that keep an API portfolio accountable.

131 rules experience: governance 127 inlined · 4 from the engine

Run this ruleset

Lint any matching artifact against this ruleset with the Spotlight CLI:

npm i -g @spotlight-rules/spotlight-cli
spotlight lint api.yaml \
  --ruleset https://apicommons.org/assets/rulesets/experience-governance.spotlight.yaml

Or load it into the browser validator, post it to the HTTP API, or wire it into a CI gate. 4 of these rules are the engine's built-ins (they come with spotlight:*); the other 127 are inlined in the file below.

Ruleset definition

Loading…

Rules in this ruleset (131)

Skill Allowed Tools Array Agent Skill

Skill License Agent Skill

Skill Name Agent Skill

Skill Require Allowed Tools Agent Skill

Skill Require Metadata Agent Skill

Skill Require Version Agent Skill

API Property Require Linting Rules APIs.json

API Property Require Road Map APIs.json

API Property Require Team APIs.json

API Property Require Terms Of Service APIs.json

API Property Require Vocabulary APIs.json

API Require Aid APIs.json

Document Include Business Impact Canvas APIs.json

Document Include Business Model Canvas APIs.json

Document Include Capacity Canvas APIs.json

Document Include Customer Journey Canvas APIs.json

Document Include Domain Canvas APIs.json

Document Include Event Canvas APIs.json

Document Include Locations Canvas APIs.json

Document Include Rest Canvas APIs.json

Document Include Value Proposition Canvas APIs.json

Document Require Access APIs.json

Document Require Aid APIs.json

Document Require APIs APIs.json

Document Require Common APIs.json

Document Require Created APIs.json

Document Require Description APIs.json

Document Require Image APIs.json

Document Require Include APIs.json

Document Require Kind APIs.json

Document Require Maintainer APIs.json

Document Require Modified APIs.json

Document Require Name APIs.json

Document Require Network APIs.json

Document Require Overlays APIs.json

Document Require Position APIs.json

Document Require Prompts APIs.json

Document Require Rating APIs.json

Document Require Rules APIs.json

Document Require Specificationversion APIs.json

Document Require Tag APIs.json

Document Require Type APIs.json

Document Require URL APIs.json

Document Require Visibility APIs.json

Document Require Workflow APIs.json

Schema Include API Lifecycle APIs.json

Schema Include Business Validator APIs.json

Schema Include Deprecation Policy APIs.json

Schema Include Gateway Reference APIs.json

Schema Include Github Action APIs.json

Schema Include Governance Policies APIs.json

Schema Include Interface License APIs.json

Schema Include Openapi Governance Rules APIs.json

Schema Include Openapi Validator APIs.json

Schema Include Operational Rules APIs.json

Schema Include Privacy Policy APIs.json

Document Require Arazzo Arazzo

Document Require Component Arazzo

Document Require Info Arazzo

Document Require Sourcedescriptions Arazzo

Document Require Workflow Arazzo

Asyncapi Info License AsyncAPI engine

Asyncapi Info License URL AsyncAPI engine

Document Require Asyncapi AsyncAPI

Document Require Channel AsyncAPI

Document Require Component AsyncAPI

Document Require Defaultcontenttype AsyncAPI

Document Require ID AsyncAPI

Document Require Info AsyncAPI

Document Require Operation AsyncAPI

Document Require Server AsyncAPI

Cost FinOps Require Monthly FinOps

Cost FinOps Require Service FinOps

Document FinOps Require Budget FinOps

Document FinOps Require Cost FinOps

Document FinOps Require Currency FinOps

Document FinOps Require Description FinOps

Document FinOps Require Name FinOps

Document FinOps Require Period FinOps

Agentic Access Acting Declares Escalation OpenAPI

Component Require Security Schemes OpenAPI

Document OWASP API9 Server OpenAPI

Document Require Component Section OpenAPI

Document Require Jsonschemadialect OpenAPI

Document Require Openapi OpenAPI

Document Require Path OpenAPI

Document Require Webhooks OpenAPI

Document Spec Must Not Be Empty OpenAPI

Info License OpenAPI engine

Info License Require Name OpenAPI

Info License Require URL OpenAPI

Info Microcks Extension Valid OpenAPI

Info OWASP API9 Document Version OpenAPI

Info Require API Identifier OpenAPI

Info Require License OpenAPI

Info Require Openapi Version 3x OpenAPI

Info Require Terms Of Service OpenAPI

License URL OpenAPI engine

Operation Deprecated Require Description OpenAPI

Operation Microcks Extension Valid OpenAPI

Operation Ref Resource File OpenAPI

Operation Require Security OpenAPI

Operation Require Security 2 OpenAPI

Operation Use Ref OpenAPI

Parameter No API Keys In Query OpenAPI

Parameter No Forbidden HTTP Header OpenAPI

Path No Environment Names In OpenAPI

Path Require Tracing Header OpenAPI

Path Require Valid HTTP Verb OpenAPI

Response Deprecated Operation Deprecation Header OpenAPI

Response Deprecated Operation Sunset Header OpenAPI

Response No Operational Header In Spec OpenAPI

Response No Sensitive Data In Header OpenAPI

Schema Require Info Object OpenAPI

Security OAuth Flow Require Scopes OpenAPI

Security Require Root OpenAPI

Security Require Root Scheme OpenAPI

Server On Approved Domain OpenAPI

Server URL Meet Standards OpenAPI

Document Require Currency Plans

Document Require Description Plans

Document Require Name Plans

Document Require Plan Plans

Plan Require Limit Plans

Plan Require Name Plans

Plan Require Price Plans

Document Require Description Rate Limits

Document Require Name Rate Limits

Limit Require Max Rate Limits

Limit Require Scope Rate Limits

Limit Require Window Rate Limits

← All experience rulesets