Matrix · API Governance Rules

Matrix API Rules

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

5 Rules error 1 warn 4
View Rules File View on GitHub

Rule Categories

no payload security server

Rules

error
server-secure-protocol
Servers should use a secure protocol (this API's convention).
$.servers[*].protocol
warn
server-security-defined
Servers should declare their security requirements.
$.servers[*]
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
payload-property-casing
Message payload properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑
# authorship: generated by API Evangelist tooling. Stamped 2026-08-18
# on the file's own generator header (roadmap#64). An unmarked file is
# NOT assumed to be ours -- absence of evidence was never stamped.
x-method: generated
# matrix — AsyncAPI Spectral ruleset (strengthened)
# Plain Spectral. Rules measured from this provider's own AsyncAPI event
# conventions by strengthen_asyncapi.py, then self-validated against the spec.
#
# Provenance:
#   - server-secure-protocol: 100% of servers already secure
#   - server-security-defined: 1/1 servers
#   - security-schemes: ['accessTokenQuery', 'bearerAuth']
#   - payload-property-casing: snake @ 97% (n=91)
extends:
  - spectral:asyncapi
rules:
  server-secure-protocol:
    description: Servers should use a secure protocol (this API's convention).
    severity: error
    given: $.servers[*].protocol
    then:
      function: pattern
      functionOptions:
        match: ^(amqps|https|ibmmq|jms|kafka-secure|mqtts|secure-mqtt|stomps|wss)$
  server-security-defined:
    description: Servers should declare their security requirements.
    severity: warn
    given: $.servers[*]
    then:
      field: security
      function: truthy
  security-schemes-defined:
    description: Security schemes should be defined in components.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  payload-property-casing:
    description: Message payload properties should be snake_case (the dominant convention in this API).
    severity: warn
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: snake
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy

Work with this as data

Every ruleset here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for spectral rules

4 MCP tools reach this
  • find_rulesBrowse and filter every ruleset in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This ruleset
curl "https://apis.io/api/v1/rules/matrix-asyncapi-spectral-rules"
All spectral rules
curl "https://apis.io/api/v1/rules?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.