Commit 8106334b authored by Yann Garcia's avatar Yann Garcia
Browse files

Merge branch 'STF678_MEC011' into 'STF678'

Stf678 mec011

See merge request mec/mec-sandbox!10
parents ead43a1c 09e0aa8f
Loading
Loading
Loading
Loading
+44 −45
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ info:
  version: 3.1.1
  description: "MEC Application Support Service is AdvantEDGE's implementation of\
    \ [ETSI MEC ISG MEC011 Application Enablement API](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/03.01.01_60/gs_MEC011v030101p.pdf)\
    \ <p>[Copyright (c) ETSI 2017](https://forge.etsi.org/etsi-forge-copyright-notice.txt)\
    \ <p>[Copyright (c) ETSI 2024](https://forge.etsi.org/etsi-forge-copyright-notice.txt)\
    \ <p>**Micro-service**<br>[meep-app-enablement](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-app-enablement/server/app-support)\
    \ <p>**Type & Usage**<br>Edge Service used by edge applications that want to get\
    \ information about applications in the network <p>**Note**<br>AdvantEDGE supports\
@@ -19,6 +19,11 @@ externalDocs:
  description: 'ETSI GS MEC011 Application Enablement API, V3.1.1'
  url: >-
    https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/03.01.01_60/gs_MEC011v030101p.pdf
servers:
  - url: 'http://localhost/sandboxname/mec_app_support/v2'
    variables: {}
  - url: 'https://localhost/sandboxname/mec_app_support/v2'
    variables: {}
tags:
  - name: mec_app_support
  - name: unsupported
@@ -31,7 +36,7 @@ paths:
    get:
      tags:
        - unsupported
      summary: get traffic rules
      summary: Retrieve information about a list of mecTrafficRule resources for an application instance
      description: >-
        This method retrieves information about all the traffic rules associated with a MEC application instance.
      operationId: ApplicationsTrafficRules_GET
@@ -163,7 +168,7 @@ paths:
    get:
      tags:
        - unsupported
      summary: Get traffic rule
      summary: Retrieve information about a mecTrafficRule resource
      description: >-
        This method retrieves information about all the traffic rules associated with a MEC application instance.
      operationId: ApplicationsTrafficRule_GET
@@ -252,7 +257,7 @@ paths:
    put:
      tags:
        - unsupported
      summary: Update traffic rule
      summary: Update the information about a mecTrafficRule resource
      description: >-
        This method retrieves information about all the traffic rules associated with a MEC application instance.
      operationId: ApplicationsTrafficRule_PUT
@@ -365,7 +370,7 @@ paths:
    get:
      tags:
        - unsupported
      summary: Get DNS rules
      summary: Retrieve information about a list of mecDnsRule resources for an application instance
      description: >-
        This method retrieves information about all the DNS rules associated with a MEC application instance.
      operationId: ApplicationsDnsRules_GET
@@ -456,7 +461,7 @@ paths:
    get:
      tags:
        - unsupported
      summary: Get DNS rule
      summary: Retrieve information about a mecDnsRule resource
      description: >-
        This method retrieves information about a DNS rule associated with a MEC application instance.
      operationId: ApplicationsDnsRule_GET
@@ -530,7 +535,7 @@ paths:
    put:
      tags:
        - unsupported
      summary: Update DNS rule
      summary: Update the information about a mecDnsRule resource
      description: 'This method activates, de-activates or updates a traffic rule.'
      operationId: ApplicationsDnsRule_PUT
      parameters:
@@ -624,7 +629,7 @@ paths:
    get:
      tags:
        - mec_app_support
      summary: Get subscriptions
      summary: Retrieve information about a list of mecAppSupportSubscription resources for this subscriber
      description: >-
        The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains message content with all the subscriptions for the requestor.
      operationId: ApplicationsSubscriptions_GET
@@ -682,7 +687,7 @@ paths:
    post:
      tags:
        - mec_app_support
      summary: Create subscription
      summary: Create a mecAppSupportSubscription resource
      description: >-
        The POST method may be used to create a new subscription. One example use case is to create a new subscription to the MEC service availability notifications. Upon success, the response contains message content describing the created subscription.
      operationId: ApplicationsSubscriptions_POST
@@ -773,7 +778,7 @@ paths:
    get:
      tags:
        - mec_app_support
      summary: Get subscription
      summary: Retrieve information about a mecAppSupportSubscription resource for this subscriber
      description: >-
        The GET method requests information about a subscription for this requestor. Upon success, the response contains message content with the subscription for the requestor.
      operationId: ApplicationsSubscription_GET
@@ -839,7 +844,7 @@ paths:
    delete:
      tags:
        - mec_app_support
      summary: delete subscription
      summary: Delete a mecAppSupportSubscription resource
      description: >-
        This method deletes a mecAppSuptApiSubscription. This method is typically used in "Unsubscribing from service availability event notifications" procedure.
      operationId: ApplicationsSubscription_DELETE
