Documentation Conformance

You can check for API documentation conformance using a custom or MuleSoft-provided ruleset. A ruleset provided by MuleSoft that validates API catalog documentation is:

API Documentation Best Practices

See Finding and Fixing Conformance Issues for an overview of ways to validate conformance and determine why conformance failed.

Fix API Documentation Conformance Issues in Exchange

Fix API documentation issues by updating the documentation associated with the API to conform to the rules it violated. For information about updating API documentation using Exchange, see Describe an Asset.