parameter-set.schema.json

{
  "$id": "https://porter.sh/schema/v1/parameter-set.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "valueMapping": {
      "description": "Defines the source for a value",
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the mapped value",
          "type": "string"
        },
        "source": {
          "description": "Location where the value should be retrieved",
          "type": "object",
          "properties": {
            "command": {
              "description": "Command that should be executed on the host, using the output returned from the command as the value",
              "type": "string"
            },
            "env": {
              "description": "Name of the environment variable on the host that contains the value",
              "type": "string"
            },
            "path": {
              "description": "Path to a file on the host that contains the value",
              "type": "string"
            },
            "secret": {
              "description": "Name of a secret in a secret store that contains the value",
              "type": "string"
            },
            "value": {
              "description": "Hard-coded value",
              "type": ["string", "number", "object", "array", "boolean"]
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": false,
      "required": ["name", "source"]
    }
  },
  "properties": {
    "name": {
      "description": "The name of the parameter set.",
      "type": "string"
    },
    "namespace": {
      "description": "The namespace in which the parameter set is defined.",
      "type": "string"
    },
    "created": {
      "description": "The date created, as an ISO-8601 Extended Format date string, as specified in the ECMAScript standard",
      "type": "string"
    },
    "modified": {
      "description": "The date modified, as an ISO-8601 Extended Format date string, as specified in the ECMAScript standard",
      "type": "string"
    },
    "labels": {
      "description": "Set of labels associated with the parameter set.",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "parameters": {
      "description": "Mappings of parameter names to their source value", 
      "type": "array",
      "items": {
        "$ref": "#/definitions/valueMapping"
      }
    },
    "custom": {
      "$comment": "reserved for custom extensions",
      "type": "object",
      "additionalProperties": true
    },
    "schemaType": {
      "description": "The resource type of the current document.",
      "type": "string",
      "default": "ParameterSet"
    },
    "schemaVersion": {
      "description": "Version of the parameter set schema to which this document adheres",
      "type": "string",
      "default": "1.1.0"
    }
  },
  "required": [
    "name",
    "parameters",
    "schemaVersion"
  ],
  "title": "Parameter Set json schema",
  "type": "object",
  "additionalProperties": false
}