aether-roc-api/api/aether-app-gtwy-openapi3.yaml at master · onosproject/aether-roc-api · GitHub

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
# SPDX-FileCopyrightText: 2021-present Open Networking Foundation <info@opennetworking.org>
#
# SPDX-License-Identifier: Apache-2.0
info:
  contact:
    email: info@opennetworking.org
    name: Open Networking Foundation
    url: https://opennetworking.org
  description: "## Background\n\nThe Aether Application Gateway (AG) API provides a unified API for both control and metrics of the Aether platform.\nThe AG is device and application focused, enabling the application developer to implement intelligent control of Aether 4G/5G connectivity services, while abstracting some low-level intricacies of 4G/5G.\n"
  license:
    name: Apache-2.0
    url: http://www.apache.org/licenses/LICENSE-2.0
  title: Aether Application Gateway
  version: 1.0.0
openapi: 3.0.0

paths:
  /appgtwy/v1/{target}/enterprises/{enterprise-id}/sites/{site-id}/devices:
    get:
      operationId: getDevices
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App_Gtwy_Devices'
          description: GET OK 200
      summary: GET /enterprises/{enterprise-id}/site/{site-id}/devices
      tags:
        - ""
    parameters:
      - $ref: '#/components/parameters/target'
      - content:
          text/plain; charset=utf-8:
            schema:
              type: string
        description: key {enterprise-id}
        in: path
        name: enterprise-id
        required: true
      - content:
          text/plain; charset=utf-8:
            schema:
              type: string
        description: key {site-id}
        in: path
        name: site-id
        required: true
  /appgtwy/v1/{target}/enterprises/{enterprise-id}/sites/{site-id}/devices/{device-id}:
    get:
      operationId: getDevice
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App_Gtwy_Device'
          description: GET OK 200
      summary: GET /enterprises/{enterprise-id}/sites/{site-id}/devices/{device-id}
      tags:
        - ""
    parameters:
      - $ref: '#/components/parameters/target'
      - content:
          text/plain; charset=utf-8:
            schema:
              type: string
        description: key {enterprise-id}
        in: path
        name: enterprise-id
        required: true
      - content:
          text/plain; charset=utf-8:
            schema:
              type: string
        description: key {site-id}
        in: path
        name: site-id
        required: true
      - content:
          text/plain; charset=utf-8:
            schema:
              type: string
        description: key {device-id}
        in: path
        name: device-id
        required: true
components:
  parameters:
    target:
      content:
        text/plain; charset=utf-8:
          schema:
            type: string
      description: target (device in onos-config)
      in: path
      name: target
      required: true
  schemas:
    App_Gtwy_Devices:
      description: The top level app gateway devices container
      properties:
        devices:
          description: List of app gateway devices
          items:
            $ref: '#/components/schemas/App_Gtwy_Device'
          title: ItemApp_Gtwy_Device
          type: array
          uniqueItems: true
          x-keys:
            - device-id
      title: App-Gtwy-Devices
      type: object
    App_Gtwy_Device:
      properties:
        device-id:
          description: Link to device
          title: device-id
          type: string
        display-name:
          description: display name to use in GUI or CLI
          maxLength: 80
          minLength: 1
          title: display-name
          type: string
        description:
          description: long description field
          maxLength: 1024
          minLength: 1
          title: description
          type: string
        imei: # int
          description: imei
          maxLength: 80
          minLength: 1
          title: imei
          type: string
        attached: # int
          description: attached
          maxLength: 80
          minLength: 1
          title: attached
          type: string
        ip:
          description: ip
          maxLength: 80
          minLength: 1
          title: ip
          type: string
        sim_iccid: # int
          description: attached
          maxLength: 80
          minLength: 1
          title: attached
          type: string
        device_groups:
          description: The list of device groups
          items:
            type: string
          title: device-groups
          type: array
          uniqueItems: true
      required:
        - device-id
      type: object