Convex · API Governance Rules

Convex API Rules

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

5 Rules error 3 warn 2

View Rules File View on GitHub

Rule Categories

convex

Rules

error

convex-deploy-info-title

Deployment Platform API title must reference Convex Deployment Platform

$.info.title

error

convex-deploy-server-defined

At least one server URL must be defined

$.servers

warn

convex-deploy-server-pattern

Deployment Platform API server URLs must match {deployment}.convex.cloud/api/v1

$.servers[*].url

warn

convex-deploy-tag-required

Tags must declare EnvironmentVariables or Configuration scope

$.tags[*].name

error

convex-deploy-operation-id-camelcase

Every operation must define an operationId

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

Spectral Ruleset

extends:
  - "spectral:oas"
documentationUrl: https://docs.convex.dev/deployment-platform-api
rules:
  convex-deploy-info-title:
    description: Deployment Platform API title must reference Convex Deployment Platform
    severity: error
    given: "$.info.title"
    then:
      function: pattern
      functionOptions:
        match: "(?i)Convex\\s+Deployment\\s+Platform"
  convex-deploy-server-defined:
    description: At least one server URL must be defined
    severity: error
    given: "$.servers"
    then:
      function: length
      functionOptions:
        min: 1
  convex-deploy-server-pattern:
    description: Deployment Platform API server URLs must match {deployment}.convex.cloud/api/v1
    severity: warn
    given: "$.servers[*].url"
    then:
      function: pattern
      functionOptions:
        match: "convex\\.cloud/api/v1"
  convex-deploy-tag-required:
    description: Tags must declare EnvironmentVariables or Configuration scope
    severity: warn
    given: "$.tags[*].name"
    then:
      function: enumeration
      functionOptions:
        values:
          - Configuration
          - EnvironmentVariables
          - Deployment
  convex-deploy-operation-id-camelcase:
    description: Every operation must define an operationId
    severity: error
    given: "$.paths.*[get,put,post,delete,patch].operationId"
    then:
      function: pattern
      functionOptions:
        match: "^[a-zA-Z][a-zA-Z0-9_]+$"

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/convex-deployment-platform-api-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.