Bindbee · API Governance Rules
Bindbee API Rules
Spectral linting rules defining API design standards and conventions for Bindbee.
24 Rules
error 8
warn 16
Rule Categories
bindbee
Rules
error
bindbee-info-title-prefix
API title must start with "Bindbee"
$.info.title
error
bindbee-info-version-present
API info must have a version field
$.info
warn
bindbee-info-contact-present
API info must include contact details
$.info
error
bindbee-operation-summary-prefix
Operation summaries must start with "Bindbee"
$.paths[*][*].summary
warn
bindbee-operation-id-camel-case
Operation IDs must be camelCase
$.paths[*][*].operationId
warn
bindbee-operation-tags-present
Every operation must have at least one tag
$.paths[*][*]
warn
bindbee-operation-description-present
Every operation must have a description
$.paths[*][*]
warn
bindbee-path-kebab-case
Path segments must use kebab-case
$.paths
error
bindbee-connector-token-header
Operations must require x-connector-token header
$.paths[*][*].parameters[?(@.name=='x-connector-token')]
error
bindbee-response-200-present
Every operation must define a 200 response
$.paths[*][*].responses
warn
bindbee-response-401-present
Operations should define a 401 unauthorized response
$.paths[*][*].responses
warn
bindbee-schema-title-present
All schemas must have a title
$.components.schemas[*]
warn
bindbee-schema-description-present
All schemas must have a description
$.components.schemas[*]
warn
bindbee-schema-properties-described
Schema properties must have descriptions
$.components.schemas[*].properties[*]
error
bindbee-security-scheme-present
API must define at least one security scheme
$.components
warn
bindbee-operation-security-present
Operations must declare security
$.paths[*][get,post,put,patch,delete]
warn
bindbee-tags-defined
All tags must be defined at top level
$.tags
error
bindbee-servers-present
API must define servers
$
error
bindbee-server-https
Server URL must use HTTPS
$.servers[*].url
warn
bindbee-pagination-cursor
List endpoints should support cursor-based pagination
$.paths[?(@property.startsWith('/hris/') || @property.startsWith('/ats/'))][get].parameters[?(@.name=='cursor')]
warn
bindbee-response-data-array
List responses should return data in a data array
$.components.schemas[?(@property.endsWith('Response'))].properties
warn
bindbee-operation-examples-present
Responses with content should include examples
$.paths[*][*].responses[*].content[*]
warn
bindbee-microcks-operation-present
Every operation must include x-microcks-operation extension
$.paths[*][*]
warn
bindbee-license-present
API info must include license
$.info