UEAppInterfaceApi.yaml 34.2 KB
Newer Older
openapi: 3.1.0
Michel Roy's avatar
Michel Roy committed
  contact:
    url: https://forge.etsi.org/rep/mec/gs016-dev-app-api
Michel Roy's avatar
Michel Roy committed
  title: 'ETSI GS MEC 016 Device application interface'
  version: 2.2.1
  description: The ETSI MEC ISG Device application interface API described using OpenAPI.
admin_forge's avatar
admin_forge committed
    name: BSD-3-Clause
Michel Roy's avatar
Michel Roy committed
    url: 'https://forge.etsi.org/legal-matters'

Michel Roy's avatar
Michel Roy committed
  description: ETSI GS MEC016 V2.2.1 Device application interface
  url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/02.02.01_60/gs_MEC016v020201p.pdf'

servers:
Michel Roy's avatar
Michel Roy committed
  - url: 'https://localhost/dev_app/v1'

tags:
- name: "dev_app"
Michel Roy's avatar
Michel Roy committed
  /app_list:
      tags:
Michel Roy's avatar
Michel Roy committed
      - "dev_app"
Michel Roy's avatar
Michel Roy committed
      summary: "Get available application information."
      description: "Used to query information about the available MEC applications."
      operationId: "meAppListGET"
Michel Roy's avatar
Michel Roy committed
      - $ref: '#/components/parameters/Query.appName'
      - $ref: '#/components/parameters/Query.appProvider'
      - $ref: '#/components/parameters/Query.appSoftVersion'
      - $ref: '#/components/parameters/Query.vendorId'
      - $ref: '#/components/parameters/Query.serviceCont'
Michel Roy's avatar
Michel Roy committed
        200:
          description: "The response body contains an array of the user applications available to the querying device application."
          content:
            application/json:
              schema:
Michel Roy's avatar
Michel Roy committed
                $ref: "#/components/schemas/ApplicationList"
Michel Roy's avatar
Michel Roy committed
        400:
          $ref: "#/components/responses/400"
        401:
          $ref: "#/components/responses/401"
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
  /app_contexts:
      tags:
Michel Roy's avatar
Michel Roy committed
      - "dev_app"
Michel Roy's avatar
Michel Roy committed
      summary: "Creation of a new application context."
      description: "Used to create a new application context. Upon success, the response contains entity body describing the created application context."
      operationId: "devAppContextsGET"
      requestBody:
Michel Roy's avatar
Michel Roy committed
        description: "Entity body in the request contains the Application Context as requested by the device application."
        required: true
        content:
          application/json:
            schema:
Michel Roy's avatar
Michel Roy committed
              $ref: '#/components/schemas/AppContext'
Michel Roy's avatar
Michel Roy committed
      parameters: []
Michel Roy's avatar
Michel Roy committed
        201:
          description: "The response body contains the Application Context as it was created by the MEC system, which includes the reference URI(s) of the associated user application instance(s). The URI of the resource created within the MEC system associated with the request, with its specific application context ID, shall be included in the 'Location' HTTP header of the response."
          content:
            application/json:
              schema:
Michel Roy's avatar
Michel Roy committed
                $ref: "#/components/schemas/AppContext"
Michel Roy's avatar
Michel Roy committed
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
      callbacks:
Michel Roy's avatar
Michel Roy committed
        notification:
          '{$request.body#/appContext.callbackReference}':
            post:
              summary: 'Callback POST used to send a notification'
              description: 'Notification with content based on subscription type'
              operationId: notificationPOST
Michel Roy's avatar
Michel Roy committed
              requestBody:
Michel Roy's avatar
Michel Roy committed
                description: Subscription notification
                required: true
                content:
                  application/json:
                    schema:
Michel Roy's avatar
Michel Roy committed
                      $ref: '#/components/schemas/InlineNotification'
                    example:
                      notificationType: ApplicationContextDeleteNotification
                      contextId: 'contextId123'
Michel Roy's avatar
Michel Roy committed
              responses:
                204:
                  $ref: '#/components/responses/204'
  /app_contexts/{contextId}:
      tags:
Michel Roy's avatar
Michel Roy committed
      - "dev_app"
