OpenAPI v3 Syntax Linting for APIMatic Code Generation
Linting checks performed by APIMatic on provided OpenAPI v3 file to check its conformance to recommended syntax practices for better code generation experience.
For successful Code Generation, the title must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters.
For successful Code Generation, the environment name must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters. Environment Names are often used for naming the files generated as part of the code generation process, so, any forbidden file name characters are not allowed.
OPENAPI3CODEGENSYNTAX_L091
valid-server-name
Error
For successful Code Generation, the server name must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters. Names are often used for naming the files generated as part of the code generation process, so, any forbidden file name characters are not allowed.
OPENAPI3CODEGENSYNTAX_L092
valid-server-variables-key
Error
For successful Code Generation, the server variables key must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters.
OPENAPI3CODEGENSYNTAX_L093
valid-server-parameter-name
Error
For successful Code Generation, the server parameter name must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters. Names are often used for naming the files generated as part of the code generation process, so, any forbidden file name characters are not allowed.
For successful Code Generation, the Schema Component key must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters.
For successful Code Generation, the path item level parameter name must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters. Names are often used for naming the files generated as part of the code generation process, so, any forbidden file name characters are not allowed.
The id of an Operation Object specified using the operationId property is a unique identifier of the operation in the complete API document. This id is used by the code generation engine to generate relevant components tied to an endpoint. Therefore, the id must be short and code-friendly. The id must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters. Names are often used for naming the files generated as part of the code generation process, so, any forbidden file name characters are not allowed either.
OPENAPI3CODEGENSYNTAX_L191
valid-operation-summary
Error
For successful Code Generation, the operation summary must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters.
OPENAPI3CODEGENSYNTAX_L192
valid-operation-parameter-name
Error
For successful Code Generation, the operation level parameter name must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters. Names are often used for naming the files generated as part of the code generation process, so, any forbidden file name characters are not allowed.
For successful Code Generation, the test case name must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters.
OPENAPI3CODEGENSYNTAX_L341
no-trailing-leading-spaces-in-test-case-name
Warning
The test case's name should not contain any leading or trailing white-space characters.'
OPENAPI3CODEGENSYNTAX_L342
test-case-request-uri-begins-with-forward-slash
Error
The request URI for unit test cases specified under operation object must begin with a forward slash.
For successful Code Generation, the schema title must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters.
OPENAPI3CODEGENSYNTAX_L611
valid-schema-properties-key
Error
For successful Code Generation, the schema property keys must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters.
OPENAPI3CODEGENSYNTAX_L612
valid-schema-enum-element-name
Error
For successful Code Generation, the enum item name must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters.
For successful Code Generation, the name of the ApiKey Security Scheme must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters.
OPENAPI3CODEGENSYNTAX_L741
valid-additional-header-name
Error
For successful Code Generation, the name of the additional header must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters.
