aboutsummaryrefslogtreecommitdiffstats
path: root/src/vshl-core-apidef.json
blob: 0079dfdd138ff7338dd307cb1bc2904a13063943 (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
{
  "openapi": "3.0.0",
  "$schema": "http://iot.bzh/download/openapi/schema-3.0/default-schema.json",
  "info": {
    "description": "",
    "title": "High Level Voice Service Core API",
    "version": "1.0",
    "x-binding-c-generator": {
      "api": "vshl-core",
      "version": 3,
      "prefix": "afv_",
      "postfix": "",
      "start": null,
      "onevent": null,
      "init": "init",
      "scope": "",
      "private": false,
      "noconcurrency": true
    }
  },
  "servers": [{
    "url": "ws://{host}:{port}/api/monitor",
    "description": "TS caching binding",
    "variables": {
      "host": {
        "default": "localhost"
      },
      "port": {
        "default": "1234"
      }
    },
    "x-afb-events": [{
      "$ref": "#/components/schemas/afb-event"
    }]
  }],
  "components": {
    "schemas": {
      "afb-reply": {
        "$ref": "#/components/schemas/afb-reply-v3"
      },
      "afb-event": {
        "$ref": "#/components/schemas/afb-event-v3"
      },
      "afb-reply-v3": {
        "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-v3": {
        "type": "object",
        "required": ["jtype", "event"],
        "properties": {
          "jtype": {
            "type": "string",
            "const": "afb-event"
          },
          "event": {
            "type": "string"
          },
          "data": {
            "type": "object"
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "A complex object array response",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/afb-reply"
            }
          }
        }
      }
    }
  }
}