ThingSpeak · API Governance Rules

ThingSpeak API Rules

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

5 Rules error 1 warn 3 info 1
View Rules File View on GitHub

Rule Categories

thingspeak

Rules

warn
thingspeak-operation-summary-required
Every operation MUST have a summary in Title Case.
$.paths[*][get,post,put,delete,patch]
warn
thingspeak-operation-id-required
Every operation MUST have an operationId.
$.paths[*][get,post,put,delete,patch]
info
thingspeak-info-contact
The info block SHOULD reference MathWorks documentation.
$.info
error
thingspeak-server-https
Servers MUST use HTTPS for REST endpoints.
$.servers[*].url
warn
thingspeak-channel-id-integer
channel_id path parameters MUST be typed as integer.
$.paths[?(@property.match(/{channel_id}/))][*].parameters[?(@.name == 'channel_id')].schema

Spectral Ruleset

Raw ↑ 
extends:
  - spectral:oas
rules:
  thingspeak-operation-summary-required:
    description: Every operation MUST have a summary in Title Case.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: summary
      function: truthy
  thingspeak-operation-id-required:
    description: Every operation MUST have an operationId.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: operationId
      function: truthy
  thingspeak-info-contact:
    description: The info block SHOULD reference MathWorks documentation.
    severity: info
    given: $.info
    then:
      field: contact
      function: truthy
  thingspeak-server-https:
    description: Servers MUST use HTTPS for REST endpoints.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: '^https://'
  thingspeak-channel-id-integer:
    description: channel_id path parameters MUST be typed as integer.
    severity: warn
    given: $.paths[?(@property.match(/{channel_id}/))][*].parameters[?(@.name == 'channel_id')].schema
    then:
      field: type
      function: enumeration
      functionOptions:
        values:
          - integer

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/thingspeak-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.