@@ -892,7 +897,7 @@ paths:
    post:
      tags:
        - mec_app_support
      summary: Confirm termination
      summary: Confirm the application level termination of an App instance
      description: >-
        This method is used to confirm the application level termination  of an application instance.
      operationId: ApplicationsConfirmTermination_POST
@@ -980,7 +985,7 @@ paths:
    post:
      tags:
        - mec_app_support
      summary: Confirm ready
      summary: Confirm the application instance is up and running
      description: >-
        This method may be used by the MEC application instance to notify the MEC platform that it is up and running. 
      operationId: ApplicationsConfirmReady_POST
@@ -1067,7 +1072,7 @@ paths:
    post:
      tags:
        - mec_app_support
      summary: Create Registrantion
      summary: Register the MEC application instance to the MEC platform
      description: >-
        The POST method may be used by the MEC application instance to request its registration to the MEC platform. 
      operationId: ApplicationsRegistrations_POST
@@ -1146,7 +1151,7 @@ paths:
    get:
      tags:
        - mec_app_support
      summary: Get Registration
      summary: Retrieve information about the MEC application instance registration to the MEC platform
      description: >-
        The GET method may be used by the MEC application instance to retrieve information about the existing MEC application instance registration to the MEC platform.
      operationId: ApplicationsRegistration_GET
@@ -1204,7 +1209,7 @@ paths:
    put:
      tags:
        - mec_app_support
      summary: Update Registration
      summary: Update the existing registration of that MEC application instance to the MEC platform
      description: >-
        The PUT method may be used by the MEC application instance to update its registration to the MEC platform.
      operationId: ApplicationsRegistration_PUT
@@ -1278,7 +1283,7 @@ paths:
    delete:
      tags:
        - mec_app_support
      summary: delete registration
      summary: Request deregistration of the application instance from the MEC platform
      description: >-
        The DELETE method is used to cancel the existing MEC application instance registration.
      operationId: ApplicationsRegistration_DELETE
@@ -1346,7 +1351,7 @@ paths:
    get:
      tags:
        - mec_app_support
      summary: Retrieve timing capabilities
      summary: Retrieve information about the mecTimingCaps resource
      description: >-
        This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query
      operationId: TimingCaps_GET
@@ -1398,7 +1403,7 @@ paths:
    get:
      tags:
        - mec_app_support
      summary: Retrieve current time
      summary: Retrieve information about the mecCurrentTime resource
      description: >-
        This method retrieves the information of the platform's current time which corresponds to the get platform time procedure
      operationId: TimingCurrentTime_GET
@@ -1458,7 +1463,7 @@ components:
          type: string
          description: Indication about the MEC application instance.
          example:
            - READY
             READY
      description: >-
        This type represents the information that the MEC application instance indicates to the MEC platform that it is up and running.
    AppInfo:
@@ -1473,14 +1478,14 @@ components:
          description: >-
            Name of the application. It shall be consistent with the appName in the AppD, if an AppD is available.
          example:
            - appName
             appName
        appProvider:
          title: appProvider
          type: string
          description: >-
            Provider of the application. It shall be consistent with the appProvider in the AppD, if an AppD is available. See note 1.
          example:
            - appProvider1
             appProvider1
        appCategory:
          $ref: '#/components/schemas/CategoryRef'
        appDId:
@@ -1489,14 +1494,14 @@ components:
          description: >-
            The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way. Shall be present if the application instance is instantiated by the MEC Management.
          example:
            - TODO
             TODO
        appInstanceId:
          title: appInstanceId
          type: string
          description: >-
            Identifier of the application instance. Shall be present if the application instance is instantiated by the MEC Management.
          example:
            - ID1
             ID1
        endpoint:
          oneOf:
            - $ref: '#/components/schemas/EndPointInfoUris'
@@ -1538,7 +1543,7 @@ components:
          description: >-
            Indicate whether the application instance is instantiated by the MEC Management. Default to FALSE if absent.
          example:
            - false
             false
        appProfile:
          $ref: '#/components/schemas/AppProfile'
      description: >-
@@ -1604,7 +1609,7 @@ components:
          type: string
          description: Shall be set to AppTerminationNotificationSubscription.
          example:
            - AppTerminationNotificationSubscription
             AppTerminationNotificationSubscription
        callbackReference:
          type: string
          description: >-
@@ -1615,7 +1620,7 @@ components:
          type: string
          description: It is used as the filtering criterion for the subscribed events.
          example:
            - ID1
             ID1
      description: >-
        This type represents the information that the MEC platform notifies the subscribed application instance about  the corresponding application instance termination/stop.
    CurrentTime:
