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

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