UEidentityAPI.yaml 7.11 KB
Newer Older
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 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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
swagger: '2.0'
info:
  description: An initial attempt to describe the MEC UE Identity API using OpenAPI
  version: 0.0.6
  title: UE Identity API
  termsOfService: TBD
  contact:
    name: TBD
    url: TBD
  license:
    name: ETSI MEC
    url: TBD
externalDocs:
  description: ETSI MEC014 V0.0.6 UE Identity API
  url: 'https://docbox.etsi.org/ISG/MEC/70-Draft/0014UEidentityAPI'
host: '127.0.0.1:8081'
basePath: /uis/v1
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:
    name: ueIdentityTagInfo
    in: body
    description: information of UE identity tag used in UE Identity feature.
    required: true
    schema:
      $ref: '#/definitions/UeIdentityTagInfo'
  Path.AppInstanceId:
    name: appInstanceId
    in: path
    description: Represents a mobile edge application instance
    required: true
    type: string
  Path.UeIdentityTag:
    name: ueIdentityTag
    in: path
    description: Represents a UE
    required: true
    type: string
paths:
  '/{appInstanceId}/ue_identity_tag_info/{ueIdentityTag}':
    get:
      description: retrieves information about a ueIdentityTagInfo resource
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.AppInstanceId'
        - $ref: '#/parameters/Path.UeIdentityTag'
      responses:
        '200':
          description: >-
            It is used to indicate nonspecific success. The response body
            contains a representation of the resource.
          schema:
            required:
              - ueIdentityTagInfo
            properties:
              ueIdentityTagInfo:
                $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:
      description: 'registers/de-registers a UE identity tag in UE Identity Service '
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.AppInstanceId'
        - $ref: '#/parameters/Path.UeIdentityTag'
        - $ref: '#/parameters/Body.UeIdentityTagInfo'
      responses:
        '200':
          description: >-
            Upon success, a response body containing data type describing the
            updated UeIdentityTagInfo is returned.
          schema:
            required:
              - ueIdentityTagInfo
            properties:
              ueIdentityTagInfo:
                $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:
      - ueIdentityTag
      - state
    properties:
      ueIdentityTag:
        $ref: '#/definitions/UeIdentityTag'
      state:
        $ref: '#/definitions/State'
  UeIdentityTag:
    description: Tag presented by ME Application to ME Platform
    type: string
  State:
    description: status of the resource ueIdentityTagInfo
    type: string
    enum:
      - UNREGISTERED
      - REGISTERED