Code Inspections in OpenAPI specifications
This topic lists all JetBrains Rider code inspections available in OpenAPI specifications.
You can toggle specific inspections or change their severity level on the Editor | Inspection Settings | Inspection Severity | Other Languages page of the IDE settings Ctrl+Alt+S.
Inspection | Description | Default Severity |
|---|---|---|
Possible OpenAPI/Swagger specification candidate | Detects JSON 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.json#/components/schemas/CommonSchema'
Specification file candidate `common.components.json`:
{
"components": { # 'Mark file as OpenAPI specification' highlighting
"schemas": {
"CommonSchema": {
"description": "Common schema object reused in several specifications"
}
}
}
}
| |
Unresolved reference | Detects unresolved references in Yaml specification files. |
