action anchore_describe_policy {
  label: "Describe the policy language spec implemented by this service."
  description: "Get the policy language spec for this service"
  provider: anchore
  method: GET
  path: "/system/policy_spec"
  encoding: json
  output: {
    type: "array"
    description: "List of Gate specifications"
    items: {
      type: "object"
      description: "A description of the set of gates available in this engine and the triggers and parameters supported"
      properties: {
        description: {
          type: "string"
          description: "Description of the gate"
        }
        name: {
          type: "string"
          description: "Gate name, as it would appear in a policy document"
        }
        state: {
          type: "string"
          description: "State of the gate and transitively all triggers it contains if not 'active'"
          enum: ["active", "deprecated", "eol"]
        }
        superceded_by: {
          type: "string"
          description: "The name of another trigger that supercedes this on functionally if this is deprecated"
        }
        triggers: {
          type: "array"
          description: "List of the triggers that can fire for this Gate"
          items: {
            type: "object"
            description: "Definition of a trigger and its parameters"
            properties: {
              description: {
                type: "string"
                description: "Trigger description for what it tests and when it will fire during evaluation"
              }
              name: {
                type: "string"
                description: "Name of the trigger as it would appear in a policy document"
              }
              parameters: {
                type: "array"
                description: "The list of parameters that are valid for this trigger"
                items: {
                  type: "object"
                  properties: {
                    description: {
                      type: "string"
                    }
                    example: {
                      type: "string"
                      description: "An example value for the parameter (encoded as a string if the parameter is an object or list type)"
                    }
                    name: {
                      type: "string"
                      description: "Parameter name as it appears in policy document"
                    }
                    required: {
                      type: "boolean"
                      description: "Is this a required parameter or optional"
                    }
                    state: {
                      type: "string"
                      description: "State of the trigger parameter"
                      enum: ["active", "deprecated", "eol"]
                    }
                    superceded_by: {
                      type: "string"
                      description: "The name of another trigger that supercedes this on functionally if this is deprecated"
                    }
                    validator: {
                      type: "object"
                      description: "If present, a definition for validation of input. Typically a jsonschema object that can be used to validate an input against."
                    }
                  }
                }
              }
              state: {
                type: "string"
                description: "State of the trigger"
                enum: ["active", "deprecated", "eol"]
              }
              superceded_by: {
                type: "string"
                description: "The name of another trigger that supercedes this on functionally if this is deprecated"
              }
            }
          }
        }
      }
    }
  }
}