CISCO API Ruleset

OpenAPI Best Practices

This ruleset contains 12 best practices based on recommendations from the OpenAPI 3.0 Specification. This ruleset is backward compatible with OpenAPI 2.0.

Links:
- OpenAPI Specification v3.0.3
- OpenAPI Specification v2.0
- GitHub OAI/OpenAPI-Specification

Rules in this Ruleset

Violations

• operation-default-response
• standard-delete-status-codes
• standard-get-status-codes
• standard-post-status-codes
• standard-put-status-codes

Warnings

• info-contact
• info-description
• openapi-tags
• operation-description
• operation-singular-tag
• operation-tag-defined
• operation-tags
• tag-description
• api-must-have-title
• camel-case-fields
• operation-operationId
• operation-operationId-hyphen-case
• duplicated-entry-in-enum
• provide-examples
• resource-use-lowercase