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.

Settings or Preferences | Editor | Inspections | OpenAPI specifications

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:

openapi: 3.1.0
components:
  schemas:
    CustomSchema:
      description: Custom schema object
      properties:
        foo:
          $ref: 'common.components.yaml#/components/schemas/CommonSchema'

Specification file candidate common.components.yaml:

components: # 'Mark file as OpenAPI specification' highlighting
  schemas:
    CommonSchema:
      description: Common schema object reused in several specifications

Availability

By default bundled with: GoLand 2024.1, IntelliJ IDEA 2024.1, JetBrains Rider 2023.3, PhpStorm 2024.1, PyCharm 2024.1, Qodana for .NET 2023.3, Qodana for Go 2024.1, Qodana for JS 2024.1, Qodana for JVM 2024.1, Qodana for PHP 2024.1, WebStorm 2024.1
Can be installed with plugin: OpenAPI Specifications, 241.18072

Last modified: 18 June 2024