List archives

v1.0.0

List configuration archives

Input

{
  "type": "object",
  "properties": {
    "archiveKind": {
      "type": "string",
      "enum": [
        "full",
        "groups",
        "rules",
        "directives",
        "parameters"
      ]
    }
  },
  "required": [
    "archiveKind"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "action",
    "data",
    "result"
  ],
  "properties": {
    "action": {
      "type": "string",
      "description": "The kind of the archive",
      "enum": [
        "archiveFull",
        "archiveGroups",
        "archiveRules",
        "archiveDirectives",
        "archiveParameters"
      ]
    },
    "data": {
      "type": "object",
      "required": [
        "full"
      ],
      "properties": {
        "full": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "commiter",
              "gitCommit",
              "id"
            ],
            "properties": {
              "commiter": {
                "type": "string"
              },
              "gitCommit": {
                "type": "string",
                "format": "hash"
              },
              "id": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "result": {
      "type": "string",
      "description": "Result of the request",
      "enum": [
        "success",
        "error"
      ]
    }
  }
}