Apigee · API Governance Rules
Apigee API Rules
Spectral linting rules defining API design standards and conventions for Apigee.
14 Rules
error 5
warn 7
info 2
Rule Categories
delete
info
operation
parameter
response
schema
security
servers
Rules
warn
info-title-prefix
API title must start with 'Apigee'.
$.info
error
info-description-required
API must have a description.
$.info
error
servers-https
All server URLs must use HTTPS.
$.servers[*]
info
servers-googleapis
Apigee API servers should be on *.googleapis.com.
$.servers[*]
warn
operation-summary-title-case
Operation summaries must be in Title Case.
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries must start with 'Apigee'.
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
warn
operation-id-camelcase
OperationId must use camelCase.
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must have a 2xx response.
$.paths[*][get,post,put,patch,delete].responses
warn
delete-returns-200-or-204
DELETE operations should return 200 or 204.
$.paths[*].delete.responses
info
schema-property-description
Schema properties should have descriptions.
$.components.schemas[*].properties[*]
error
security-oauth2-required
Apigee APIs must define OAuth2 security.
$.components.securitySchemes