Inspectopedia Help

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.

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

Inspection Details

Available in:

GoLand 2023.3, IntelliJ IDEA 2023.3, JetBrains Rider 2023.1, PhpStorm 2023.3, PyCharm 2023.3, Qodana for .NET 2023.1, Qodana for JS 2023.3, Qodana for JVM 2023.3, Qodana for PHP 2023.3, WebStorm 2023.3


OpenAPI Specifications, 233.SNAPSHOT

Last modified: 13 July 2023