environment_classes.json

{
  "$schema":     "http://json-schema.org/draft-04/schema#",
  "title":       "Environment Classes",
  "description": "Information about the classes in a Puppet code environment",
  "type":        "object",
  "properties": {
    "files": {
      "description": "The array of manifest files which exist in an environment.  Even files that do not contain any classes will appear in the array.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "description": "Fully-qualified path on the server to the manifest",
            "type": "string"
          },
          "classes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "description": "Name of the class.  For example, if the class were defined as 'class myclass', the name would be 'myclass'.",
                  "type": "string"
                },
                "params": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "description": "Name of the class parameter.  For example, if a class parameter were defined as 'String $my_param', the name would be 'my_param'.",
                        "type": "string"
                      },
                      "type": {
                        "description": "Data type, if defined, for the class parameter.  For example, if a class parameter were defined as 'String $my_param', the data type would be 'String'.  See https://docs.puppetlabs.com/puppet/latest/reference/lang_data.html for information on the available data types.",
                        "type": "string"
                      },
                      "default_source": {
                        "description": "Source text for the default value, if defined, for the class parameter.  For example, if a class parameter were defined in the manifest as 'String $my_param = \"my value\"', the default_source would be '\"my value\"' where \" would appear literally in the text.  Note that no expressions in the default value - for example, references to other variables - are expanded.  The text for default_source matches the exact content in the parsed manifest.",
                        "type": "string"
                      },
                      "default_literal": {
                        "description": "Literal representation of the default value, if defined, for the class parameter.  This member is only present if the value can be expressed using primitive JSON data types.  For example, if a class parameter were defined in the manifest as 'Integer $my_integer = 3', the default_literal would be a JSON number whereas the corresponding default_source would be a JSON string containing '3'.  The default_literal would be omitted for the following cases: 1) The primitive Puppet value has no direct translation into a JSON primitive type (for example, a regular expression, default, or undef).  2) The value contains a Puppet hash - either top-level or nested under another array or hash - with at least one key that is not a string.  3) The value contains one or more expressions that would have to be evaluated at catalog compilation time in order for the actual default value to be determined.  See https://docs.puppetlabs.com/puppet/latest/reference/lang_data.html for information on the available data types and values."
                      }
                    },
                    "required": ["name"],
                    "additionalProperties": false
                  }
                }
              },
              "required": ["name", "params"],
              "additionalProperties": false
            }
          },
          "error": {
            "description": "If an error was encountered during manifest parsing, this member will be present instead of 'classes'.  The error string provides details about the specific error.",
            "type": "string"
          }
        },
        "required": ["path"],
        "oneOf": [
          {"required": ["classes"]},
          {"required": ["error"]}
        ],
        "additionalProperties": false
      }
    },
    "name": {
      "description": "Name of the environment",
      "type": "string"
    }
  },
  "required": ["files", "name"],
  "additionalProperties": false
}