UEidentityAPI.yaml 7.5 KB
Newer Older
1
2
swagger: '2.0'
info:
3
  description: The ETSI MEC ISG MEC014 UE Identity API described using OpenAPI
4
  version: 1.1.1
5
6
  title: UE Identity API
  license:
7
8
    name: ETSI Forge copyright notice
    url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
9
externalDocs:
10
11
  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'
12
host: '127.0.0.1:8081'
13
basePath: /ui/v1
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/json
security:
  - OauthSecurity:
      - all
securityDefinitions:
  OauthSecurity:
    type: oauth2
    flow: application
    tokenUrl: 'https://oauth.exampleAPI/token'
    scopes:
      all: Single oauth2 scope for API
parameters:
  Body.UeIdentityTagInfo:
33
    name: UeIdentityTagInfo
34
    in: body
35
36
    description: >-
      'The updated "state" for each included UE Identity tag is included in the entity body of the request'
37
38
39
40
41
42
43
44
45
    required: true
    schema:
      $ref: '#/definitions/UeIdentityTagInfo'
  Path.AppInstanceId:
    name: appInstanceId
    in: path
    description: Represents a mobile edge application instance
    required: true
    type: string
46
  Query.UeIdentityTag:
47
    name: ueIdentityTag
48
    in: query
49
50
    description: Represents a UE
    required: true
51
52
53
    type: array
    items:
      type: string
54
paths:
55
56
57
  '/{appInstanceId}/ue_identity_tag_info':
    parameters:
      - $ref: '#/parameters/Path.AppInstanceId'
58
    get:
59
      description: 'Retrieves information about a specific UeIdentityTagInfo resource'
60
61
62
      produces:
        - application/json
      parameters:
63
        - $ref: '#/parameters/Query.UeIdentityTag'
64
65
66
67
      responses:
        '200':
          description: >-
            It is used to indicate nonspecific success. The response body
68
            contains a representation of the UeIdentityTagInfo resource.
69
70
          schema:
            required:
71
              - UeIdentityTagInfo
72
            properties:
73
              UeIdentityTagInfo:
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
                $ref: '#/definitions/UeIdentityTagInfo'
        '400':
          description: >-
            Incorrect parameters were passed in the request.In the returned
            ProblemDetails structure, the "detail" attribute should convey more
            information about the error.
          schema:
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: >-
            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.
          schema:
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: >-
            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.
          schema:
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
    put:
105
      description: 'Register/De-register the information about specific a UeIdentityTagInfo resource'
106
107
108
109
110
111
112
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Body.UeIdentityTagInfo'
      responses:
        '200':
          description: >-
113
            It is used to indicate success. The response body contains a representation of the UeIdentityTagInfo resource
114
115
          schema:
            required:
116
              - UeIdentityTagInfo
117
            properties:
118
              UeIdentityTagInfo:
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
203
204
205
                $ref: '#/definitions/UeIdentityTagInfo'
        '400':
          description: >-
            Incorrect parameters were passed in the request.In the returned
            ProblemDetails structure, the "detail" attribute should convey more
            information about the error.
          schema:
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: >-
            An erroneous or missing bearer token. More information should be
            provided in the "detail" attribute of the "ProblemDetails"
            structure.
          schema:
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: >-
            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.
          schema:
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: >-
            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.
          schema:
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '412':
          description: >-
            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.
          schema:
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
definitions:
  ProblemDetails:
    type: object
    properties:
      type:
        $ref: '#/definitions/Problem.type'
      title:
        $ref: '#/definitions/Problem.title'
      status:
        $ref: '#/definitions/Problem.status'
      detail:
        $ref: '#/definitions/Problem.detail'
      instance:
        $ref: '#/definitions/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
    required:
206
      - ueIdentityTags
207
    properties:
208
209
210
211
212
213
214
215
216
217
218
219
220
221
      ueIdentityTags:
        $ref: '#/definitions/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: '#/definitions/UeIdentityTag'
        state:
          $ref: '#/definitions/State'
222
  UeIdentityTag:
223
    description: 'Specific tag presented by a ME Application instance to a ME Platform'
224
    type: string
225
    example: UeTagA
226
  State:
227
    description: Status of the resource ueIdentityTagInfo
228
229
230
    type: string
    enum:
      - UNREGISTERED
231
232
      - REGISTERED
    example: REGISTERED