Apache Flink · API Governance Rules
Apache Flink API Rules
Spectral linting rules defining API design standards and conventions for Apache Flink.
11 Rules
error 5
warn 5
info 1
Rule Categories
info
operation
parameter
paths
response
schema
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-flink-prefix
Operation summaries should start with Apache Flink
$.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 for grouping
$.paths[*][get,post,put,delete,patch]
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,delete,patch].parameters[*]
error
response-success-required
Operations must define at least one 2xx response
$.paths[*][get,post,put,delete,patch].responses
warn
response-description-required
All responses must have descriptions
$.paths[*][get,post,put,delete,patch].responses[*]
info
schema-description-recommended
Schemas should have descriptions
$.components.schemas[*]