Aladdin Studio · API Governance Rules
Aladdin Studio API Rules
Spectral linting rules defining API design standards and conventions for Aladdin Studio.
36 Rules
error 16
warn 17
info 3
Rule Categories
delete
examples
get
info
no
openapi
operation
parameter
paths
request
response
schema
security
servers
tags
Rules
error
info-title-required
Info title must be defined
$.info
warn
info-title-aladdin-prefix
API title should start with 'Aladdin'
$.info.title
warn
info-description-required
Info description must be defined and non-empty
$.info
error
info-version-required
Info version must be defined
$.info
warn
info-contact-required
Info should include contact information
$.info
warn
info-license-required
Info should include license information
$.info
error
openapi-version-3
Must use OpenAPI 3.0.x
$
error
servers-required
Servers must be defined
$
error
servers-https-required
Server URLs must use HTTPS
$.servers[*]
warn
servers-blackrock-domain
Server URLs should use api.blackrock.com domain
$.servers[*]
warn
paths-kebab-case
Path segments should use kebab-case (not camelCase or snake_case)
$.paths[*]~
error
paths-no-trailing-slash
Paths must not have a trailing slash
$.paths[*]~
warn
paths-versioned
API paths should include a version prefix
$.paths[*]~
error
operation-summary-required
Operations must have a summary
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-summary-aladdin-prefix
Operation summaries should start with 'Aladdin Studio'
$.paths[*][get,post,put,patch,delete,head,options].summary
warn
operation-description-required
Operations should have a description
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-operationid-required
Operations must have an operationId
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-operationid-camel-case
OperationId should use camelCase
$.paths[*][get,post,put,patch,delete,head,options].operationId
error
operation-tags-required
Operations must have at least one tag
$.paths[*][get,post,put,patch,delete,head,options]
warn
tags-defined
Tags should be defined at the global level
$
warn
tags-description-required
Global tags should have descriptions
$.tags[*]
error
parameter-description-required
Parameters must have a description
$.paths[*][*].parameters[*]
error
parameter-schema-required
Parameters must have a schema definition
$.paths[*][*].parameters[*]
warn
request-body-description
Request bodies should have a description
$.paths[*][*].requestBody
error
response-success-required
Operations must have at least one success response
$.paths[*][get,post,put,patch,delete]
error
response-description-required
All responses must have a description
$.paths[*][*].responses[*]
warn
response-401-required
APIs should define 401 Unauthorized response
$.paths[*][get,post,put,patch,delete]
info
response-404-for-resource-endpoints
Resource endpoints should define 404 Not Found
$.paths[*][get]
warn
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
warn
schema-type-required
Schemas should define a type
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined in components
$
info
security-oauth2-preferred
OAuth2 should be the primary authentication scheme
$.components.securitySchemes
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body
$.paths[*].delete
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
examples-encouraged
Schema properties should have examples for developer experience
$.components.schemas[*].properties[*]