Tremendous · API Governance Rules

Tremendous API Rules

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

20 Rules error 3 warn 13 info 4
View Rules File View on GitHub

Rule Categories

no operation path query schema servers tremendous

Rules

warn
tremendous-operation-id-camel-case
Operation IDs must use camelCase
$.paths[*][*].operationId
warn
tremendous-summary-title-case
Operation summaries must use Title Case
$.paths[*][*].summary
error
tremendous-security-defined
All operations must define security requirements
$.paths[*][get,post,put,patch,delete]
error
tremendous-response-200-get
All GET operations must define a 200 response
$.paths[*].get
warn
tremendous-response-401-defined
Authenticated operations should define a 401 response
$.paths[*][get,post,put,patch,delete]
warn
tremendous-tag-defined
All operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
info
tremendous-bearer-auth
Tremendous API uses Bearer token (API key) authentication
$.components.securitySchemes.BearerAuth
warn
tremendous-path-snake-case
Path parameters use snake_case
$.paths[*]~
warn
tremendous-post-request-body
POST operations should define a request body
$.paths[*].post
info
tremendous-rate-limit-response
Tremendous API enforces rate limits - 429 should be documented
$.paths[*][get,post]
info
tremendous-idempotency-external-id
Create operations should document external_id for idempotency
$.paths['/orders'].post.requestBody.content.application/json.schema
info
tremendous-list-pagination
List operations should support pagination with offset and limit
$.paths[*].get
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-expected-domain
Server URLs should be on the tremendous.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
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
operation-documents-401
Operations should document a 401 response (documented on 100% of this API's operations).
$.paths[*][get,post,put,patch,delete].responses
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑
# tremendous — 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: 2/2 servers on tremendous.com
#   - path-params-casing: snake @ 100% (n=9)
#   - query-params-casing: snake @ 100% (n=8)
#   - operationid-casing: camel @ 100% (n=22)
#   - schema-names-casing: pascal @ 100% (n=12)
#   - schema-properties-casing: snake @ 100% (n=63)
#   - security: global (root) — NOT emitting operation-security-required
#   - operation-documents-401: 100% adherence
#   - pagination params observed: ['limit', 'offset']
#   - merge: kept 12 existing, added 8 measured, upgraded 0
#   - added: servers-https-only, servers-expected-domain, path-params-casing, query-params-casing, schema-names-casing, schema-properties-casing, operation-documents-401, no-empty-descriptions
extends:
  - spectral:oas
rules:
  tremendous-operation-id-camel-case:
    description: Operation IDs must use camelCase
    message: Operation ID '{{value}}' must use camelCase
    severity: warn
    given: $.paths[*][*].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
  tremendous-summary-title-case:
    description: Operation summaries must use Title Case
    message: Summary '{{value}}' should use Title Case
    severity: warn
    given: $.paths[*][*].summary
    then:
      function: pattern
      functionOptions:
        match: ^[A-Z][a-zA-Z0-9 /()+&-]*$
  tremendous-security-defined:
    description: All operations must define security requirements
    message: Operation must define security requirements
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: security
      function: defined
  tremendous-response-200-get:
    description: All GET operations must define a 200 response
    message: GET operation must define a 200 success response
    severity: error
    given: $.paths[*].get
    then:
      field: responses.200
      function: defined
  tremendous-response-401-defined:
    description: Authenticated operations should define a 401 response
    message: Operation should define 401 Unauthorized
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: responses.401
      function: defined
  tremendous-tag-defined:
    description: All operations must have at least one tag
    message: Operation must include at least one tag
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: defined
  tremendous-bearer-auth:
    description: Tremendous API uses Bearer token (API key) authentication
    message: Use BearerAuth security scheme
    severity: info
    given: $.components.securitySchemes.BearerAuth
    then:
      function: defined
  tremendous-path-snake-case:
    description: Path parameters use snake_case
    message: Path segments should use snake_case or kebab-case
    severity: warn
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        match: ^(/[a-z][a-z0-9_-]*(/[a-z][a-z0-9_-]*|/\{[a-zA-Z][a-zA-Z0-9_]*\})*)+$
  tremendous-post-request-body:
    description: POST operations should define a request body
    message: POST operation should include a requestBody
    severity: warn
    given: $.paths[*].post
    then:
      field: requestBody
      function: defined
  tremendous-rate-limit-response:
    description: Tremendous API enforces rate limits - 429 should be documented
    message: Operation should define 429 Too Many Requests response
    severity: info
    given: $.paths[*][get,post]
    then:
      field: responses.429
      function: defined
  tremendous-idempotency-external-id:
    description: Create operations should document external_id for idempotency
    message: Order creation supports external_id for idempotent requests
    severity: info
    given: $.paths['/orders'].post.requestBody.content.application/json.schema
    then:
      function: defined
  tremendous-list-pagination:
    description: List operations should support pagination with offset and limit
    message: List endpoint should support offset and limit parameters
    severity: info
    given: $.paths[*].get
    then:
      function: defined
  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 tremendous.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: tremendous\.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
  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: casing
      functionOptions:
        type: pascal
  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
  operation-documents-401:
    description: Operations should document a 401 response (documented on 100% of this API's operations).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      field: '401'
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy