Split · API Governance Rules

Split API Rules

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

11 Rules error 4 warn 5 info 2
View Rules File View on GitHub

Rule Categories

split

Rules

error
split-operation-id-required
All operations must have an operationId.
$.paths[*][get,post,put,patch,delete,head,options]
warn
split-operation-id-verb-prefix
operationId must start with a standard REST verb.
$.paths[*][get,post,put,patch,delete].operationId
warn
split-summary-title-case
Operation summaries must use Title Case.
$.paths[*][get,post,put,patch,delete].summary
warn
split-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
error
split-bearer-auth-required
Operations must use bearerAuth security scheme.
$.components.securitySchemes
error
split-response-200-required
Every operation must define a 200 or 201 success response.
$.paths[*][get,post,put,patch,delete].responses
warn
split-401-response-required
Every operation must define a 401 Unauthorized response.
$.paths[*][get,post,put,patch,delete].responses
info
split-pagination-params
List operations should support limit and offset query parameters.
$.paths[*].get.operationId
info
split-workspace-id-path-param
Workspace-scoped paths must use workspaceId path parameter.
$.paths[~/ws/{workspaceId}]
error
split-servers-required
The API must define at least one server.
$
warn
split-info-contact-required
The info object must include a contact entry.
$.info

Spectral Ruleset

Raw ↑ 
extends: [[spectral:oas, recommended]]

rules:
  split-operation-id-required:
    description: All operations must have an operationId.
    severity: error
    given: "$.paths[*][get,post,put,patch,delete,head,options]"
    then:
      field: operationId
      function: truthy

  split-operation-id-verb-prefix:
    description: operationId must start with a standard REST verb.
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].operationId"
    then:
      function: pattern
      functionOptions:
        match: "^(get|list|create|update|delete|enable|restore|kill|add|remove|upload|approve|deactivate|invite|track)[A-Z][a-zA-Z0-9]+$"

  split-summary-title-case:
    description: Operation summaries must use Title Case.
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].summary"
    then:
      function: pattern
      functionOptions:
        match: "^[A-Z][a-zA-Z0-9 /()-]+$"

  split-tags-required:
    description: Every operation must have at least one tag.
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: tags
      function: truthy

  split-bearer-auth-required:
    description: Operations must use bearerAuth security scheme.
    severity: error
    given: "$.components.securitySchemes"
    then:
      field: bearerAuth
      function: truthy

  split-response-200-required:
    description: Every operation must define a 200 or 201 success response.
    severity: error
    given: "$.paths[*][get,post,put,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
            - required: ["200"]
            - required: ["201"]

  split-401-response-required:
    description: Every operation must define a 401 Unauthorized response.
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          required: ["401"]

  split-pagination-params:
    description: List operations should support limit and offset query parameters.
    severity: info
    given: "$.paths[*].get.operationId"
    then:
      function: pattern
      functionOptions:
        match: "^list"

  split-workspace-id-path-param:
    description: Workspace-scoped paths must use workspaceId path parameter.
    severity: info
    given: "$.paths[~/ws/{workspaceId}]"
    then:
      function: truthy

  split-servers-required:
    description: The API must define at least one server.
    severity: error
    given: "$"
    then:
      field: servers
      function: truthy

  split-info-contact-required:
    description: The info object must include a contact entry.
    severity: warn
    given: "$.info"
    then:
      field: contact
      function: truthy