Commit 8f0b0ff7 authored by muhammadh's avatar muhammadh
Browse files

update service-mgmt.yaml as per MEC011 v2.2.1

parent 05205f28
Loading
Loading
Loading
Loading
+70 −20
Original line number Diff line number Diff line
@@ -3,18 +3,18 @@ servers:
  - url: 'https://localhost/sandboxname/mec_service_mgmt/v1'
info:
  title: MEC Service Management API
  version: 2.1.1
  version: 2.2.1
  description: 'The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI.
<p>**Note**<br>MEC Sandbox supports all Service Management API endpoints; complete details on Service Management API can be found on [ETSI Forge](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf).'
<p>**Note**<br>MEC Sandbox supports all Service Management API endpoints; complete details on Service Management API can be found on [ETSI Forge](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.02.01_60/gs_MEC011v020201p.pdf).'
  license:
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'
  contact:
    email: cti_support@etsi.org
externalDocs:
  description: 'ETSI GS MEC011 Application Enablement API, V2.1.1'
  description: 'ETSI GS MEC011 Application Enablement API, V2.2.1'
  url: >-
    https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf
    https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.02.01_60/gs_MEC011v020201p.pdf
tags:
  - name: mec_service_mgmt
paths:
@@ -408,6 +408,9 @@ components:
          type: string
          format: uri
          description: A URI reference that identifies the specific occurrence of the problem
      required:
      - status
      - detail
    GrantType:
      description: OAuth 2.0 grant type
      type: string
@@ -565,6 +568,7 @@ components:
      enum:
        - ACTIVE
        - INACTIVE
        - SUSPENDED
    ServiceStates:
      description: >-
        States of the services about which to report events. If the event is 
@@ -653,6 +657,7 @@ components:
        - state
        - transportInfo
        - serializer
        - _links
      properties:
        serInstanceId:
          $ref: '#/components/schemas/SerInstanceId'
@@ -682,6 +687,21 @@ components:
            Indicate whether the service is located in the same locality (as defined
            by scopeOfLocality) as the consuming MEC application.
          type: boolean
        livenessInterval:
          type: integer
          description: Interval (in seconds) between two consecutive "heartbeat" messages (see clause 8.2.10.3.3).
                      If the service-producing application supports sending "heartbeat" messages, it shall include this attribute in the registration request. In this case, the application shall either set the value of this attribute to zero or shall use this attribute to propose a non-zero positive value for the liveness interval.
                      If the application has provided this attribute in the request and the MEC platform requires "heartbeat" messages, the MEC platform shall return this attribute value in the HTTP responses. The MEC platform may use the value proposed in the request or may choose a different value.
                      If the MEC platform does not require "heartbeat" messages for this service instance it shall omit the attribute in responses.
        _links:
          type: object
          required:
            - self
          properties:
            self:
              $ref: '#/components/schemas/LinkType'
            liveness:
              $ref: '#/components/schemas/LinkType'
      example:
        serInstanceId: 'rnisInstance1'
        serName: 'myRnis'
@@ -704,6 +724,36 @@ components:
              - 'https://my.callback.com/sandboxname/rni/v2/'
        serializer: 'JSON'
        scopeOfLocality: 'MEC_SYSTEM'
    ServiceLivenessInfo:
      type: object
      required:
        - state
        - timeStamp
        - interval
      properties:
        state:
          $ref: '#/components/schemas/ServiceState'
        timeStamp:
          type: object
          description: The time when the last "heartbeat" message was received by MEC platform
          required:
            - seconds
            - nanoSeconds
          properties:
            seconds:
              type: integer
            nanoSeconds:
              type: integer            
        interval:
          type: integer
          description: The interval (in seconds) between two consecutive "heartbeat" messages (see clause 8.2.10.3.3) that MEC platform has determined.
    ServiceLivenessUpdate:
      type: object
      required:
        - state
      properties:
        state:
          $ref: '#/components/schemas/ServiceState'
    Subscription:
      description: A link to the related subscription
      type: object
@@ -1110,7 +1160,7 @@ components:
            -  when the MEC platform notifies the authorized relevant 
            applications that are subscribed to the corresponding 
            service availability notifications about the service availability changes.'
          operationId: ServiceAvailabilityNotification_POST
          operationId: Sm_ServiceAvailabilityNotification_POST
          tags:
            - callbacks
          requestBody:
@@ -1120,40 +1170,40 @@ components:
              description: Expected responses from callback consumer, if it accepts the callback
  links:
    GetIndividualmecService:
      operationId: ServicesServiceId_GET
      operationId: Sm_ServicesServiceId_GET
      description: The `serviceId` value returned in the response can be used as the `serviceId` parameter in `GET /services/{serviceId}`
      parameters:
        serviceId: '$response.body#/serviceId'
    PutIndividualmecService:
      operationId: ServicesServiceId_PUT
      operationId: Sm_ServicesServiceId_PUT
      description: The `serviceId` value returned in the response can be used as the `serviceId` parameter in `PUT /services/{serviceId}`
      parameters:
        serviceId: '$response.body#/serviceId'
    GetTransportInfo:
      operationId: AppServices_POST
      operationId: Sm_AppServices_POST
      description: The `id` value returned in the response can be used as the `transportId` parameter in `POST /applications/{appInstanceId}/services`. The first transport is provided as the link as wildcards are not supported
      parameters:
        transportId: '$response.body#/0/id'
    GetIndividualmecSerMgmtApiSubscription:
      operationId: ApplicationsSubscription_GET
      operationId: Sm_ApplicationsSubscription_GET
      description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}`
      parameters:
        description: regex = \/mec_service_mgmt\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
        subscriptionId: 'TBC'
    DelIndividualmecSerMgmtApiSubscription:
      operationId: ApplicationsSubscription_DELETE
      operationId: Sm_ApplicationsSubscription_DELETE
      description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}`
      parameters:
        description: regex = \/mec_service_mgmt\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
        subscriptionId: 'TBC'
    GetIndividualmecSerMgmtApiSubscriptionLinkList:
      operationId: ApplicationsSubscription_GET
      operationId: Sm_ApplicationsSubscription_GET
      description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}`
      parameters:
        description: regex = \/mec_service_mgmt\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
        subscriptionId: 'TBC'
    DelIndividualmecSerMgmtApiSubscriptionLinkList:
      operationId: ApplicationsSubscription_DELETE
      operationId: Sm_ApplicationsSubscription_DELETE
      description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}`
      parameters:
        description: regex = \/mec_service_mgmt\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute