Possible OpenAPI/Swagger specification candidate
Detects YAML files that can be interpreted as a part of OpenAPI/Swagger specification.
Such files do not contain explicit specification attributes, but they are referenced from primary specification files located nearby.
Locating this inspection
- By ID
Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.
SwYamlMaybeSpecificationInspection- Via Settings dialog
Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.
The following example contains two files located in the same directory. First one is a plain primary specification file. Second is referenced from the first one and thus is suggested to be considered a specification too.
Primary specification file openapi.yaml:
Specification file candidate common.components.yaml:
Inspection ID: SwYamlMaybeSpecificationInspection
Suppressing Inspection
You can suppress this inspection by placing the following comment marker before the code fragment where you no longer want messages from this inspection to appear:
More detailed instructions as well as other ways and options that you have can be found in the product documentation:
Inspection Details | |
|---|---|
By default bundled with: | GoLand 2025.2, IntelliJ IDEA 2025.2, JetBrains Rider 2025.2, PhpStorm 2025.2, PyCharm 2025.2, Qodana for .NET 2025.2, Qodana for Go 2025.2, Qodana for JS 2025.2, Qodana for JVM 2025.2, Qodana for PHP 2025.2, WebStorm 2025.2 |