Octopus Energy · API Governance Rules

Octopus Energy API Rules

Spectral linting rules defining API design standards and conventions for Octopus Energy.

4 Rules error 1 warn 2 info 1

Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's; it was most likely written by an API Evangelist pass before outputs were stamped.

View Rules File View on GitHub

Rule Categories

octopus

Rules

warn

octopus-trailing-slash-path

Octopus Energy Public API paths end with a trailing slash.

$.paths.*~

warn

octopus-title-case-summaries

Operation summaries use Title Case.

$.paths.*.*.summary

error

octopus-https-only-server

Server URLs must be HTTPS.

$.servers.*.url

info

octopus-basic-auth-security

Basic auth is the documented authentication scheme.

$.components.securitySchemes.basicAuth.scheme

Spectral Ruleset

extends: ["spectral:oas"]
rules:
  octopus-trailing-slash-path:
    description: Octopus Energy Public API paths end with a trailing slash.
    message: "Path '{{value}}' should end with a trailing slash to match Octopus Energy conventions."
    severity: warn
    given: "$.paths.*~"
    then:
      function: pattern
      functionOptions:
        match: "/$"
  octopus-title-case-summaries:
    description: Operation summaries use Title Case.
    message: "{{property}} should be in Title Case."
    severity: warn
    given: "$.paths.*.*.summary"
    then:
      function: pattern
      functionOptions:
        match: "^([A-Z][a-z0-9]*(\\s|$))+"
  octopus-https-only-server:
    description: Server URLs must be HTTPS.
    message: "Server URL '{{value}}' must use https."
    severity: error
    given: "$.servers.*.url"
    then:
      function: pattern
      functionOptions:
        match: "^https://"
  octopus-basic-auth-security:
    description: Basic auth is the documented authentication scheme.
    severity: info
    given: "$.components.securitySchemes.basicAuth.scheme"
    then:
      function: pattern
      functionOptions:
        match: "^basic$"

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/octopus-energy-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.