summaryrefslogtreecommitdiffstats
path: root/ucs2-interface/ucs_api_def.json
blob: 9b998432994c8d6fd93af15f1fc557a931c343cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
{
  "openapi": "3.0.0",
  "info": {
    "description": "",
    "title": "monitor",
    "version": "1.0",
    "x-binding-c-generator": {
      "api": "monitor",
      "version": 2,
      "prefix": "f_",
      "postfix": "",
      "preinit": null,
      "init": null,
      "onevent": null,
      "scope": "static",
      "private": true
    }
  },
  "servers": [
    {
      "url": "ws://{host}:{port}/api/monitor",
      "description": "The API server.",
      "variables": {
        "host": {
          "default": "localhost"
        },
        "port": {
          "default": "1234"
        }
      },
      "x-afb-events": [
        {
          "$ref": "#/components/schemas/afb-event"
        }
      ]
    }
  ],
  "components": {
    "schemas": {
      "afb-reply": {
        "$ref": "#/components/schemas/afb-reply-v1"
      },
      "afb-event": {
        "$ref": "#/components/schemas/afb-event-v1"
      },
      "afb-reply-v1": {
        "title": "Generic response.",
        "type": "object",
        "required": [ "jtype", "request" ],
        "properties": {
          "jtype": {
            "type": "string",
            "const": "afb-reply"
          },
          "request": {
            "type": "object",
            "required": [ "status" ],
            "properties": {
              "status": { "type": "string" },
              "info": { "type": "string" },
              "token": { "type": "string" },
              "uuid": { "type": "string" },
              "reqid": { "type": "string" }
            }
          },
          "response": { "type": "object" }
        }
      },
      "afb-event-v1": {
        "type": "object",
        "required": [ "jtype", "event" ],
        "properties": {
          "jtype": {
            "type": "string",
            "const": "afb-event"
          },
          "event": { "type": "string" },
          "data": { "type": "object" }
        }
      },
      "set-verbosity": {
        "anyOf": [
          { "$ref": "#/components/schemas/verbosity-map" },
          { "$ref": "#/components/schemas/verbosity-level" }
        ]
      },
      "get-request": {
        "type": "object",
        "properties": {
          "verbosity": { "$ref": "#/components/schemas/get-verbosity" },
          "apis": { "$ref": "#/components/schemas/get-apis" }
        }
      },
      "get-response": {
        "type": "object",
        "properties": {
          "verbosity": { "$ref": "#/components/schemas/verbosity-map" },
          "apis": { "type": "object" }
        }
      },
      "get-verbosity": {
        "anyOf": [
          { "type": "boolean" },
          { "type": "array", "items": { "type": "string" } },
          { "type": "object" }
        ]
      },
      "get-apis": {
        "anyOf": [
          { "type": "boolean" },
          { "type": "array", "items": { "type": "string" } },
          { "type": "object" }
        ]
      },
      "verbosity-map": {
        "type": "object",
        "patternProperties": { "^.*$": { "$ref": "#/components/schemas/verbosity-level" } }
      },
      "verbosity-level": {
        "enum": [ "debug", 3, "info", 2, "notice", "warning", 1, "error", 0 ]
      }
    },
    "x-permissions": {
        "set": {
          "permission": "urn:AGL:permission:monitor:public:set"
        },
        "get": {
          "permission": "urn:AGL:permission:monitor:public:get"
        },
        "get-or-set": {
          "anyOf": [
            { "$ref": "#/components/x-permissions/get" },
            { "$ref": "#/components/x-permissions/set" }
          ]
        }
    }
  },
  "paths": {
    "/get": {
      "description": "Get monitoring data.",
      "get": {
        "x-permissions": {
          "$ref": "#/components/x-permissions/get-or-set"
        },
        "parameters": [
          {
            "in": "query",
            "name": "verbosity",
            "required": false,
            "schema": { "$ref": "#/components/schemas/get-verbosity" }
          },
          {
            "in": "query",
            "name": "apis",
            "required": false,
            "schema": { "$ref": "#/components/schemas/get-apis" }
          }
        ],
        "responses": {
          "200": {
            "description": "A complex object array response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/afb-reply"
                }
              }
            }
          }
        }
      }
    },
    "/set": {
      "description": "Set monitoring actions.",
      "get": {
        "x-permissions": {
          "$ref": "#/components/x-permissions/set"
        },
        "parameters": [
          {
            "in": "query",
            "name": "verbosity",
            "required": false,
            "schema": { "$ref": "#/components/schemas/set-verbosity" }
          }
        ],
        "responses": {
          "200": {
            "description": "A complex object array response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/afb-reply"
                }
              }
            }
          }
        }
      }
    }
  }
}