Define & Validate APIsValidation RulesetsOpenAPI Rulesets
OpenAPI v3 Syntax Linting for APIMatic Portal Generation
Syntax linting checks performed by APIMatic on provided OpenAPI v3 file to check its conformance to recommended practices for a more user-friendly API documentation.
Note: Some rules on this page apply to SDK test generation and CodeGen settings, which Codegen v4 doesn't use. APIMatic still reports them if your API definition includes those settings.
| Property | Value |
|---|---|
| Ruleset ID | openapi-v3-docsgen-syntax-linting |
| Code prefix | OPENAPI3DOCSGENSYNTAX_L |
| Type | Linting |
| Default severity | Warning |
| Rule system | Syntax |
| Rules | 31 |
OpenAPI Info
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L050 | no-trailing-leading-spaces-in-info-description | Warning | Description of an Info Object should not contain any leading or trailing white-space characters. |
OpenAPI Servers
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L150 | no-trailing-leading-spaces-in-environment-description | Warning | Description of an environment object should not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L151 | no-trailing-leading-spaces-in-server-description | Warning | Description of an server object should not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L152 | no-trailing-leading-spaces-in-server-variable-description | Warning | Description of a server variable object should not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L153 | no-trailing-leading-spaces-in-server-parameter-description | Warning | Description of a server parameter object should not contain any leading or trailing white-space characters. |
OpenAPI Path Items
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L240 | no-trailing-leading-spaces-in-path-item-description | Warning | Description of an Path Item Object should not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L241 | no-trailing-leading-spaces-in-path-item-summary | Warning | Summary of an Path Item Object should not contain any leading or trailing white-space characters. |
OpenAPI Operations
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L300 | no-trailing-leading-spaces-in-operation-description | Warning | Description of an Operation Object should not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L301 | no-trailing-leading-spaces-in-operation-summary | Warning | Operation Object summary should not contain any leading or trailing white-space characters. |
OpenAPI Operation Test Cases
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L350 | no-trailing-leading-spaces-in-test-case-description | Warning | Description of an Unit Test Object should not contain any leading or trailing white-space characters. |
OpenAPI External Documentation
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L360 | no-trailing-leading-spaces-in-external-documentation-description | Warning | Description of an external documentation object should not contain any leading or trailing white-space characters. |
OpenAPI Parameters
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L380 | no-trailing-leading-spaces-in-parameter-description | Warning | Description of a Parameter Object must not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L381 | no-trailing-leading-spaces-in-parameter-example | Warning | Parameter Object example should not contain any leading or trailing white-space characters. |
OpenAPI Request Body
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L430 | no-trailing-leading-spaces-in-request-body-description | Warning | Description of a request body object should not contain any leading or trailing white-space characters. |
OpenAPI Media Types
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L460 | no-trailing-leading-spaces-in-media-type-example | Warning | Media type example should not contain any leading or trailing white-space characters. |
OpenAPI Responses
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L520 | no-trailing-leading-spaces-in-response-description | Warning | Description of an Response Object should not contain any leading or trailing white-space characters. |
OpenAPI Examples
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L590 | no-trailing-leading-spaces-in-example-description | Warning | Description of an example Object should not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L591 | no-trailing-leading-spaces-in-example-summary | Warning | Summary of an example object should not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L592 | no-trailing-leading-spaces-in-example-value | Warning | An example value should not contain any leading or trailing white-space characters. |
OpenAPI Links
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L640 | no-trailing-leading-spaces-in-link-description | Warning | Description of Link Object should not contain any leading or trailing white-space characters. |
OpenAPI Headers
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L660 | no-trailing-leading-spaces-in-header-description | Warning | Description of Header Object should not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L661 | no-trailing-leading-spaces-in-header-example | Warning | Header object example should not contain any leading or trailing white-space characters. |
OpenAPI Tags
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L710 | no-trailing-leading-spaces-in-tag-description | Warning | Description of Tag Object should not contain any leading or trailing white-space characters. |
OpenAPI Schemas
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L750 | no-trailing-leading-spaces-in-schema-description | Warning | Description of Schema Object should not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L751 | no-trailing-leading-spaces-in-one-of-cases-meta-description | Warning | Description of Schema oneOf cases meta extension should not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L752 | no-trailing-leading-spaces-in-any-of-cases-meta-description | Warning | Description of Schema anyOf cases meta extension should not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L753 | no-trailing-leading-spaces-in-schema-example | Warning | Schema Object example should not contain any leading or trailing white-space characters. |
OpenAPI Security Schemes
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L840 | no-trailing-leading-spaces-in-security-scheme-description | Warning | Security Scheme description should not contain any leading or trailing white-space characters. |
OPENAPI3DOCSGENSYNTAX_L841 | no-trailing-leading-spaces-in-additional-header-description | Warning | Additional header description should not contain any leading or trailing white-space characters. |
OpenAPI OAuth 2.0 Flows
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L870 | no-trailing-leading-spaces-in-oauth-flow-scope-description | Warning | Scope value of an OAuth Flow Object should not contain any leading or trailing white-space characters. |
OpenAPI Security Requirements
| Code | Rule | Severity | What it checks |
|---|---|---|---|
OPENAPI3DOCSGENSYNTAX_L880 | no-trailing-leading-spaces-in-security-options-meta-description | Warning | Security Options Meta description should not contain any leading or trailing white-space characters. |
Learn more
OpenAPI v3 Linting for APIMatic Portal Generation
Linting checks performed by APIMatic on provided OpenAPI v3 file to check its conformance to recommended practices for a more user-friendly API documentation.
OpenAPI v3 Linting for Agentic Tools
Linting checks APIMatic performs on OpenAPI v3 files to make sure they follow practices that improve the output of agentic tools and the overall clarity of the API.