Box · API Governance Rules

Box API Rules

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

10 Rules error 1 warn 9

View Rules File View on GitHub

Rule Categories

error no operationid path query schema security servers

Rules

error

servers-https-only

Server URLs must use HTTPS.

$.servers[*].url

warn

servers-expected-domain

Server URLs should be on the box.com domain.

$.servers[*].url

warn

path-params-casing

Path parameters should be snake_case (the dominant convention in this API).

$.paths[*].parameters[?(@.in=='path')].name

warn

query-params-casing

Query parameters should be snake_case (the dominant convention in this API).

$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]

warn

operationid-casing

Operation IDs should be snake_case (the dominant convention in this API).

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

warn

schema-names-casing

Component schema names should be PascalCase (the dominant convention in this API).

$.components.schemas

warn

schema-properties-casing

Schema properties should be snake_case (the dominant convention in this API).

$.components.schemas[*].properties

warn

security-schemes-defined

Security schemes should be defined in components.

$.components

warn

error-schema-defined

A shared error schema (ClientError) should be defined for error payloads.

$.components.schemas

warn

no-empty-descriptions

Descriptions must not be empty strings.

$..description

Spectral Ruleset

# box — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
#   - servers-https-only: 100% of servers already https (error)
#   - servers-expected-domain: 1/1 servers on box.com
#   - path-params-casing: snake @ 100% (n=413)
#   - query-params-casing: snake @ 100% (n=529)
#   - operationid-casing: snake @ 88% (n=537)
#   - schema-names-casing: pascal @ 85% (n=365)
#   - schema-properties-casing: snake @ 95% (n=1248)
#   - security: global (root) — NOT emitting operation-security-required
#   - error-schema-defined: ClientError
#   - pagination params observed: ['limit', 'offset']
#   - merge: kept 10 existing, added 2 measured, upgraded 0
#   - added: path-params-casing, error-schema-defined
extends:
  - spectral:oas
rules:
  servers-https-only:
    description: Server URLs must use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  servers-expected-domain:
    description: Server URLs should be on the box.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: box\.com
  path-params-casing:
    description: Path parameters should be snake_case (the dominant convention in this API).
    severity: warn
    given: $.paths[*].parameters[?(@.in=='path')].name
    then:
      function: casing
      functionOptions:
        type: snake
  query-params-casing:
    description: Query parameters should be snake_case (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
    then:
      field: name
      function: casing
      functionOptions:
        type: snake
  operationid-casing:
    description: Operation IDs should be snake_case (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: casing
      functionOptions:
        type: snake
  schema-names-casing:
    description: Component schema names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas
    then:
      field: '@key'
      function: pattern
      functionOptions:
        match: ^[A-Z][A-Za-z0-9]*$
  schema-properties-casing:
    description: Schema properties should be snake_case (the dominant convention in this API).
    severity: warn
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: snake
  security-schemes-defined:
    description: Security schemes should be defined in components.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  error-schema-defined:
    description: A shared error schema (ClientError) should be defined for error payloads.
    severity: warn
    given: $.components.schemas
    then:
      field: ClientError
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy