Description Governance Rules

Rules can be defined to govern the descriptions provided for each API, leveraging the description properties for OpenAPI or AsyncAPI contracts, but then apply specific ruling looking for common patterns to be present like length or contents of the description, meeting specific guidelines regarding what description is needed.

Does this provide what you need? Let us know by submitting issue!

Description governance rules provide a base of YAML or JSON rules that can be applied to the description object within OpenAPI or AsyncAPI contracts, checking for specific patterns for the length or contents of a description, and other elements of an API. Rules can be defined centrally by governance leadership, or locally within teams, and then applied either at design, develop, or build time in a manual or automated way depending on the objectives of team, department, organization, or industry-wide governance.


Return to Main Page

This provides a link back to the home page if you need it.