Lob · API Governance Rules

Lob — lob openapi rules

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

4 Rules error 2 warn 2
Published by Lob Served by the provider at https://github.com/lob/lob-openapi/blob/3d9baefb710ae474cae38d6d5b3a28bea5859944/.spectral.yml; the copy below was fetched from there.
View Rules File View on GitHub

Rule Categories

must oas3 path

Rules

error
path-item-must-be-ref
Path Item Object value must be a $ref
$.paths.*
error
path-item-ref-must-be-file
Path Item must $ref to a file under resources//
$.paths.*.$ref
warn
must-use-intl
Use Intl rather than Int'l
$..*
warn
oas3-valid-media-example
This format violates OpenAPI 3.1 rules
$

Spectral Ruleset

Raw ↑
# harvested from https://github.com/lob/lob-openapi/blob/3d9baefb710ae474cae38d6d5b3a28bea5859944/.spectral.yml on 2026-10-09 — a Spectral ruleset published in the provider's own GitHub repository (lob/lob-openapi); found by GitHub code search, fetched verbatim
x-method: harvested
x-stamped: 2026-10-09
x-source-url: https://github.com/lob/lob-openapi/blob/3d9baefb710ae474cae38d6d5b3a28bea5859944/.spectral.yml
extends: [[spectral:oas, all]]
rules:
  path-item-must-be-ref:
    description: Path Item Object value must be a $ref
    message: "{{description}}; {{property}} incorrect"
    severity: error
    resolved: false
    given: $.paths.*
    then:
      - field: $ref
        function: truthy

  path-item-ref-must-be-file:
    description: Path Item must $ref to a file under resources/<resource_name>/
    message: "{{description}}; {{value}} incorrect"
    severity: error
    resolved: false
    given: $.paths.*.$ref
    then:
      function: pattern
      functionOptions:
        match: "^resources\/[a-zA-Z-_]+\/"

  must-use-intl:
    description: "Use Intl rather than Int'l"
    message: "{{description}}"
    severity: warn
    given: $..*
    then:
      function: pattern
      functionOptions:
        notMatch: "int'l|Int'l"

  oas3-valid-media-example:
    description: "This format violates OpenAPI 3.1 rules"
    message: "{{description}}"
    severity: warn
    given: "$"
    then:
      field: example
      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/lob-lob-openapi-spectral-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.