Linting Rules - OpenAPI V3 - Info Title In Kebab Case
Number of APIs: 1
This is a Spectral governance rule to enforce that OpenAPI info title is in kebab 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-info-title-in-kebab-case": {
"description": "Ensures that all OpenAPIs information title are in Kebab case.",
"message": "The info object title needs to be in Kebab case.",
"given": "$.info.title",
"then": {
"function": "pattern",
"functionOptions": {
"match": "^[a-z][a-z0-9\\-]*$"
}
},
"type": "style",
"recommended": true,
"formats": [
"oas2",
"oas3"
],
"severity": "error"
}
}
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 - Info Title In Kebab Case POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-info-title-in-kebab-case/