CubeFS · API Governance Rules

CubeFS API Rules

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

3 Rules error 1 warn 2
View Rules File View on GitHub

Rule Categories

cubefs

Rules

error
cubefs-s3-server-defined
CubeFS S3 spec must declare a server.
$.servers
warn
cubefs-s3-bucket-path
S3 bucket-scoped operations must include {Bucket} path parameter.
$.paths
warn
cubefs-s3-tag-required
S3 operations must declare a tag (Buckets, Objects, Multipart, Acl).
$.paths[*][get,post,put,delete,head]

Spectral Ruleset

Raw ↑
extends: [[spectral:oas, all]]
rules:
  cubefs-s3-server-defined:
    description: CubeFS S3 spec must declare a server.
    given: $.servers
    severity: error
    then:
      function: truthy
  cubefs-s3-bucket-path:
    description: S3 bucket-scoped operations must include {Bucket} path parameter.
    given: $.paths
    severity: warn
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          patternProperties:
            "^/(\\{Bucket\\}|)":
              type: object
  cubefs-s3-tag-required:
    description: S3 operations must declare a tag (Buckets, Objects, Multipart, Acl).
    given: $.paths[*][get,post,put,delete,head]
    severity: warn
    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/cubefs-s3-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.