Apache Flink API Rules
Spectral linting rules defining API design standards and conventions for Apache Flink.
16 Rules
error 5
warn 9
info 2
Rule Categories
info
no
operation
operationid
parameter
paths
query
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[*]
warn
query-params-casing
Query parameters should be snake_case (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
operationid-casing
Operation IDs should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description
Spectral Ruleset
# authorship: generated by API Evangelist tooling. Stamped 2026-08-18
# on the file's own generator header (roadmap#64). An unmarked file is
# NOT assumed to be ours -- absence of evidence was never stamped.
x-method: generated
# apache-flink — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
# - path-params-casing: snake @ 100% (n=80)
# - query-params-casing: snake @ 70% (n=30)
# - operationid-casing: camel @ 100% (n=69)
# - schema-names-casing: pascal @ 100% (n=132)
# - schema-properties-casing: snake @ 56% (n=444)
# - merge: kept 11 existing, added 5 measured, upgraded 0
# - added: query-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, no-empty-descriptions
extends:
- spectral:oas
rules:
info-title-required:
description: Info title must be defined
severity: error
given: $.info
then:
field: title
function: truthy
info-version-required:
description: API version must be specified
severity: error
given: $.info
then:
field: version
function: truthy
operation-summary-required:
description: All operations must have a summary
severity: error
given: $.paths[*][get,post,put,delete,patch]
then:
field: summary
function: truthy
operation-summary-apache-flink-prefix:
description: Operation summaries should start with Apache Flink
severity: warn
given: $.paths[*][get,post,put,delete,patch].summary
then:
function: pattern
functionOptions:
match: ^Apache Flink
operation-operationId-required:
description: All operations must have an operationId
severity: error
given: $.paths[*][get,post,put,delete,patch]
then:
field: operationId
function: truthy
operation-tags-required:
description: Operations should have tags for grouping
severity: warn
given: $.paths[*][get,post,put,delete,patch]
then:
field: tags
function: truthy
paths-no-trailing-slash:
description: Paths must not have trailing slashes
severity: warn
given: $.paths
then:
field: '@key'
function: pattern
functionOptions:
notMatch: /$
parameter-description-required:
description: All parameters must have descriptions
severity: warn
given: $.paths[*][get,post,put,delete,patch].parameters[*]
then:
field: description
function: truthy
response-success-required:
description: Operations must define at least one 2xx response
severity: error
given: $.paths[*][get,post,put,delete,patch].responses
then:
function: schema
functionOptions:
schema:
minProperties: 1
response-description-required:
description: All responses must have descriptions
severity: warn
given: $.paths[*][get,post,put,delete,patch].responses[*]
then:
field: description
function: truthy
schema-description-recommended:
description: Schemas should have descriptions
severity: info
given: $.components.schemas[*]
then:
field: description
function: truthy
query-params-casing:
description: Query parameters should be snake_case (the dominant convention in this API).
severity: warn
given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
then:
field: name
function: casing
functionOptions:
type: snake
operationid-casing:
description: Operation IDs should be camelCase (the dominant convention in this API).
severity: warn
given: $.paths[*][get,post,put,patch,delete].operationId
then:
function: casing
functionOptions:
type: camel
schema-names-casing:
description: Component schema names should be PascalCase (the dominant convention in this API).
severity: warn
given: $.components.schemas
then:
field: '@key'
function: pattern
functionOptions:
match: ^[A-Z][A-Za-z0-9]*$
schema-properties-casing:
description: Schema properties should be snake_case (the dominant convention in this API).
severity: info
given: $.components.schemas[*].properties
then:
field: '@key'
function: casing
functionOptions:
type: snake
no-empty-descriptions:
description: Descriptions must not be empty strings.
severity: warn
given: $..description
then:
function: truthy