DBOS · API Governance Rules

DBOS API Rules

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

5 Rules error 2 warn 3

View Rules File View on GitHub

Rule Categories

dbos

Rules

warn

dbos-workflow-decorator-named

Workflow decorators should always carry an explicit name.

$.components.schemas.Workflow.properties.name

warn

dbos-step-retry-bounds

Step retries must have max_attempts and backoff_rate.

$.components.schemas.Step

error

dbos-transaction-isolation-enum

Transaction isolation level must be SERIALIZABLE, REPEATABLE READ, or READ COMMITTED.

$.components.schemas.Transaction.properties.isolation_level

error

dbos-scheduled-cron

Scheduled workflows must define a cron expression.

$.components.schemas.Scheduled.properties.cron

warn

dbos-info-contact

API info should include a contact for the DBOS project.

$.info

Spectral Ruleset

extends:
  - spectral:oas
rules:
  dbos-workflow-decorator-named:
    description: Workflow decorators should always carry an explicit name.
    given: $.components.schemas.Workflow.properties.name
    severity: warn
    then:
      function: truthy
  dbos-step-retry-bounds:
    description: Step retries must have max_attempts and backoff_rate.
    given: $.components.schemas.Step
    severity: warn
    then:
      field: properties
      function: truthy
  dbos-transaction-isolation-enum:
    description: Transaction isolation level must be SERIALIZABLE, REPEATABLE READ, or READ COMMITTED.
    given: $.components.schemas.Transaction.properties.isolation_level
    severity: error
    then:
      field: enum
      function: truthy
  dbos-scheduled-cron:
    description: Scheduled workflows must define a cron expression.
    given: $.components.schemas.Scheduled.properties.cron
    severity: error
    then:
      function: truthy
  dbos-info-contact:
    description: API info should include a contact for the DBOS project.
    given: $.info
    severity: warn
    then:
      field: contact
      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/dbos-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.