RTX · API Governance Rules
RTX API Rules
Spectral linting rules defining API design standards and conventions for RTX.
9 Rules
error 2
warn 7
Rule Categories
no
rtx
servers
Rules
warn
rtx-operation-ids-camel-case
All operationIds must use camelCase naming convention.
$.paths.*[get,post,put,patch,delete].operationId
warn
rtx-tags-title-case
All tags must use Title Case.
$.tags[*].name
warn
rtx-bearer-auth-required
RTX EAGLE API uses bearer token authentication.
$.components.securitySchemes
warn
rtx-paths-kebab-case
All path segments must use kebab-case.
$.paths
error
rtx-response-200-defined
All operations must define a 200 response.
$.paths.*[get,post,put,patch,delete].responses
warn
rtx-summaries-title-case
Operation summaries must use Title Case.
$.paths.*[get,post,put,patch,delete].summary
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-expected-domain
Server URLs should be on the rtx.com domain.
$.servers[*].url
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description