Apache OpenWhisk · API Governance Rules
Apache OpenWhisk API Rules
Spectral linting rules defining API design standards and conventions for Apache OpenWhisk.
10 Rules
error 4
warn 3
info 3
Rule Categories
info
operation
paths
response
schema
security
Rules
error
info-title-required
API must have a title
$.info
error
operation-summary-required
Operations must have summaries
$.paths[*][*]
error
operation-operationId-required
Operations must have operationIds
$.paths[*][*]
warn
operation-tags-required
Operations must have tags
$.paths[*][*]
info
operation-summary-apache-prefix
Summaries should start with Apache OpenWhisk
$.paths[*][get,post,put,delete,patch].summary
info
paths-api-versioned
Paths should be versioned under /api/v1
$.servers[*].url
warn
security-basic-auth
API should use HTTP Basic authentication
$.components.securitySchemes
error
response-success-required
Operations must have a 200 success response
$.paths[*][get,post,put].responses
info
schema-properties-described
Schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
operation-parameters-described
Parameters should have descriptions
$.paths[*][*].parameters[*]