Michel Roy's avatar
Michel Roy committed
      summary: "Updating the callbackReference and/or appLocation of an existing application context."
      description: "Used to update the callback reference and/or application location constraints of an existing application context. Upon successful operation, the target resource is updated with the new application context information."
      operationId: "devAppContextPUT"
      requestBody:
Michel Roy's avatar
Michel Roy committed
        description: "Only the callbackReference and/or appLocation attribute values are allowed to be updated. Other attributes and their values shall remain untouched."
        required: true
        content:
          application/json:
            schema:
Michel Roy's avatar
Michel Roy committed
              $ref: '#/components/schemas/AppContext'
Michel Roy's avatar
Michel Roy committed
      parameters:
      - $ref: '#/components/parameters/Path.contextId'
      responses:
Michel Roy's avatar
Michel Roy committed
        204:
          $ref: '#/components/responses/204'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
    delete:
      tags:
Michel Roy's avatar
Michel Roy committed
      - "dev_app"
Michel Roy's avatar
Michel Roy committed
      summary: "Deletion of an existing application context."
      description: "Used to delete the resource that represents the existing application context."
      operationId: "devAppContextDELETE"
      parameters:
      - $ref: '#/components/parameters/Path.contextId'
Michel Roy's avatar
Michel Roy committed
        204:
          $ref: '#/components/responses/204'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
  /obtain_app_loc_availability:
    post:
      tags:
Michel Roy's avatar
Michel Roy committed
      - "dev_app"
Michel Roy's avatar
Michel Roy committed
      summary: "Obtain the location constraints for a new application context."
      description: "Used to obtain the locations available for instantiation of a specific user application in the MEC system."
      operationId: "appLocationAvailabilityPOST"
      requestBody:
        description: "Entity body in the request contains the user application information for the MEC system to evaluate the locations available for instantiation of that application."
        required: true
        content:
          application/json:
            schema:
Michel Roy's avatar
Michel Roy committed
              $ref: '#/components/schemas/ApplicationLocationAvailability'
Michel Roy's avatar
Michel Roy committed
      parameters: []
      responses:
        200:
          description: "The response body contains the locations available for instantiation of the requested user application in the MEC system."
          content:
            application/json:
              schema:
Michel Roy's avatar
Michel Roy committed
                $ref: "#/components/schemas/ApplicationLocationAvailability"
Michel Roy's avatar
Michel Roy committed
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
components:
Michel Roy's avatar
Michel Roy committed
  responses:
    204:
      description: "Upon success, a response 204 No Content without any response body is returned."
    400:
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
Michel Roy's avatar
Michel Roy committed
        application/problem+json:
Michel Roy's avatar
Michel Roy committed
          schema:
Michel Roy's avatar
Michel Roy committed
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
    401:
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
Michel Roy's avatar
Michel Roy committed
        application/problem+json:
Michel Roy's avatar
Michel Roy committed
          schema:
Michel Roy's avatar
Michel Roy committed
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
    403:
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
Michel Roy's avatar
Michel Roy committed
        application/problem+json:
Michel Roy's avatar
Michel Roy committed
          schema:
Michel Roy's avatar
Michel Roy committed
            $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
    404:
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
Michel Roy's avatar
Michel Roy committed
        application/problem+json:
Michel Roy's avatar
Michel Roy committed
          schema:
Michel Roy's avatar
Michel Roy committed
            $ref: '#/components/schemas/ProblemDetails'
  parameters:
Michel Roy's avatar
Michel Roy committed
    Query.appName:
      name: appName
Michel Roy's avatar
Michel Roy committed
      in: "query"
      description: "Name to identify the MEC application."
      required: false
      schema:
        type: array
        items:
          type: string
Michel Roy's avatar
Michel Roy committed
          maxLength: 32
    Query.appProvider:
      name: appProvider
Michel Roy's avatar
Michel Roy committed
      in: "query"
      description: "Provider of the MEC application."
      required: false
      schema:
        type: array
        items:
          type: string
Michel Roy's avatar
Michel Roy committed
          maxLength: 32
    Query.appSoftVersion:
      name: appSoftVersion
Michel Roy's avatar
Michel Roy committed
      in: "query"
      description: "Software version of the MEC application."
      required: false
      schema:
        type: array
        items:
          type: string
Michel Roy's avatar
Michel Roy committed
          maxLength: 32
    Query.vendorId:
      name: vendorId
