Deprecated YAML key

Reports deprecated keys in YAML files.

Deprecation is checked only if there exists a JSON schema associated with the corresponding YAML file.

Note that the deprecation mechanism is not defined in the JSON Schema specification yet, and this inspection uses a non-standard deprecationMessage extension.

Scheme deprecation example:

  {
    "properties": {
      "SomeDeprecatedProperty": {
        "deprecationMessage": "Baz",
        "description": "Foo bar"
      }
    }
  }

The following is an example with the corresponding warning:

SomeDeprecatedProperty: some value

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.

YAMLSchemaDeprecation

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 | YAML

Inspection Details
By default bundled with:	CLion 2024.2, DataSpell 2024.1, GoLand 2024.2, IntelliJ IDEA 2024.2, JetBrains Rider 2024.2, PhpStorm 2024.2, PyCharm 2024.2, Qodana for .NET 2024.2, Qodana for Go 2024.2, Qodana for JS 2024.2, Qodana for JVM 2024.2, Qodana for PHP 2024.2, Qodana for Ruby 2024.2, RubyMine 2024.2, WebStorm 2024.2 Writerside 2024.1
Can be installed with plugin:	YAML, 241.SNAPSHOT

Last modified: 27 August 2024