ETSI MEC 014 UE Identity API

openapi: 3.1.0
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
info:
  contact:
    url: https://forge.etsi.org/rep/mec/gs014-ue-identity-api
  title: ETSI GS MEC 014 UE Identity API
  description: "The present document focuses on the UE Identity functionality. It describes the related application policy information (including authorization, access control and traffic rule pattern format), information flows, required information and service aggregation patterns. The present document specifies the necessary API, data model and data format, considering existing API(s) if applicable. \n"
  license:
    name: BSD-3-Clause
    url: https://forge.etsi.org/legal-matters
  version: 3.1.1
servers:
- url: https://localhost:8081/ui/v1
paths:
  /{appInstanceId}/ue_identity_tag_info:
    get:
      summary: Retrieve information about specific UeIdentityTagInfo.
      description: This method retrieves information about a UeIdentityTagInfo resource.
      operationId: UeidentitytaginfoGETAppinstanceid
      tags:
      - uEIdentity
      parameters:
      - $ref: '#/components/parameters/Query.Ueidentitytag'
      - name: appInstanceId
        in: path
        required: true
        description: The unique identifier of the appInstanceId.
        schema:
          type: string
      responses:
        '200':
          description: It is used to indicate nonspecific success. The response body contains a representation of the UeIdentityTagInfo resource.
          content:
            application/json:
              schema:
                type: object
                properties:
                  UeIdentityTagInfo:
                    $ref: '#/components/schemas/UeIdentityTagInfo'
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '403':
          $ref: '#/components/responses/403'
    put:
      summary: Register/De-register the information about specific UeIdentityTagInfo.
      description: This method registers/deregisters one or more UE Identity tags. It has "replace" semantics.
      operationId: UeidentitytaginfoPUTAppinstanceid
      tags:
      - uEIdentity
      requestBody:
        description: The updated "state" for each included UE Identity tag is included in the entity body of the request.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                UeIdentityTagInfo:
                  $ref: '#/components/schemas/UeIdentityTagInfo'
      responses:
        '200':
          description: It is used to indicate success. The response body contains a representation of the UeIdentityTagInfo resource.
          content:
            application/json:
              schema:
                type: object
                properties:
                  UeIdentityTagInfo:
                    $ref: '#/components/schemas/UeIdentityTagInfo'
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404'
        '403':
          $ref: '#/components/responses/403'
        '412':
          $ref: '#/components/responses/412'
      parameters:
      - name: appInstanceId
        in: path
        required: true
        description: The unique identifier of the appInstanceId.
        schema:
          type: string
components:
  schemas:
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
        title:
          type: string
          description: A short, human-readable summary of the problem type
        status:
          type: integer
          format: uint32
          description: The HTTP status code for this occurrence of the problem
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem
        instance:
          type: string
          format: uri
          description: A URI reference that identifies the specific occurrence of the problem
    UeIdentityTagInfo:
      x-etsi-ref: 6.2.2
      type: object
      properties:
        ueIdentityTags:
          type: array
          items:
            $ref: '#/components/schemas/UeIdentityTags'
      required:
      - ueIdentityTags
    UeIdentityTags:
      description: 1 to N tags presented by a MEC Application instance to a MEC Platform
      type: object
      properties:
        ueIdentityTag:
          description: Specific tag presented by a MEC Application instance to a MEC Platform
          type: string
        state:
          type: integer
          enum:
          - 0
          - 1
          description: 'The following numeric values are defined:

            0 = UNREGISTERED

            1 = REGISTERED'
      required:
      - ueIdentityTag
      - state
  responses:
    '200':
      description: OK
    '400':
      description: 'Bad Request: used to indicate that incorrect parameters were passed to the request.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    '403':
      description: 'Forbidden: operation is not allowed given the current status of the resource.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    '404':
      description: 'Not Found: used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    '412':
      description: 'Precondition failed: used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
  parameters:
    Query.Ueidentitytag:
      description: Represents one or more UEs.
      name: ueidentitytag
      in: query
      required: true
      x-exportParamName: Query.Ueidentitytag
      schema:
        type: array
        items:
          type: string