UEidentityAPI.json 9.01 KB
Newer Older
1
{
Walter Featherstone's avatar
Walter Featherstone committed
2
  "openapi": "3.0.2",
3
4
  "info": {
    "title": "UE Identity API",
Walter Featherstone's avatar
Walter Featherstone committed
5
6
    "version": "1.1.1",
    "description": "The ETSI MEC ISG MEC014 UE Identity API described using OpenAPI",
7
8
9
    "license": {
      "name": "ETSI Forge copyright notice",
      "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
Walter Featherstone's avatar
Walter Featherstone committed
10
11
12
    },
    "contact": {
      "email": "cti_support@etsi.org"
13
14
15
    }
  },
  "externalDocs": {
16
17
    "description": "ETSI GS MEC014 UE Identity API, V1.1.1",
    "url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/014/01.01.01_60/gs_mec014v010101p.pdf"
18
19
20
21
22
23
24
25
  },
  "security": [
    {
      "OauthSecurity": [
        "all"
      ]
    }
  ],
Walter Featherstone's avatar
Walter Featherstone committed
26
27
28
  "servers": [
    {
      "url": "http://127.0.0.1:8081/ui/v1"
29
    },
Walter Featherstone's avatar
Walter Featherstone committed
30
31
    {
      "url": "https://127.0.0.1:8081/ui/v1"
32
    }
Walter Featherstone's avatar
Walter Featherstone committed
33
34
35
36
37
38
  ],
  "tags": [
    {
      "name": "ueIdentityTagInfo"
    }
  ],
39
  "paths": {
40
41
42
    "/{appInstanceId}/ue_identity_tag_info": {
      "parameters": [
        {
Walter Featherstone's avatar
Walter Featherstone committed
43
          "$ref": "#/components/parameters/Path.AppInstanceId"
44
45
        }
      ],
46
      "get": {
47
        "description": "Retrieves information about a specific UeIdentityTagInfo resource",
Walter Featherstone's avatar
Walter Featherstone committed
48
49
50
        "operationId": "UeIdentityTagInfo_GET",
        "tags": [
          "ueIdentityTagInfo"
51
52
53
        ],
        "parameters": [
          {
Walter Featherstone's avatar
Walter Featherstone committed
54
            "$ref": "#/components/parameters/Query.UeIdentityTag"
55
56
57
58
          }
        ],
        "responses": {
          "200": {
59
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the UeIdentityTagInfo resource.",
Walter Featherstone's avatar
Walter Featherstone committed
60
61
62
63
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UeIdentityTagInfo"
64
65
                }
              }
66
            }
67
68
          },
          "400": {
Walter Featherstone's avatar
Walter Featherstone committed
69
            "$ref": "#/components/responses/Error.400"
70
71
          },
          "403": {
Walter Featherstone's avatar
Walter Featherstone committed
72
            "$ref": "#/components/responses/Error.403"
73
74
          },
          "404": {
Walter Featherstone's avatar
Walter Featherstone committed
75
            "$ref": "#/components/responses/Error.404"
76
          }
77
        }
78
79
      },
      "put": {
80
        "description": "Register/De-register the information about specific a UeIdentityTagInfo resource",
Walter Featherstone's avatar
Walter Featherstone committed
81
82
83
        "operationId": "UeIdentityTagInfo_PUT",
        "tags": [
          "ueIdentityTagInfo"
84
        ],
Walter Featherstone's avatar
Walter Featherstone committed
85
86
87
88
89
90
91
92
93
94
95
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UeIdentityTagInfo"
              }
            }
          },
          "description": "'The updated \"state\" for each included UE Identity tag is included in the entity body of the request'",
          "required": true
        },
96
97
        "responses": {
          "200": {
98
            "description": "It is used to indicate success. The response body contains a representation of the UeIdentityTagInfo resource",
Walter Featherstone's avatar
Walter Featherstone committed
99
100
101
102
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UeIdentityTagInfo"
103
                }
104
              }
105
            }
