CloudBees · API Governance Rules
CloudBees API Rules
Spectral linting rules defining API design standards and conventions for CloudBees.
12 Rules
error 4
warn 6
info 2
Rule Categories
cloudbees
Rules
error
cloudbees-info-contact
API contact information must be present.
$.info
warn
cloudbees-info-license
API license must be declared.
$.info
error
cloudbees-server-https
All server URLs must use HTTPS.
$.servers[*].url
warn
cloudbees-feature-mgmt-base
CloudBees Feature Management server URLs must point at x-api.rollout.io.
$.servers[?(@.url && @.url.indexOf('rollout.io') > -1)].url
warn
cloudbees-cd-versioned
CloudBees CD/RO server URLs must include /rest/v1.0.
$.servers[?(@.url && @.url.indexOf('cloudbees') > -1 && @.url.indexOf('cd') > -1)].url
error
cloudbees-bearer-or-basic
A bearer or basic security scheme must be declared.
$.components.securitySchemes
warn
cloudbees-operation-tags
Every operation must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
cloudbees-operation-summary
Every operation must include a short summary.
$.paths[*][get,post,put,patch,delete]
error
cloudbees-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
cloudbees-error-responses
Mutating operations should declare 4xx error responses.
$.paths[*][post,put,patch,delete].responses
info
cloudbees-rate-limit-555
Feature Management endpoints should document the 555 rate-limit response.
$.paths[?(@property.match(/applications|environments|flags|experiments/))][*].responses
info
cloudbees-pagination
List endpoints should support page/limit pagination params.
$.paths[?(@property.match(/applications$|environments$|flags$|experiments$|audit$/))].get.parameters[*].name