Linting Rules - OpenAPI V3 - Schema Names Snake Case
Number of APIs: 1
This is a Spectral governance rule to make sure that all schema names in an OpenAPI are snake case. Here is a JSON version of the rule that can be applied using this API-driven collection API, or at CLI or CI/CD pipeline.
{
"openapi-v3-schema-names-snake-case": {
"description": "Ensure all schema names are snake case.",
"message": "Schema names should be snake case.",
"severity": "error",
"given": "$.components.schemas",
"then": {
"field": "@key",
"function": "casing",
"functionOptions": {
"type": "snake"
}
}
}
}
This request can be run as part of this collection, or dragged and dropped to another collection of governance requests organized by folder, demonstrating how API governance linting works, but also providing a rule that can be used as part of your wider API governance strategy.
- OpenAPI V3 - Schema Names Snake Case POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-schema-names-snake-case/