106
107
          },
          "400": {
Walter Featherstone's avatar
Walter Featherstone committed
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
            "$ref": "#/components/responses/Error.400"
          },
          "403": {
            "$ref": "#/components/responses/Error.403"
          },
          "404": {
            "$ref": "#/components/responses/Error.404"
          },
          "412": {
            "$ref": "#/components/responses/Error.412"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "Path.AppInstanceId": {
        "name": "appInstanceId",
        "in": "path",
        "description": "Represents a mobile edge application instance",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "Query.UeIdentityTag": {
        "name": "ueIdentityTag",
        "in": "query",
        "description": "Represents a UE",
        "required": true,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "responses": {
      "Error.400": {
        "description": "Bad Request. Incorrect parameters were passed in the request.In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
        "content": {
          "application/problem+json": {
152
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
153
              "$ref": "#/components/schemas/ProblemDetails"
154
            }
155
          },
Walter Featherstone's avatar
Walter Featherstone committed
156
          "text/plain": {
157
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
158
              "$ref": "#/components/schemas/Empty"
159
            }
Walter Featherstone's avatar
Walter Featherstone committed
160
161
162
163
164
165
166
          }
        }
      },
      "Error.403": {
        "description": "Forbidden. The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
        "content": {
          "application/problem+json": {
167
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
168
              "$ref": "#/components/schemas/ProblemDetails"
169
            }
Walter Featherstone's avatar
Walter Featherstone committed
170
171
172
173
174
175
176
          }
        }
      },
      "Error.404": {
        "description": "Not Found. The client provided a URI that cannot be mapped to a valid resource URL. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
        "content": {
          "application/problem+json": {
177
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
178
              "$ref": "#/components/schemas/ProblemDetails"
179
            }
180
          },
Walter Featherstone's avatar
Walter Featherstone committed
181
          "text/plain": {
182
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
183
              "$ref": "#/components/schemas/Empty"
184
185
186
            }
          }
        }
Walter Featherstone's avatar
Walter Featherstone committed
187
188
189
190
191
192
193
194
195
196
197
198
199
200
      },
      "Error.412": {
        "description": "Precondition Failed. It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts.In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          },
          "text/plain": {
            "schema": {
              "$ref": "#/components/schemas/Empty"
            }
          }
201
202
203
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
204
205
206
207
208
209
210
211
212
213
    "securitySchemes": {
      "OauthSecurity": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://oauth.exampleAPI/token",
            "scopes": {
              "all": "Single oauth2 scope for API"
            }
          }
214
215
216
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
    "schemas": {
      "Empty": {
        "description": "Empty schema"
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "$ref": "#/components/schemas/Problem.type"
          },
          "title": {
            "$ref": "#/components/schemas/Problem.title"
          },
          "status": {
            "$ref": "#/components/schemas/Problem.status"
          },
          "detail": {
            "$ref": "#/components/schemas/Problem.detail"
          },
          "instance": {
            "$ref": "#/components/schemas/Problem.instance"
          }
        }
      },
      "Problem.type": {
        "type": "string",
        "format": "uri",
        "description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
      },
      "Problem.title": {
        "type": "string",
        "description": "A short, human-readable summary of the problem type"
      },
      "Problem.status": {
        "type": "integer",
        "format": "uint32",
        "description": "The HTTP status code for this occurrence of the problem"
      },
      "Problem.detail": {
        "type": "string",
        "description": "A human-readable explanation specific to this occurrence of the problem"
      },
      "Problem.instance": {
        "type": "string",
        "format": "uri",
        "description": "A URI reference that identifies the specific occurrence of the problem"
      },
      "UeIdentityTagInfo": {
        "description": "information of UE identity tag used in UE Identity feature",
        "type": "object",
267
        "required": [
Walter Featherstone's avatar
Walter Featherstone committed
268
          "ueIdentityTags"
269
270
        ],
        "properties": {
Walter Featherstone's avatar
Walter Featherstone committed
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
          "ueIdentityTags": {
            "$ref": "#/components/schemas/UeIdentityTags"
          }
        }
      },
      "UeIdentityTags": {
        "description": "1 to N tags presented by a ME Application instance to a ME Platform",
        "type": "array",
        "items": {
          "required": [
            "ueIdentityTag",
            "state"
          ],
          "properties": {
            "ueIdentityTag": {
              "$ref": "#/components/schemas/UeIdentityTag"
            },
            "state": {
              "$ref": "#/components/schemas/State"
            }
291
          }
292
        }
Walter Featherstone's avatar
Walter Featherstone committed
293
294
295
296
297
298
299
300
301
302
303
304
305
306
      },
      "UeIdentityTag": {
        "description": "Specific tag presented by a ME Application instance to a ME Platform",
        "type": "string",
        "example": "UeTagA"
      },
      "State": {
        "description": "Status of the resource ueIdentityTagInfo",
        "type": "string",
        "enum": [
          "UNREGISTERED",
          "REGISTERED"
        ],
        "example": "REGISTERED"
307
      }
308
    }
309
310
  }
}