Zipkin · API Governance Rules

Zipkin — spectral rules

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

6 Rules error 2 warn 4

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

zipkin

Rules

warn

zipkin-summary-prefix

All operation summaries must start with "Zipkin"

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

error

zipkin-operation-id

Every operation must have an operationId

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

warn

zipkin-operation-tags

Every operation must have at least one tag

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

warn

zipkin-operation-description

Every operation must have a description

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

warn

zipkin-trace-id-pattern

traceId fields must use the hex pattern

$.components.schemas.Span.properties.traceId.pattern

error

zipkin-server-url

Servers must be defined

$.servers

Spectral Ruleset

extends:
  - spectral:oas
rules:
  zipkin-summary-prefix:
    description: All operation summaries must start with "Zipkin"
    message: "Operation summary should start with 'Zipkin' provider prefix"
    severity: warn
    given: "$.paths.*[get,post,put,delete,patch].summary"
    then:
      function: pattern
      functionOptions:
        match: "^Zipkin "
  zipkin-operation-id:
    description: Every operation must have an operationId
    message: "Operation must define an operationId"
    severity: error
    given: "$.paths.*[get,post,put,delete,patch]"
    then:
      field: operationId
      function: truthy
  zipkin-operation-tags:
    description: Every operation must have at least one tag
    message: "Operation must have a tag"
    severity: warn
    given: "$.paths.*[get,post,put,delete,patch]"
    then:
      field: tags
      function: truthy
  zipkin-operation-description:
    description: Every operation must have a description
    severity: warn
    given: "$.paths.*[get,post,put,delete,patch]"
    then:
      field: description
      function: truthy
  zipkin-trace-id-pattern:
    description: traceId fields must use the hex pattern
    severity: warn
    given: "$.components.schemas.Span.properties.traceId.pattern"
    then:
      function: truthy
  zipkin-server-url:
    description: Servers must be defined
    severity: error
    given: "$.servers"
    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/zipkin-spectral"

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.