Michel Roy's avatar
Michel Roy committed
      in: "query"
      description: "Vendor identifier"
      required: false
      schema:
        type: array
        items:
          type: string
Michel Roy's avatar
Michel Roy committed
          maxLength: 32
    Query.serviceCont:
      name: serviceCont
      in: "query"
      description: "Required service continuity mode for this application. Permitted values:
        0 = SERVICE_CONTINUITY_NOT_REQUIRED.
        1 = SERVICE_CONTINUITY_REQUIRED."
      required: false
      schema:
        type: integer
        enum:
        - 0
        - 1
    Path.contextId:
      name: contextId
Michel Roy's avatar
Michel Roy committed
      in: "path"
      description: "Uniquely identifies the application context in the MEC system. It is assigned by the MEC system."
      required: true
      schema:
        type: string
  schemas:
Michel Roy's avatar
Michel Roy committed
    AddressChangeNotification:
      properties:
Michel Roy's avatar
Michel Roy committed
        appInstanceId:
          description: Identifier of the user application instance.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        contextId:
          description: Uniquely identifies the application context in the MEC system.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        notificationType:
          description: Shall be set to "AddressChangeNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        referenceURI:
          description: 'Address of the user application. Used as the reference URI for the application. Assigned by the MEC system.'
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
      required:
      - notificationType
      - contextId
      - appInstanceId
      - referenceURI
      type: object
Michel Roy's avatar
Michel Roy committed
      x-etsi-ref: 6.4.2
    AppContext:
      properties:
Michel Roy's avatar
Michel Roy committed
        appAutoInstantiation:
          description: Provides indication to the MEC system that instantiation of the requested application is desired should a requested appLocation become available that was not at the time of the request.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        appInfo:
Michel Roy's avatar
Michel Roy committed
          description: ''
          properties:
            appDId:
              description: "Identifier of this MEC application descriptor. This attribute shall be globally unique. It is equivalent to the appDId defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1]. It shall be present if the application is one in the ApplicationList."
              type: string
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            appDVersion:
              description: "Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1]."
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            appDescription:
              description: "Human readable description of the MEC application. The length of the value shall not exceed 128 characters."
              type: string
              maxLength: 128
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            appName:
              description: "Name of the MEC application. The length of the value shall not exceed 32 characters."
              type: string
              maxLength: 32
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            appProvider:
              description: "Provider of the MEC application.\nThe length of the value shall not exceed 32 characters."
              type: string
              maxLength: 32
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            appSoftVersion:
              description: "Software version of the MEC application. The length of the value shall not exceed 32 characters."
              type: string
              maxLength: 32
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            appPackageSource:
              description: "URI of the application package.\nIncluded in the request if the application is not one in the ApplicationList. appPackageSource enables on-boarding of the application package into the MEC system. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 0102 [1]."
              format: uri
              type: string
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: URI
            userAppInstanceInfo:
              description: List of user application instance information.
              items:
                type: object
                properties:
                  appInstanceId:
                    description: 'Identifier of the user application instance. It shall only be included in the response.'
                    type: string
                    x-etsi-mec-cardinality: 0..1
                    x-etsi-mec-origin-type: String
                  appLocation:
Michel Roy's avatar
Michel Roy committed
                    $ref: '#/components/schemas/LocationConstraints'
                    # description: 'Location of the user application instance. For a user application not provided by the requesting device application it shall match one of the appLocations in ApplicationList.'
                    # x-etsi-mec-cardinality: 0..1
                    # x-etsi-mec-origin-type: LocationConstraints
Michel Roy's avatar
Michel Roy committed
                  referenceURI:
                    description: 'Address of the user application instance. It shall only be included in the response.'
                    format: uri
                    type: string
                    x-etsi-mec-cardinality: 0..1
                    x-etsi-mec-origin-type: URI
              minItems: 1
              type: array
              x-etsi-mec-cardinality: 1..N
              x-etsi-mec-origin-type: array (Structure inlined)
          required:
          - appName
          - appProvider
          - appDVersion
          - userAppInstanceInfo
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        appLocationUpdates:
          description: Used by the device application to request to receive notifications at the callbackReference URI relating to location availability for user application instantiation.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        associateDevAppId:
          description: "Uniquely identifies the device application. The length of the value shall not exceed 32 characters."
          type: string
          maxLength: 32
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        callbackReference:
          description: 'URI assigned by the device application to receive application lifecycle related notifications. Inclusion in the request implies the client supports the pub/sub mechanism and is capable of receiving notifications. This endpoint shall be maintained for the lifetime of the application context.'
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        contextId:
          description: "Uniquely identifies the application context in the MEC system. Assigned by the MEC system and shall be present other than in a create request. The length of the value shall not exceed 32 characters."
          type: string
          maxLength: 32
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      required:
      - associateDevAppId
      - appInfo
      type: object
