APIMatic Linting for Portal Generation

Overview

APIMatic performs some preliminary linting checks on the user-provided API specification file to ensure that the docs/portal generation produces the desired output.

Property	Value
Id	apimatic-docs-linting
Code	APIMATICDOCS_L
Ruleset Type	Linting
Default Severity of All Rules	Warning
Rule System	Semantic
Tags	portal generation portal docs linting apimatic

For More Information

• https://www.apimatic.io/developer-experience-portal/
• https://docs.apimatic.io/rulesets/overview/

Categories of Rules

• Description (APIMATICDOCS_L001 - APIMATICDOCS_L100)
• Examples (APIMATICDOCS_L101 - APIMATICDOCS_L200)

Description Rules

• required-description-all-entities (APIMATICDOCS_L001)
• required-entity-description (APIMATICDOCS_L002)

Examples Rules

• required-entity-example-value (APIMATICDOCS_L101)
• required-example-value-or-external-url (APIMATICDOCS_L102)
• no-example-for-error-with-no-model (APIMATICDOCS_L103)
• valid-example-value (APIMATICDOCS_L104)
• example-value-restrictions (APIMATICDOCS_L105)
• no-undeclared-fields-in-example-value (APIMATICDOCS_L106)
• unique-example-ids (APIMATICDOCS_L107)
• non-empty-non-null-example-id (APIMATICDOCS_L108)
• valid-example-external-value-url (APIMATICDOCS_L109)
• no-read-only-property-in-parameter-example (APIMATICDOCS_L110)
• no-write-only-property-in-response-example (APIMATICDOCS_L111)