BizAPI · API Governance Rules

BizAPI API Rules

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

35 Rules error 13 warn 17 info 5
View Rules File View on GitHub

Rule Categories

examples get info no openapi operation parameter paths post request response schema security servers tags

Rules

warn
info-title-prefix
API title must start with "BizAPI"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must have a version
$.info
warn
info-contact-required
Info object should have contact information
$.info
error
openapi-version
Must use OpenAPI 3.x
$
error
servers-defined
At least one server must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
warn
paths-kebab-case
Path segments must use kebab-case or lowercase
$.paths[*]~
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths[*]~
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-summary-prefix
Operation summaries must start with "BizAPI"
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete,options,head]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-id-camel-case
operationId must use camelCase
$.paths[*][get,post,put,patch,delete].operationId
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete,options,head]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
Every parameter must define a schema
$.paths[*][get,post,put,patch,delete].parameters[*]
info
request-body-description
Request bodies should have a description
$.paths[*][post,put,patch].requestBody
warn
request-body-json
Request bodies must support application/json content type
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must define at least one 2xx response
$.paths[*][get,post,put,patch,delete]
warn
response-401-defined
Operations using authentication should define a 401 response
$.paths[*][post]
info
response-429-defined
Operations should define a 429 rate-limit response
$.paths[*][post]
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-property-snake-case
Schema property names must use snake_case
$.components.schemas[*].properties[*]~
warn
schema-description-required
Top-level schemas must have a description
$.components.schemas[*]
info
schema-properties-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
error
security-schemes-defined
At least one security scheme must be defined in components
$.components
warn
security-global-defined
Global security must be defined
$
warn
post-has-request-body
POST operations should have a request body
$.paths[*].post
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
examples-encouraged
Schema properties should have examples
$.components.schemas[*].properties[*]
info
tags-global-defined
Global tags array should be defined
$
warn
servers-expected-domain
Server URLs should be on the naics.com domain.
$.servers[*].url
warn
schema-properties-casing
Schema properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties

Spectral Ruleset

Raw ↑ 
# bizapi — 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 naics.com
#   - schema-properties-casing: snake @ 100% (n=37)
#   - security: global (root) — NOT emitting operation-security-required
#   - merge: kept 33 existing, added 2 measured, upgraded 0
#   - added: servers-expected-domain, schema-properties-casing
extends:
  - spectral:oas
rules:
  info-title-prefix:
    description: API title must start with "BizAPI"
    message: Info title must start with "BizAPI" — got "{{value}}"
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: ^BizAPI
  info-description-required:
    description: Info object must have a description
    severity: error
    given: $.info
    then:
      field: description
      function: truthy
  info-version-required:
    description: Info object must have a version
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  info-contact-required:
    description: Info object should have contact information
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  openapi-version:
    description: Must use OpenAPI 3.x
    severity: error
    given: $
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: ^3\.
  servers-defined:
    description: At least one server must be defined
    severity: error
    given: $
    then:
      field: servers
      function: truthy
  servers-https:
    description: Server URLs must use HTTPS
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  paths-kebab-case:
    description: Path segments must use kebab-case or lowercase
    severity: warn
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        match: ^(/[a-z0-9-]+)+$
  paths-no-trailing-slash:
    description: Paths must not have trailing slashes
    severity: warn
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        notMatch: /$
  operation-summary-required:
    description: Every operation must have a summary
    severity: error
    given: $.paths[*][get,post,put,patch,delete,options,head]
    then:
      field: summary
      function: truthy
  operation-summary-prefix:
    description: Operation summaries must start with "BizAPI"
    message: Operation summary must start with "BizAPI" — got "{{value}}"
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].summary
    then:
      function: pattern
      functionOptions:
        match: ^BizAPI
  operation-description-required:
    description: Every operation must have a description
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,options,head]
    then:
      field: description
      function: truthy
  operation-id-required:
    description: Every operation must have an operationId
    severity: error
    given: $.paths[*][get,post,put,patch,delete,options,head]
    then:
      field: operationId
      function: truthy
  operation-id-camel-case:
    description: operationId must use camelCase
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]+$
  operation-tags-required:
    description: Every operation must have at least one tag
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,options,head]
    then:
      field: tags
      function: truthy
  parameter-description-required:
    description: Every parameter must have a description
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[*]
    then:
      field: description
      function: truthy
  parameter-schema-required:
    description: Every parameter must define a schema
    severity: error
    given: $.paths[*][get,post,put,patch,delete].parameters[*]
    then:
      field: schema
      function: truthy
  request-body-description:
    description: Request bodies should have a description
    severity: info
    given: $.paths[*][post,put,patch].requestBody
    then:
      field: description
      function: truthy
  request-body-json:
    description: Request bodies must support application/json content type
    severity: warn
    given: $.paths[*][post,put,patch].requestBody.content
    then:
      field: application/json
      function: truthy
  response-success-required:
    description: Every operation must define at least one 2xx response
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: responses
      function: schema
      functionOptions:
        schema:
          type: object
          patternProperties:
            ^2[0-9]{2}$: {}
          minProperties: 1
  response-401-defined:
    description: Operations using authentication should define a 401 response
    severity: warn
    given: $.paths[*][post]
    then:
      field: responses
      function: schema
      functionOptions:
        schema:
          type: object
          required:
          - '401'
  response-429-defined:
    description: Operations should define a 429 rate-limit response
    severity: info
    given: $.paths[*][post]
    then:
      field: responses
      function: schema
      functionOptions:
        schema:
          type: object
          required:
          - '429'
  response-description-required:
    description: Every response must have a description
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses[*]
    then:
      field: description
      function: truthy
  schema-property-snake-case:
    description: Schema property names must use snake_case
    severity: warn
    given: $.components.schemas[*].properties[*]~
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-z0-9_]*$
  schema-description-required:
    description: Top-level schemas must have a description
    severity: warn
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy
  schema-properties-description:
    description: Schema properties should have descriptions
    severity: info
    given: $.components.schemas[*].properties[*]
    then:
      field: description
      function: truthy
  security-schemes-defined:
    description: At least one security scheme must be defined in components
    severity: error
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  security-global-defined:
    description: Global security must be defined
    severity: warn
    given: $
    then:
      field: security
      function: truthy
  post-has-request-body:
    description: POST operations should have a request body
    severity: warn
    given: $.paths[*].post
    then:
      field: requestBody
      function: truthy
  get-no-request-body:
    description: GET operations must not have a request body
    severity: error
    given: $.paths[*].get
    then:
      field: requestBody
      function: falsy
  no-empty-descriptions:
    description: Descriptions must not be empty strings
    severity: error
    given: $..description
    then:
      function: pattern
      functionOptions:
        match: .+
  examples-encouraged:
    description: Schema properties should have examples
    severity: info
    given: $.components.schemas[*].properties[*]
    then:
      field: example
      function: truthy
  tags-global-defined:
    description: Global tags array should be defined
    severity: info
    given: $
    then:
      field: tags
      function: truthy
  servers-expected-domain:
    description: Server URLs should be on the naics.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: naics\.com
  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