@@ -1739,7 +1744,7 @@ components:
          type: string
          description: URI referring to a resource
          example:
            - /mecAppSuptApi/example
             /mecAppSuptApi/example
      description: >-
        This type represents a type of link and may be referenced from data
        structures
@@ -2161,23 +2166,23 @@ components:
          type: string
          description: Reference of the catalogue
          example:
            - /example/catalogue1
             /example/catalogue1
        id:
          type: string
          description: Unique identifier of the category
          example:
            - id12345
             id12345
        name:
          type: string
          description: >-
            Name of the category, example values include RNI, Location & Bandwidth Management
          example:
            - RNI
             RNI
        version:
          type: string
          description: Category version
          example:
            - version1
             version1
      description: This type represents the category reference
    EndPointInfoAddress:
      title: EndPointInfoAddress
@@ -2246,17 +2251,11 @@ components:
            type: string
          description: Fully Qualified Domain Name of the service. See note.
      description: 'This type represents information about a transport endpoint. '
    
    Not_specified:
      description: 'Not_specified'
    
    ServiceDependency:
      properties:
        requestedPermissions:
          description: >-
            Requested permissions regarding the access of the application to the service. See clause 8.2 of ETSI GS MEC 009 [4]. The format of this attribute is left for the data model design stage.
          items:
            $ref: '#/components/schemas/Not_specified'
          minItems: 0
          type: array
        serCategory:
@@ -2330,7 +2329,7 @@ components:
      type: string
      description: The enumeration represents types of serializers
      example:
        - JSON
         JSON
    SecurityInfo:
      title: SecurityInfo
      type: object
@@ -2356,7 +2355,7 @@ components:
          type: string
          description: The token endpoint
          example:
            - /mecSerMgmtApi/security/TokenEndPoint
             /mecSerMgmtApi/security/TokenEndPoint
      description: Parameters related to use of OAuth 2.0
    SecurityInfoOAuth2InfoGrantType:
      title: SecurityInfoOAuth2InfoGrantType
@@ -2368,7 +2367,7 @@ components:
      type: string
      description: OAuth 2.0 grant type
      example:
        - OAUTH2_CLIENT_CREDENTIALS
         OAUTH2_CLIENT_CREDENTIALS
    TransportType:
      title: TransportType
      enum:
@@ -2382,7 +2381,7 @@ components:
      type: string
      description: The enumeration TransportType represents types of transports
      example:
        - REST_HTTP
         REST_HTTP
    FeatureDependency:
      properties:
        featureName:
@@ -2411,7 +2410,7 @@ components:
          description: The identifier of the EAS
          type: string
          example:
            - appName
             appName
        endPt:
          description: The version of the feature.
          oneOf:
@@ -2429,7 +2428,7 @@ components:
          type: string
          description: Identifier of the ASP that provides the EAS.
          example:
            - appProvider1
             appProvider1
        type:
          description: The category or type of EAS.
          type: string
@@ -2476,7 +2475,7 @@ components:
          description: >-
            The period indicating to the EES, how often the EES needs to check the EAS's availability after a successful registration.
          example:
            - 1577836800
             1577836800
        status:
          type: string
          description: 'EAS status information. '
+2 −2
Original line number Diff line number Diff line
@@ -382,9 +382,9 @@ paths:
              maxGracefulTimeout: 10
              _links:
                subscription:
                  href: http://mec011Server.example.com/mec_app_support/v1/applications/appId1234/subscriptions/sub123
                  href: http://mec011Server.example.com/mec_app_support/v2/applications/appId1234/subscriptions/sub123
                confirmTermination:
                  href: http://mec011Server.example.com/mec_app_support/v1/confirm_termination
                  href: http://mec011Server.example.com/mec_app_support/v2/confirm_termination
        required: true
      responses:
        "204":
+1 −0
Original line number Diff line number Diff line
@@ -13,6 +13,7 @@ externalDocs:
  description: "ETSI GS MEC011 Application Enablement API, V3.1.1"
  url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/03.01.01_60/gs_MEC011v030101p.pdf
servers:
- url: http://localhost/sandboxname/mec_service_mgmt/v1
- url: https://localhost/sandboxname/mec_service_mgmt/v1
tags:
- name: appSubscriptions
+1 −1
Original line number Diff line number Diff line
@@ -618,7 +618,7 @@ export function parseEdgeApps(scenario) {
                  mepName: pl.name,
                  env: proc.environment,
                  url: 'api/?urls.primaryName='+pl.name+'%20-%20MEC%20Application%20Support%20API',
                  path: pl.name+'/mec_app_support/v1',
                  path: pl.name+'/mec_app_support/v2',
                  pseudoName: 'MEC Application Support (011) on ' + pl.name,
                  dropDownName: 'MEC Application Support (011)',
                  enabled: true,  // always running