BigCommerce · API Governance Rules
BigCommerce API Rules
Spectral linting rules defining API design standards and conventions for BigCommerce.
24 Rules
error 7
warn 17
Rule Categories
bigcommerce
Rules
error
bigcommerce-info-title-prefix
API title must start with "BigCommerce"
$.info.title
error
bigcommerce-info-version-present
API info must have a version field
$.info
warn
bigcommerce-info-contact-present
API info must include contact details
$.info
warn
bigcommerce-info-description-present
API info must have a description
$.info
error
bigcommerce-operation-summary-prefix
Operation summaries must start with "BigCommerce"
$.paths[*][*].summary
warn
bigcommerce-operation-id-camel-case
Operation IDs must be camelCase
$.paths[*][*].operationId
warn
bigcommerce-operation-tags-present
Every operation must have at least one tag
$.paths[*][*]
warn
bigcommerce-operation-description-present
Every operation must have a description
$.paths[*][*]
warn
bigcommerce-path-kebab-case
Path segments must use kebab-case
$.paths
error
bigcommerce-response-200-present
Every operation must define a success response
$.paths[*][*].responses
warn
bigcommerce-response-error-present
Operations must define error responses
$.paths[*][post,put,patch,delete].responses
warn
bigcommerce-schema-title-present
All schemas must have a title
$.components.schemas[*]
warn
bigcommerce-schema-description-present
All schemas must have a description
$.components.schemas[*]
warn
bigcommerce-schema-properties-described
Schema properties must have descriptions
$.components.schemas[*].properties[*]
error
bigcommerce-security-scheme-present
API must define at least one security scheme
$.components
warn
bigcommerce-operation-security-present
Mutating operations must declare security
$.paths[*][post,put,patch,delete]
warn
bigcommerce-tags-defined
All tags used in operations must be defined at top level
$.tags
warn
bigcommerce-tag-description-present
Top-level tags must have a description
$.tags[*]
error
bigcommerce-servers-present
API must define servers
$
error
bigcommerce-server-url-https
Server URLs must use HTTPS
$.servers[*].url
warn
bigcommerce-operation-examples-present
Responses with content should include examples
$.paths[*][*].responses[*].content[*]
warn
bigcommerce-microcks-operation-present
Every operation must include x-microcks-operation extension
$.paths[*][*]
warn
bigcommerce-store-hash-variable
Server URLs should use store hash variable
$.servers[*].url
warn
bigcommerce-license-present
API info must include license
$.info