Michel Roy's avatar
Michel Roy committed
      x-etsi-notes: "NOTE 1:\tIf a value of the attribute is included in the request,\
        \ the same value shall be included in the response.\nNOTE 2:\tThe design of\
        \ the current operation with callback reference assumes no web proxy between\
        \ the entity that originates the notification and the entity that receives\
        \ it.\nNOTE 3:\tThe language support for the application description may be\
        \ limited.\nNOTE 4:\tAttribute appLocationUpdates and appAutoInstantiation\
        \ shall not both be set to TRUE."
      x-etsi-ref: 6.2.3
    ApplicationContextDeleteNotification:
      properties:
        contextId:
          description: Uniquely identifies the application context that has been deleted from the MEC system.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        notificationType:
          description: Shall be set to "ApplicationContextDeleteNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
Michel Roy's avatar
Michel Roy committed
      - notificationType
      - contextId
      type: object
      x-etsi-ref: 6.4.3
    ApplicationContextUpdateNotification:
      properties:
        contextId:
Michel Roy's avatar
Michel Roy committed
          description: Uniquely identifies the application context in the MEC system.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        notificationType:
          description: Shall be set to "ApplicationContextUpdateNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        userAppInstanceInfo:
          description: List of user application instance information.
          items:
            type: object
            properties:
              appInstanceId:
                description: Identifier of the user application instance.
                type: string
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: String
              appLocation:
Michel Roy's avatar
Michel Roy committed
                $ref: '#/components/schemas/LocationConstraints'
                # description: Location of the user application instance.
                # x-etsi-mec-cardinality: 0..1
                # x-etsi-mec-origin-type: LocationConstraints
Michel Roy's avatar
Michel Roy committed
              referenceURI:
                description: Address of the user application instance.
                format: uri
                type: string
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: URI
          minItems: 1
          required:
          - appInstanceId
          - referenceURI
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: array (Structure inlined)
      type: object
Michel Roy's avatar
Michel Roy committed
      - notificationType
      - contextId
      - userAppInstanceInfo
      x-etsi-ref: 6.4.4
    ApplicationList:
Michel Roy's avatar
Michel Roy committed
        appList:
          description: 'List of user applications available to the device application. As defined below.'
          items:
            type: object
            properties:
              appInfo:
                description: ''
                properties:
                  appCharcs:
                    description: 'Characteristics of the application. As defined below. The application characteristics relate to the system resources consumed by the application. A device application can use this information e.g. for estimating the cost of use of the application or for the expected user experience.'
                    properties:
                      bandwidth:
                        description: 'The required connection bandwidth in kbit/s for the use of the MEC application instance. '
Michel Roy's avatar
Michel Roy committed
                        format: uint32
Michel Roy's avatar
Michel Roy committed
                        type: integer
                        x-etsi-mec-cardinality: 0..1
                        x-etsi-mec-origin-type: uint32
                      latency:
                        description: The target round trip time in milliseconds supported by the MEC system for the MEC application instance.
Michel Roy's avatar
Michel Roy committed
                        format: uint32
Michel Roy's avatar
Michel Roy committed
                        type: integer
                        x-etsi-mec-cardinality: 0..1
                        x-etsi-mec-origin-type: uint32
                      memory:
                        description: The maximum size in Mbytes of the memory resource expected to be used by the MEC application instance in the MEC system.
Michel Roy's avatar
Michel Roy committed
                        format: uint32
Michel Roy's avatar
Michel Roy committed
                        type: integer
                        x-etsi-mec-cardinality: 0..1
                        x-etsi-mec-origin-type: uint32
                      serviceCont:
                        description: 'Required service continuity mode for this application. Permitted values:
                          0 = SERVICE_CONTINUITY_NOT_REQUIRED.
                          1 = SERVICE_CONTINUITY_REQUIRED.'
                        enum:
                        - 0
                        - 1
