Biogen · API Governance Rules
Biogen API Rules
Spectral linting rules defining API design standards and conventions for Biogen.
23 Rules
error 7
warn 16
Rule Categories
biogen
Rules
error
biogen-info-title-prefix
API title must start with "Biogen"
$.info.title
error
biogen-info-version-present
API info must have a version field
$.info
warn
biogen-info-contact-present
API info must include contact details
$.info
error
biogen-operation-summary-prefix
Operation summaries must start with "Biogen"
$.paths[*][*].summary
warn
biogen-operation-id-camel-case
Operation IDs must be camelCase
$.paths[*][*].operationId
warn
biogen-operation-tags-present
Every operation must have at least one tag
$.paths[*][*]
warn
biogen-operation-description-present
Every operation must have a description
$.paths[*][*]
error
biogen-response-success-present
Every operation must define a success response
$.paths[*][*].responses
warn
biogen-response-401-present
Operations should define a 401 response
$.paths[*][*].responses
warn
biogen-schema-title-present
All schemas must have a title
$.components.schemas[*]
warn
biogen-schema-description-present
All schemas must have a description
$.components.schemas[*]
warn
biogen-schema-properties-described
Schema properties must have descriptions
$.components.schemas[*].properties[*]
error
biogen-security-scheme-present
API must define at least one security scheme
$.components
warn
biogen-api-key-auth
Biogen API uses X-API-Key header authentication
$.components.securitySchemes[*]
warn
biogen-operation-security-present
Operations must declare security
$.paths[*][get,post,put,patch,delete]
warn
biogen-tags-defined
All tags used in operations must be defined at top level
$.tags
error
biogen-servers-present
API must define servers
$
error
biogen-server-https
Server URL must use HTTPS
$.servers[*].url
warn
biogen-operation-examples-present
Responses with content should include examples
$.paths[*][*].responses[*].content[*]
warn
biogen-microcks-operation-present
Every operation must include x-microcks-operation extension
$.paths[*][*]
warn
biogen-unused-components
All components should be referenced
$.components.schemas
warn
biogen-license-present
API info must include license
$.info
warn
biogen-path-kebab-case
Path segments should be lowercase
$.paths