Couchbase · API Governance Rules

Couchbase API Rules

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

4 Rules error 3 warn 1

View Rules File View on GitHub

Rule Categories

couchbase

Rules

error

couchbase-sg-info-title

API title must mention Sync Gateway.

$.info.title

warn

couchbase-sg-public-port

Public Sync Gateway servers must reference port 4984.

$.servers[*].url

error

couchbase-sg-operation-id

Every operation must define an operationId.

$.paths.*.*

error

couchbase-sg-operation-tags

Every operation must define at least one tag.

$.paths.*.*

Spectral Ruleset

extends: ["spectral:oas"]
documentationUrl: https://docs.couchbase.com/sync-gateway/current/rest-api.html
rules:
  couchbase-sg-info-title:
    description: API title must mention Sync Gateway.
    given: "$.info.title"
    severity: error
    then:
      function: pattern
      functionOptions:
        match: "Sync Gateway"
  couchbase-sg-public-port:
    description: Public Sync Gateway servers must reference port 4984.
    given: "$.servers[*].url"
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "4984"
  couchbase-sg-operation-id:
    description: Every operation must define an operationId.
    given: "$.paths.*.*"
    severity: error
    then:
      field: operationId
      function: truthy
  couchbase-sg-operation-tags:
    description: Every operation must define at least one tag.
    given: "$.paths.*.*"
    severity: error
    then:
      field: tags
      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/couchbase-sync-gateway-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.