Apache Guacamole · API Governance Rules
Apache Guacamole API Rules
Spectral linting rules defining API design standards and conventions for Apache Guacamole.
10 Rules
error 4
warn 5
info 1
Rule Categories
info
operation
parameter
response
schema
security
Rules
error
info-title-required
Info title must be defined
$.info
error
info-version-required
API version must be specified
$.info
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-apache-guacamole-prefix
Operation summaries should start with Apache Guacamole
$.paths[*][get,post,put,delete,patch].summary
error
operation-operationId-required
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
Operations should have tags
$.paths[*][get,post,put,delete,patch]
warn
security-token-required
All session operations require Guacamole-Token header
$.paths./api/session[*][get,post,put,delete].parameters[?(@.name=='Guacamole-Token')]
warn
response-description-required
All responses must have descriptions
$.paths[*][get,post,put,delete,patch].responses[*]
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,delete,patch].parameters[*]
info
schema-description-recommended
Schemas should have descriptions
$.components.schemas[*]