Commit 52e50770 authored by Walter Featherstone's avatar Walter Featherstone
Browse files

Sepeated ServiceInfo POST message body

parents 17e38d97 94b47400
Loading
Loading
Loading
Loading
+94 −9
Original line number Diff line number Diff line
{
  "openapi": "3.0.0",
  "openapi": "3.0.2",
  "servers": [
    {
      "url": "http://127.0.0.1:8081/mp1/v1/"
      "url": "http://127.0.0.1:8081/mp1/v1"
    },
    {
      "url": "https://127.0.0.1:8081/mp1/v1/"
      "url": "https://127.0.0.1:8081/mp1/v1"
    }
  ],
  "info": {
@@ -15,12 +15,38 @@
    "license": {
      "name": "ETSI Forge copyright notice",
      "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
    },
    "contact": {
      "email": "cti_support@etsi.org"
    }
  },
  "externalDocs": {
    "description": "ETSI GS MEC011 Application Enablement API, V1.1.1",
    "url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf"
  },
  "tags": [
    {
      "name": "trafficRules"
    },
    {
      "name": "dnsRules"
    },
    {
      "name": "subscriptions"
    },
    {
      "name": "services"
    },
    {
      "name": "timing"
    },
    {
      "name": "transports"
    },
    {
      "name": "callbacks"
    }
  ],
  "paths": {
    "/applications/{appInstanceId}/dns_rules": {
      "parameters": [
@@ -31,6 +57,9 @@
      "get": {
        "description": "This method retrieves information about all the DNS rules associated with a mobile edge application instance.",
        "operationId": "ApplicationsDnsRules_GET",
        "tags": [
          "trafficRules"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/ApplicationsDnsRules.200"
@@ -59,6 +88,9 @@
      "get": {
        "description": "This method retrieves information about a DNS rule associated with a mobile edge application instance.",
        "operationId": "ApplicationsDnsRule_GET",
        "tags": [
          "dnsRules"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/ApplicationsDnsRule.200"
@@ -77,6 +109,9 @@
      "put": {
        "description": "This method activates, de-activates or updates a traffic rule.",
        "operationId": "ApplicationsDnsRule_PUT",
        "tags": [
          "dnsRules"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/ApplicationsDnsRule.200"
@@ -108,6 +143,9 @@
      "get": {
        "description": "The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.",
        "operationId": "ApplicationsSubscriptions_GET",
        "tags": [
          "subscriptions"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/ApplicationsSubscriptions.200"
@@ -126,6 +164,9 @@
      "post": {
        "description": "The POST method may be used to create a new subscription. One example use case is to create a new subscription to the mobile edge service availability notifications. Upon success, the response contains entity body describing the created subscription.",
        "operationId": "ApplicationsSubscriptions_POST",
        "tags": [
          "subscriptions"
        ],
        "responses": {
          "201": {
            "$ref": "#/components/responses/ApplicationsSubscriptions.201"
@@ -168,6 +209,9 @@
      "get": {
        "description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.",
        "operationId": "ApplicationsSubscription_GET",
        "tags": [
          "subscriptions"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/ApplicationsSubscription.200"
@@ -186,6 +230,9 @@
      "delete": {
        "description": "This method deletes a meMp1Subscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
        "operationId": "ApplicationsSubscription_DELETE",
        "tags": [
          "subscriptions"
        ],
        "responses": {
          "204": {
            "description": "No Content"
@@ -208,6 +255,9 @@
      "get": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
        "operationId": "ApplicationsTrafficRules_GET",
        "tags": [
          "trafficRules"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/ApplicationsTrafficRules.200"
@@ -236,6 +286,9 @@
      "get": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
        "operationId": "ApplicationsTrafficRule_GET",
        "tags": [
          "trafficRules"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/ApplicationsTrafficRule.200"
@@ -254,6 +307,9 @@
      "put": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
        "operationId": "ApplicationsTrafficRule_PUT",
        "tags": [
          "trafficRules"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/ApplicationsTrafficRule.200"
@@ -280,6 +336,9 @@
      "get": {
        "description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure",
        "operationId": "Services_GET",
        "tags": [
          "services"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.Ser_instance_id"
@@ -309,6 +368,9 @@
      "post": {
        "description": "This method is used to create a meService resource. This method is typically used in \"service availability update and new service registration\" procedure",
        "operationId": "Services_POST",
        "tags": [
          "services"
        ],
        "responses": {
          "201": {
            "$ref": "#/components/responses/Services.201"
@@ -337,6 +399,9 @@
      "get": {
        "description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure",
        "operationId": "ServicesServiceId_GET",
        "tags": [
          "services"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/ServicesServiceId.200"
@@ -355,6 +420,9 @@
      "put": {
        "description": "This method updates the information about a meService resource",
        "operationId": "ServicesServiceId_PUT",
        "tags": [
          "services"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/ServicesServiceId.200"
@@ -381,6 +449,9 @@
      "get": {
        "description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
        "operationId": "TimingCurrentTime_GET",
        "tags": [
          "timing"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/TimingCurrentTime.200"
@@ -401,6 +472,9 @@
      "get": {
        "description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
        "operationId": "TimingCaps_GET",
        "tags": [
          "timing"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/TimingCaps.200"
@@ -421,6 +495,9 @@
      "get": {
        "description": "This method retrieves information about a list of available transports. This method is typically used by a service-producing application to discover transports provided by the mobile edge platform in the \"transport information query\" procedure",
        "operationId": "Transports_GET",
        "tags": [
          "transports"
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/Transports.200"
@@ -2148,8 +2225,7 @@
              "$ref": "#/components/schemas/AppTerminationNotification"
            }
          }
        },
        "required": true
        }
      },
      "ServiceAvailabilityNotification": {
        "content": {
@@ -2158,14 +2234,18 @@
              "$ref": "#/components/schemas/ServiceAvailabilityNotification"
            }
          }
        },
        "required": true
        }
      }
    },
    "callbacks": {
      "AppTerminationNotification": {
        "$request.body#/callbackReference": {
        "{$request.body#/callbackReference}": {
          "post": {
            "description": "Represents the information that the MEP notifies the subscribed application instance about the corresponding  application instance termination/stop",
            "operationId": "AppTerminationNotification_POST",
            "tags": [
              "callback"
            ],
            "requestBody": {
              "$ref": "#/components/requestBodies/AppTerminationNotification"
            },
@@ -2178,8 +2258,13 @@
        }
      },
      "ServiceAvailabilityNotification": {
        "$request.body#/callbackReference": {
        "{$request.body#/callbackReference}": {
          "post": {
            "description": "'Represents the service availability information that  is used in the following cases - when the MEC platform announces the newly available\n services to the authorized relevant MEC applications (e.g. \n the applications that indicate the services as \"optional\" \n or \"required\") that are subscribed to the corresponding \n service availability notifications\n-  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",
            "tags": [
              "callback"
            ],
            "requestBody": {
              "$ref": "#/components/requestBodies/ServiceAvailabilityNotification"
            },
+70 −7
Original line number Diff line number Diff line
openapi: 3.0.0
openapi: 3.0.2
servers:
  - url: 'http://127.0.0.1:8081/mp1/v1/'
  - url: 'https://127.0.0.1:8081/mp1/v1/'
  - url: 'http://127.0.0.1:8081/mp1/v1'
  - url: 'https://127.0.0.1:8081/mp1/v1'
info:
  title: Mp1 API
  version: 1.1.1
@@ -9,10 +9,20 @@ info:
  license:
    name: ETSI Forge copyright notice
    url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
  contact:
    email: cti_support@etsi.org
externalDocs:
  description: 'ETSI GS MEC011 Application Enablement API, V1.1.1'
  url: >-
    http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf
tags:
  - name: trafficRules
  - name: dnsRules
  - name: subscriptions
  - name: services
  - name: timing
  - name: transports
  - name: callbacks
paths:
  '/applications/{appInstanceId}/dns_rules':
    parameters:
@@ -22,6 +32,8 @@ paths:
        This method retrieves information about all the DNS rules associated
        with a mobile edge application instance.
      operationId: ApplicationsDnsRules_GET
      tags:
        - trafficRules
      responses:
        '200':
          $ref: '#/components/responses/ApplicationsDnsRules.200'
@@ -40,6 +52,8 @@ paths:
        This method retrieves information about a DNS rule associated with a
        mobile edge application instance.
      operationId: ApplicationsDnsRule_GET
      tags:
        - dnsRules
      responses:
        '200':
          $ref: '#/components/responses/ApplicationsDnsRule.200'
@@ -52,6 +66,8 @@ paths:
    put:
      description: 'This method activates, de-activates or updates a traffic rule.'
      operationId: ApplicationsDnsRule_PUT
      tags:
        - dnsRules
      responses:
        '200':
          $ref: '#/components/responses/ApplicationsDnsRule.200'
@@ -74,6 +90,8 @@ paths:
        subscriptions for this requestor. Upon success, the response contains
        entity body with all the subscriptions for the requestor.
      operationId: ApplicationsSubscriptions_GET
      tags:
        - subscriptions
      responses:
        '200':
          $ref: '#/components/responses/ApplicationsSubscriptions.200'
@@ -90,6 +108,8 @@ paths:
        availability notifications. Upon success, the response contains entity
        body describing the created subscription.
      operationId: ApplicationsSubscriptions_POST
      tags:
        - subscriptions
      responses:
        '201':
          $ref: '#/components/responses/ApplicationsSubscriptions.201'
@@ -117,6 +137,8 @@ paths:
        requestor. Upon success, the response contains entity body with the
        subscription for the requestor.
      operationId: ApplicationsSubscription_GET
      tags:
        - subscriptions
      responses:
        '200':
          $ref: '#/components/responses/ApplicationsSubscription.200'
@@ -132,6 +154,8 @@ paths:
        in "Unsubscribing from service availability event notifications"
        procedure.
      operationId: ApplicationsSubscription_DELETE
      tags:
        - subscriptions
      responses:
        '204':
          description: No Content
@@ -147,6 +171,8 @@ paths:
        This method retrieves information about all the traffic rules associated
        with a mobile edge application instance.
      operationId: ApplicationsTrafficRules_GET
      tags:
        - trafficRules
      responses:
        '200':
          $ref: '#/components/responses/ApplicationsTrafficRules.200'
@@ -165,6 +191,8 @@ paths:
        This method retrieves information about all the traffic rules associated
        with a mobile edge application instance.
      operationId: ApplicationsTrafficRule_GET
      tags:
        - trafficRules
      responses:
        '200':
          $ref: '#/components/responses/ApplicationsTrafficRule.200'
@@ -179,6 +207,8 @@ paths:
        This method retrieves information about all the traffic rules associated
        with a mobile edge application instance.
      operationId: ApplicationsTrafficRule_PUT
      tags:
        - trafficRules
      responses:
        '200':
          $ref: '#/components/responses/ApplicationsTrafficRule.200'
@@ -198,6 +228,8 @@ paths:
        This method retrieves information about a list of meService resources.
        This method is typically used in "service availability query" procedure
      operationId: Services_GET
      tags:
        - services
      parameters:
        - $ref: '#/components/parameters/Query.Ser_instance_id'
        - $ref: '#/components/parameters/Query.Ser_name'
@@ -217,6 +249,8 @@ paths:
        typically used in "service availability update and new service
        registration" procedure
      operationId: Services_POST
      tags:
        - services
      responses:
        '201':
          $ref: '#/components/responses/Services.201'
@@ -236,6 +270,8 @@ paths:
        This method retrieves information about a meService resource. This
        method is typically used in "service availability query" procedure
      operationId: ServicesServiceId_GET
      tags:
        - services
      responses:
        '200':
          $ref: '#/components/responses/ServicesServiceId.200'
@@ -248,6 +284,8 @@ paths:
    put:
      description: This method updates the information about a meService resource
      operationId: ServicesServiceId_PUT
      tags:
        - services
      responses:
        '200':
          $ref: '#/components/responses/ServicesServiceId.200'
@@ -267,6 +305,8 @@ paths:
        This method retrieves the information of the platform's current time
        which corresponds to the get platform time procedure
      operationId: TimingCurrentTime_GET
      tags:
        - timing
      responses:
        '200':
          $ref: '#/components/responses/TimingCurrentTime.200'
@@ -282,6 +322,8 @@ paths:
        This method retrieves the information of the platform's timing
        capabilities which corresponds to the timing capabilities query
      operationId: TimingCaps_GET
      tags:
        - timing
      responses:
        '200':
          $ref: '#/components/responses/TimingCaps.200'
@@ -299,6 +341,8 @@ paths:
        discover transports provided by the mobile edge platform in the
        "transport information query" procedure
      operationId: Transports_GET
      tags:
        - transports
      responses:
        '200':
          $ref: '#/components/responses/Transports.200'
@@ -1649,25 +1693,44 @@ components:
        application/json:
          schema:
            $ref: '#/components/schemas/AppTerminationNotification'
      required: true
    ServiceAvailabilityNotification:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceAvailabilityNotification'
      required: true
  callbacks:
    AppTerminationNotification:
      '$request.body#/callbackReference':
      '{$request.body#/callbackReference}':
        post:
          description: >-
            Represents the information that the MEP notifies the
            subscribed application instance about the corresponding 
            application instance termination/stop
          operationId: AppTerminationNotification_POST
          tags:
            - callback
          requestBody:
            $ref: '#/components/requestBodies/AppTerminationNotification'
          responses:
            '200':
              description: Expected responses from callback consumer, if it accepts the callback
    ServiceAvailabilityNotification:
      '$request.body#/callbackReference':
      '{$request.body#/callbackReference}':
        post:
          description: >-
            'Represents the service availability information that 
            is used in the following cases
            - when the MEC platform announces the newly available
             services to the authorized relevant MEC applications (e.g. 
             the applications that indicate the services as "optional" 
             or "required") that are subscribed to the corresponding 
             service availability notifications
            -	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
          tags:
            - callback
          requestBody:
            $ref: '#/components/requestBodies/ServiceAvailabilityNotification'
          responses: