experience-discoverability.html

Metadata, indexing, and links that help humans and machines find the API.

131 rules experience: discoverability 112 inlined · 19 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-discoverability.spotlight.yaml

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

Ruleset definition

Download YAML

Loading…

Rules in this ruleset (131)

Skill Description Agent Skill

Skill Description Length Agent Skill

Skill Name Agent Skill

Skill Require Allowed Tools Agent Skill

Skill Require Metadata Agent Skill

Skill Require Version Agent Skill

API Contact Include Email APIs.json

API Contact Include Full Name APIs.json

API Entry Require Tag APIs.json

API Include About Page APIs.json

API Include Contact APIs.json

API Property Require Go SDK APIs.json

API Property Require Java SDK APIs.json

API Property Require Node SDK APIs.json

API Property Require Python SDK APIs.json

API Property Require Road Map APIs.json

API Property Require SDK APIs.json

API Property Require Signup APIs.json

API Property Require Status Page APIs.json

API Property Require Use Cases APIs.json

API Property Require Valid URL APIs.json

API Property Require Video APIs.json

API Require Aid APIs.json

API Require Base URL APIs.json

API Tag Require Upper Case APIs.json

Document APIs JSON URL HTTPS 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 Blog APIs.json

Schema Include Blog Feed APIs.json

Schema Include Developer Portal APIs.json

Schema Include Discussion Forum APIs.json

Schema Include Gateway Reference APIs.json

Schema Include Github Organization APIs.json

Schema Include Github Repository APIs.json

Schema Include Openapi Definition APIs.json

Schema Include Postman Public Workspace APIs.json

Tag APIs JSON Not Empty APIs.json

Tag Require Upper Case APIs.json

Document Require Arazzo Arazzo

Document Require Component Arazzo

Document Require Info Arazzo

Document Require Sourcedescriptions Arazzo

Document Require Workflow Arazzo

Source Arazzo Description Require URL Arazzo

Asyncapi 3 Tag Description AsyncAPI engine

Asyncapi 3 Tags AsyncAPI engine

Asyncapi 3 Tags Alphabetical AsyncAPI engine

Asyncapi 3 Tags Uniqueness AsyncAPI engine

Asyncapi Info Contact AsyncAPI engine

Asyncapi Info Contact Properties AsyncAPI engine

Asyncapi Tag Description AsyncAPI engine

Asyncapi Tags AsyncAPI engine

Asyncapi Tags Alphabetical AsyncAPI engine

Asyncapi Tags Uniqueness 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

Operation Asyncapi Require Tag AsyncAPI

Document JSON LD ID IRI JSON-LD

Document Require Context JSON-LD

Document Require ID JSON-LD

Document Require Type JSON-LD

Document JSON Structure ID URI JSON Structure

Schema JSON Structure URI JSON Structure

Capability MCP Capabilities Not Empty MCP

Capability Require Prompts MCP

Capability Require Resources MCP

Capability Require Tools MCP

Document MCP Description Meaningful MCP

Document Require Capabilities MCP

Document Require Name MCP

Contact Properties OpenAPI engine

Document Require External Docs OpenAPI

Document Require Jsonschemadialect OpenAPI

Document Require Openapi OpenAPI

Document Require Path OpenAPI

Document Require Server Defined OpenAPI

Document Require Webhooks OpenAPI

Info Contact OpenAPI engine

Info Contact Require Email OpenAPI

Info Contact Require Name OpenAPI

Info Contact Require URL OpenAPI

Info Require API Identifier OpenAPI

Info Require Contact 2 OpenAPI

Info Require Summary OpenAPI

Info Require Title OpenAPI

Openapi Tags OpenAPI engine

Openapi Tags Alphabetical OpenAPI engine

Openapi Tags Uniqueness OpenAPI engine

Operation Collection Support Filtering OpenAPI

Operation Collection Support Sorting OpenAPI

Operation Require One Tag OpenAPI

Operation Require Tag OpenAPI

Operation Singular Tag OpenAPI engine

Operation Tag Defined OpenAPI engine

Operation Tags OpenAPI engine

Response Get Link Header OpenAPI

Response Include Hypermedia Links OpenAPI

Response Require Status Health Check Path OpenAPI

Schema Require Tag Object OpenAPI

Tag Description OpenAPI engine

Tag Require At Least One OpenAPI

Tag Require Name OpenAPI

← All experience rulesets

experience-discoverability.html

This Page

Open & Ask

Run this ruleset

Ruleset definition

Rules in this ruleset (131)