The environment name should not contain any leading or trailing white-space characters.
OPENAPI3APIMATICSYNTAX_L101
no-trailing-leading-spaces-in-server-name
Warning
The name of the server should not contain any leading or trailing white-space characters.
OPENAPI3APIMATICSYNTAX_L102
no-server-url-trailing-slash
Warning
Some tooling forgets to strip trailing slashes off when it's joining the servers.url with paths, and you can get awkward URLs like https://example.com/api//pets. Best to just strip them off yourself.
Keep trailing slashes off of paths, as it can cause some confusion. Some web tooling (like mock servers, real servers, code generators, application frameworks, etc.) will treat example.com/foo and example.com/foo/ as the same thing, but other tooling will not. Avoid any confusion by just documenting them without the slash, and maybe some tooling will let people shove a / on there when they're using it or maybe not, but at least the docs are suggesting how it should be done properly.
In OpenAPI specifications, path parameters are defined by enclosing the parameter name in curly braces {} within the URL path. This rule enforces the requirement that path parameter declarations cannot be empty, as an empty path parameter declaration does not provide any useful information about the parameter.
The name of a parameter should not contain any leading or trailing white-space characters.
OPENAPI3APIMATICSYNTAX_L331
valid-rfc-6570-parameter-Name
Warning (disabled)
The OpenAPI specification uses parameter names to identify parameters in various parts of the API, such as path, query, header, and cookie parameters. To ensure interoperability and consistency across API implementations, this rule enforces the requirement that parameter names must follow the URI template syntax specified in RFC6570.
OPENAPI3APIMATICSYNTAX_L332
valid-boolean-parameter-name
Warning (disabled)
Name fields of parameters with type boolean should have a is, has or can prefix. You can specify different prefixes.
The keys of a schema properties should not contain any leading or trailing white-space characters.
OPENAPI3APIMATICSYNTAX_L662
valid-schema-enum-item-type
Error
Each item within the enum list should match the expected schema type. In case an item does not conform to the specified type, it may lead to unexpected behavior or errors when consuming the API.
