BetSolutions · API Governance Rules
BetSolutions API Rules
Spectral linting rules defining API design standards and conventions for BetSolutions.
30 Rules
error 15
warn 13
info 2
Rule Categories
get
hash
info
no
openapi
operation
parameter
paths
post
request
response
schema
security
servers
Rules
error
info-title-required
API info must have a title.
$.info
warn
info-title-prefix
API title should begin with "BetSolutions".
$.info.title
error
info-description-required
API info must have a description.
$.info
error
info-version-required
API info must have a version.
$.info
error
openapi-version-3
All specs must use OpenAPI 3.0.x.
$
error
servers-defined
At least one server must be defined.
$
error
servers-https
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-betsolutions-domain
Server URLs should use a betsolutions.com domain.
$.servers[*].url
warn
paths-kebab-case
Path segments should use kebab-case.
$.paths[*]~
error
paths-no-trailing-slash
Paths must not have a trailing slash.
$.paths[*]~
error
operation-summary-required
All operations must have a summary.
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-summary-prefix
Operation summaries should start with "BetSolutions".
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
All operations must have a description.
$.paths[*][get,post,put,patch,delete,options,head]
error
operation-id-required
All operations must have an operationId.
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-id-camel-case
operationId should use camelCase.
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
All operations must have at least one tag.
$.paths[*][get,post,put,patch,delete,options,head]
warn
post-request-body-required
POST operations should have a request body.
$.paths[*].post
warn
request-body-json
Request bodies should use application/json content type.
$.paths[*][post,put,patch].requestBody.content
warn
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
info
hash-parameter-required
BetSolutions API requires SHA-256 hash parameter for authentication.
$.paths[*][post].requestBody.content['application/json'].schema.properties
error
response-success-required
Operations must define at least one 2xx success response.
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
All responses must have a description.
$.paths[*][get,post,put,patch,delete].responses[*]
warn
response-json-content
Success responses should return application/json content.
$.paths[*][get,post,put,patch,delete].responses['200'].content
warn
response-401-defined
Operations should define a 401 unauthorized response.
$.paths[*][get,post,put,patch,delete].responses
warn
schema-description-required
Top-level schemas should have a description.
$.components.schemas[*]
warn
schema-type-required
Schema definitions should have an explicit type.
$.components.schemas[*]
info
schema-success-flag
BetSolutions response schemas should include a success boolean field.
$.components.schemas[*].properties
error
security-scheme-defined
Security schemes must be defined in components.
$.components.securitySchemes
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description