Cycloid · API Governance Rules

Cycloid API Rules

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

6 Rules error 3 warn 3

View Rules File View on GitHub

Rule Categories

cycloid

Rules

warn

cycloid-info-contact

Cycloid API spec must declare a contact.

$.info

error

cycloid-server-https

Cycloid server URLs must use HTTPS.

$.servers[*].url

error

cycloid-base-url

Cycloid base URL must be http-api.cycloid.io.

$.servers[*].url

warn

cycloid-tags-required

Every operation must declare at least one tag.

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

error

cycloid-operation-id-required

Every operation must declare an operationId.

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

warn

cycloid-organization-scoped

Resource paths must be scoped under /organizations/{organization_canonical}.

$.paths

Spectral Ruleset

extends: spectral:oas
rules:
  cycloid-info-contact:
    description: Cycloid API spec must declare a contact.
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  cycloid-server-https:
    description: Cycloid server URLs must use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: '^https://'
  cycloid-base-url:
    description: Cycloid base URL must be http-api.cycloid.io.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: '^https://http-api\.cycloid\.io'
  cycloid-tags-required:
    description: Every operation must declare at least one tag.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: truthy
  cycloid-operation-id-required:
    description: Every operation must declare an operationId.
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy
  cycloid-organization-scoped:
    description: Resource paths must be scoped under /organizations/{organization_canonical}.
    severity: warn
    given: $.paths
    then:
      function: pattern
      functionOptions:
        match: 'organizations/\{organization_canonical\}'

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/cycloid-api-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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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