github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/resources/schemas/README.md (about)

     1  # JSON Schema
     2  
     3  The `metadata.json` file is a JSON schema for the step metadata located in [resource/metadata](../metadata).
     4  
     5  ## Usage
     6  
     7  The file can be used with any YAML schema validator.
     8  
     9  ### VSCode
    10  
    11  To use the schema in VSCode, install the [vscode-yaml](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) extension to gain schema support for your `yaml` files.
    12  Add the following code to your `.vscode/settings.json` file in the jenkins-library project:
    13  
    14  ```json
    15  {
    16      "yaml.schemas": {
    17          "./resources/schemas/metadata.json": "resources/metadata/*.yaml"
    18      }
    19  }
    20  ```