Michel Roy's avatar
Michel Roy committed
                        type: integer
Michel Roy's avatar
Michel Roy committed
                        x-etsi-mec-cardinality: 0..1
                        x-etsi-mec-origin-type: Enum
                      storage:
                        description: The maximum size in Mbytes of the storage resource expected to be used by the MEC application instance in the MEC system.
Michel Roy's avatar
Michel Roy committed
                        format: uint32
Michel Roy's avatar
Michel Roy committed
                        type: integer
                        x-etsi-mec-cardinality: 0..1
                        x-etsi-mec-origin-type: uint32
                    type: object
                    x-etsi-mec-cardinality: 0..1
                    x-etsi-mec-origin-type: Structure (inlined)
                  appDId:
                    description: "Identifier of this MEC application descriptor. It is equivalent to the appDId defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1]. This attribute shall be globally unique."
                    type: string
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                  appDVersion:
                    description: Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1].
                    type: string
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                  appDescription:
                    description: Human readable description of the MEC application (see note 2).
                    type: string
                    maxLength: 128
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                  appLocation:
                    description: Identifies the locations of the MEC application.
                    items:
                      $ref: '#/components/schemas/LocationConstraints'
                    minItems: 0
                    type: array
                    x-etsi-mec-cardinality: 0..N
                    x-etsi-mec-origin-type: LocationConstraints
                  appName:
                    description: 'Name of the MEC application. The length of the value shall not exceed 32 characters.'
                    type: string
                    maxLength: 32
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                  appProvider:
                    description: 'Provider of the MEC application. The length of the value shall not exceed 32 characters.'
                    type: string
                    maxLength: 32
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                  appSoftVersion:
                    description: 'Software version of the MEC application. The length of the value shall not exceed 32 characters.'
                    type: string
                    maxLength: 32
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                required:
                - appDId
                - appName
                - appProvider
                - appSoftVersion
                - appDVersion
                - appDescription
                type: object
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: Structure (inlined)
              vendorSpecificExt:
                description: Extension for vendor specific information (see note 1).
                properties:
                  vendorId:
                    description: 'Vendor identifier. The length of the value shall not exceed 32 characters. The rest of the structure of vendor specific extension is not defined.'
                    type: string
                    maxLength: 32
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                required:
                - vendorId
                type: object
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Structure (inlined)
          minItems: 0
          required:
          - appInfo
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Array (Structure (inlined))
Michel Roy's avatar
Michel Roy committed
      x-etsi-notes: "NOTE 1:\tThe vendor specific extension allows submitting information\
        \ on the application lists that have been made available to the device application\
        \ of the corresponding vendor.\nNOTE 2:\tThe language support may be limited.\
        \ The length of the value shall not exceed 128 characters."
      x-etsi-ref: 6.2.2
    ApplicationLocationAvailability:
      properties:
        appInfo:
          description: ''
          properties:
            appDVersion:
              description: "Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1]."
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            appDescription:
              description: "Human readable description of the MEC application. The length of the value shall not exceed 128 characters."
              type: string
              maxLength: 128
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            appName:
              description: "Name of the MEC application. The length of the value shall not exceed 32 characters."
              type: string
              maxLength: 32
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            appPackageSource:
              description: "URI of the application package. Shall be included in the request. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 0102 [1]."
              format: uri
              type: string
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: URI
            appProvider:
              description: "Provider of the MEC application. The length of the value shall not exceed 32 characters."
              type: string
              maxLength: 32
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            appSoftVersion:
              description: "Software version of the MEC application. The length of the value shall not exceed 32 characters."
              type: string
              maxLength: 32
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            availableLocations:
              description: 'MEC application location constraints. '
              items:
                type: object
                properties:
                  appLocation:
Michel Roy's avatar
Michel Roy committed
                    $ref: '#/components/schemas/LocationConstraints'
                    # description: Shall only be included in the response, where it indicates a location constraint available in the MEC system.
                    # x-etsi-mec-cardinality: 0..1
                    # x-etsi-mec-origin-type: LocationConstraints
