System

Describe the policy language spec implemented by this service.

Changed on

Get the policy language spec for this service

get/system/policy_spec

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /system/policy_spec
  • Auth: none declared

Response

Policy Language Description

namestring

Gate name, as it would appear in a policy document

descriptionstring

Description of the gate

state'active' | 'deprecated' | 'eol'

State of the gate and transitively all triggers it contains if not 'active'

superceded_bystring nullable

The name of another trigger that supercedes this on functionally if this is deprecated

Example response

[
  {
    "name": "name",
    "description": "description",
    "superceded_by": "superceded_by",
    "state": "active",
    "triggers": [
      {
        "name": "name",
        "description": "description",
        "superceded_by": "superceded_by",
        "state": "active",
        "parameters": [
          {
            "name": "name",
            "validator": "{}",
            "description": "description",
            "superceded_by": "superceded_by",
            "state": "active",
            "required": true,
            "example": "example"
          },
          {
            "name": "name",
            "validator": "{}",
            "description": "description",
            "superceded_by": "superceded_by",
            "state": "active",
            "required": true,
            "example": "example"
          }
        ]
      },
      {
        "name": "name",
        "description": "description",
        "superceded_by": "superceded_by",
        "state": "active",
        "parameters": [
          {
            "name": "name",
            "validator": "{}",
            "description": "description",
            "superceded_by": "superceded_by",
            "state": "active",
            "required": true,
            "example": "example"
          },
          {
            "name": "name",
            "validator": "{}",
            "description": "description",
            "superceded_by": "superceded_by",
            "state": "active",
            "required": true,
            "example": "example"
          }
        ]
      }
    ]
  }
]

Changes