Binance · API Governance Rules
Binance API Rules
Spectral linting rules defining API design standards and conventions for Binance.
24 Rules
error 8
warn 15
info 1
Rule Categories
binance
Rules
error
binance-info-title-prefix
API title must start with "Binance"
$.info.title
error
binance-info-version-present
API info must have a version field
$.info
warn
binance-info-contact-present
API info must include contact details
$.info
error
binance-operation-summary-prefix
Operation summaries must start with "Binance"
$.paths[*][*].summary
warn
binance-operation-id-camel-case
Operation IDs must be camelCase
$.paths[*][*].operationId
warn
binance-operation-tags-present
Every operation must have at least one tag
$.paths[*][*]
warn
binance-operation-description-present
Every operation must have a description
$.paths[*][*]
warn
binance-path-kebab-case
Path segments must use kebab-case or standard patterns
$.paths
error
binance-request-body-post
POST operations must have a request body
$.paths[*].post
error
binance-response-success-present
Every operation must define a success response
$.paths[*][*].responses
warn
binance-schema-title-present
All schemas must have a title
$.components.schemas[*]
warn
binance-schema-description-present
All schemas must have a description
$.components.schemas[*]
error
binance-security-scheme-present
API must define at least one security scheme
$.components
warn
binance-hmac-auth-used
Binance APIs use HMAC SHA256 signed requests
$.components.securitySchemes[*]
warn
binance-operation-security-present
Private operations must declare security
$.paths[*][post,delete]
warn
binance-tags-defined
All tags used in operations must be defined at top level
$.tags
error
binance-servers-present
API must define servers
$
error
binance-server-https
Server URL must use HTTPS
$.servers[*].url
warn
binance-operation-examples-present
Responses with content should include examples
$.paths[*][*].responses[*].content[*]
warn
binance-microcks-operation-present
Every operation must include x-microcks-operation extension
$.paths[*][*]
warn
binance-timestamp-parameter
Signed endpoints should include timestamp parameter
$.paths[*][get,post,delete].parameters[?(@.name=='timestamp')]
info
binance-recvwindow-parameter
Signed endpoints may include recvWindow parameter
$.paths[*][*].parameters[?(@.name=='recvWindow')]
warn
binance-license-present
API info must include license
$.info
warn
binance-schema-properties-described
Schema properties must have descriptions
$.components.schemas[*].properties[*]