UEidentityAPI.yaml 6.94 KB
Newer Older
1
openapi: 3.0.2
2 3
info:
  title: UE Identity API
4 5
  version: 1.1.1
  description: The ETSI MEC ISG MEC014 UE Identity API described using OpenAPI
6
  license:
ETSI CTI's avatar
ETSI CTI committed
7 8
    name: BSD-3-Clause
    url: https://forge.etsi.org/legal-matters
9 10
  contact:
    email: cti_support@etsi.org
11
externalDocs:
12 13
  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
14 15 16
security:
  - OauthSecurity:
      - all
17 18 19 20 21
servers:
  - url: http://127.0.0.1:8081/ui/v1
  - url: https://127.0.0.1:8081/ui/v1
tags:
  - name: ueIdentityTagInfo
22
paths:
23
  "/{appInstanceId}/ue_identity_tag_info":
24
    parameters:
25
      - $ref: "#/components/parameters/Path.AppInstanceId"
26
    get:
27 28 29 30
      description: Retrieves information about a specific UeIdentityTagInfo resource
      operationId: UeIdentityTagInfo_GET
      tags:
        - ueIdentityTagInfo
31
      parameters:
32
        - $ref: "#/components/parameters/Query.UeIdentityTag"
33
      responses:
34 35
        "200":
          description: It is used to indicate nonspecific success. The response body
36
            contains a representation of the UeIdentityTagInfo resource.
37 38 39 40 41 42 43 44 45 46
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UeIdentityTagInfo"
        "400":
          $ref: '#/components/responses/Error.400'
        "403":
          $ref: '#/components/responses/Error.403'
        "404":
          $ref: '#/components/responses/Error.404'
47
    put:
48 49 50 51 52 53 54 55 56 57 58 59 60
      description: Register/De-register the information about specific a UeIdentityTagInfo
        resource
      operationId: UeIdentityTagInfo_PUT
      tags:
        - ueIdentityTagInfo
      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
61
      responses:
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
        "200":
          description: It is used to indicate success. The response body contains a
            representation of the UeIdentityTagInfo resource
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UeIdentityTagInfo"
        "400":
          $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:
          schema:
            $ref: "#/components/schemas/ProblemDetails"
        text/plain:
107
          schema:
108 109 110 111 112 113 114 115 116
            $ref: '#/components/schemas/Empty'
    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:
117
          schema:
118 119 120 121 122 123 124 125 126
            $ref: "#/components/schemas/ProblemDetails"
    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:
127
          schema:
128 129
            $ref: "#/components/schemas/ProblemDetails"
        text/plain:
130
          schema:
131 132 133 134 135 136 137 138 139 140
            $ref: '#/components/schemas/Empty'
    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:
141
          schema:
142 143
            $ref: "#/components/schemas/ProblemDetails"
        text/plain:
144
          schema:
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
            $ref: '#/components/schemas/Empty'
  securitySchemes:
    OauthSecurity:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://oauth.exampleAPI/token
          scopes:
            all: Single oauth2 scope for API
  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
192
      required:
193
        - ueIdentityTags
194
      properties:
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
        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"
    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
ETSI CTI's avatar
ETSI CTI committed
219
      example: REGISTERED