Michel Roy's avatar
Michel Roy committed
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: array (Structure (inline))
          required:
          - appName
          - appProvider
          - appDVersion
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        associateDevAppId:
          description: "Uniquely identifies the device application. The length of the value shall not exceed 32 characters."
          type: string
          maxLength: 32
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
Michel Roy's avatar
Michel Roy committed
      - associateDevAppId
      - appInfo
      type: object
      x-etsi-ref: 6.2.4
    ApplicationLocationAvailabilityNotification:
Michel Roy's avatar
Michel Roy committed
        availableLocations:
          description: Locations available to the MEC application.
          items:
            type: object
            properties:
              appLocation:
Michel Roy's avatar
Michel Roy committed
                $ref: '#/components/schemas/LocationConstraints'
                # description: 'It shall match one of the appLocations in the AppContext sent in the Application context create '
                # x-etsi-mec-cardinality: '1'
                # x-etsi-mec-origin-type: LocationConstraints
Michel Roy's avatar
Michel Roy committed
          minItems: 1
          required:
          - appLocation
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: array (Structure (inline))
        contextId:
          description: Uniquely identifies the application context in the MEC system.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        notificationType:
          description: Shall be set to "ApplicationLocationAvailabilityNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      type: object
      required:
Michel Roy's avatar
Michel Roy committed
      - notificationType
      - availableLocations
      x-etsi-ref: 6.4.5
Michel Roy's avatar
Michel Roy committed
    InlineNotification:
      oneOf:
        - $ref: '#/components/schemas/AddressChangeNotification'
        - $ref: '#/components/schemas/ApplicationContextDeleteNotification'
        - $ref: '#/components/schemas/ApplicationContextUpdateNotification'
        - $ref: '#/components/schemas/ApplicationLocationAvailabilityNotification'
      discriminator:
        propertyName: notificationType
Michel Roy's avatar
Michel Roy committed
    LocationConstraints:
      properties:
Michel Roy's avatar
Michel Roy committed
        area:
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/schemas/Polygon'
          # description: "Geographic area. Shall be absent if the \"civicAddressElement\" attribute is present. The content of this attribute shall follow the provisions for the \"Polygon\" geometry object as defined in IETF RFC 7946 [8], for which the \"type\" member shall be set to the value \"Polygon\". See note."
          # x-etsi-mec-cardinality: 0..1
          # x-etsi-mec-origin-type: Polygon
Michel Roy's avatar
Michel Roy committed
        civicAddressElement:
          description: Zero or more elements comprising the civic address. Shall be absent if the "area" attribute is present.
          items:
            type: object
            properties:
              caType:
                description: "Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776 [6]. "
                type: integer
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: Integer
              caValue:
                description: "Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776 [6]."
                type: string
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: String
          minItems: 0
          required:
          - caType
          - caValue
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: array (Structure inlined)
        countryCode:
          description: The two-letter ISO 3166 [7] country code in capital letters. Shall be present in case the "area" attribute is absent. May be absent if the "area" attribute is present (see note).
          type: string
          maxLength: 2
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      type: object
      x-etsi-notes: "NOTE:\tIf both \"countryCode\" and \"area\" are present, no conflicts\
        \ should exist between the values of these two attributes. In case of conflicts,\
        \ the API producer (e.g. MEO, MEAO) shall disregard parts of the geographic\
        \ area signalled by \"area\" that are outside the boundaries of the country\
        \ signalled by \"countryCode\". If \"countryCode\" is absent, it is solely\
        \ the \"area\" attribute that defines the location constraint."
      x-etsi-ref: 6.5.2
    Polygon:
      properties:
        coordinates:
          items:
            items:
              items:
                type: number
                format: float
              type: array
            type: array
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: array
      type: object
Michel Roy's avatar
Michel Roy committed
    ProblemDetails:
      properties:
Michel Roy's avatar
Michel Roy committed
        detail:
          description: A human-readable explanation specific to this occurrence of the problem
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        instance:
          description: A URI reference that identifies the specific occurrence of the problem
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        status:
          description: The HTTP status code for this occurrence of the problem
Michel Roy's avatar
Michel Roy committed
          format: uint32
Michel Roy's avatar
Michel Roy committed
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        title:
          description: A short, human-readable summary of the problem type
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        type:
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
      type: object