Buildpacks Io · API Governance Rules

Buildpacks Io API Rules

Spectral linting rules defining API design standards and conventions for Buildpacks Io.

8 Rules error 3 warn 4 info 1
View Rules File View on GitHub

Rule Categories

buildpacks

Rules

error
buildpacks-info-license-required
Info object must declare a license (CNB ships Apache-2.0).
$.info
warn
buildpacks-info-contact-required
Info object must declare contact details pointing to buildpacks.io.
$.info
warn
buildpacks-operation-summary-title-case
Operation summaries must use Title Case.
$.paths[*][*].summary
warn
buildpacks-operation-id-camel-case
operationId must be camelCase.
$.paths[*][*].operationId
error
buildpacks-operation-tags-required
Every operation must declare at least one tag.
$.paths[*][*]
warn
buildpacks-operation-description-required
Every operation must include a description.
$.paths[*][*]
error
buildpacks-version-string-required
API version must be a non-empty string (semver or date-tagged).
$.info.version
info
buildpacks-namespace-path-param
Buildpack paths should include a {namespace} path parameter.
$.paths

Spectral Ruleset

Raw ↑
extends: spectral:oas
rules:
  buildpacks-info-license-required:
    description: Info object must declare a license (CNB ships Apache-2.0).
    severity: error
    given: "$.info"
    then:
      field: license
      function: truthy

  buildpacks-info-contact-required:
    description: Info object must declare contact details pointing to buildpacks.io.
    severity: warn
    given: "$.info"
    then:
      field: contact
      function: truthy

  buildpacks-operation-summary-title-case:
    description: Operation summaries must use Title Case.
    severity: warn
    given: "$.paths[*][*].summary"
    then:
      function: pattern
      functionOptions:
        match: "^([A-Z][a-z0-9]*(\\s[A-Z][a-z0-9]*)*)"

  buildpacks-operation-id-camel-case:
    description: operationId must be camelCase.
    severity: warn
    given: "$.paths[*][*].operationId"
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-zA-Z0-9]*$"

  buildpacks-operation-tags-required:
    description: Every operation must declare at least one tag.
    severity: error
    given: "$.paths[*][*]"
    then:
      field: tags
      function: truthy

  buildpacks-operation-description-required:
    description: Every operation must include a description.
    severity: warn
    given: "$.paths[*][*]"
    then:
      field: description
      function: truthy

  buildpacks-version-string-required:
    description: API version must be a non-empty string (semver or date-tagged).
    severity: error
    given: "$.info.version"
    then:
      function: truthy

  buildpacks-namespace-path-param:
    description: Buildpack paths should include a {namespace} path parameter.
    severity: info
    given: "$.paths"
    then:
      function: pattern
      functionOptions:
        match: "/buildpacks/\\{namespace\\}/\\{name\\}"

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/buildpacks-io-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.

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