Commit 2f986c6e authored by Walter Featherstone's avatar Walter Featherstone
Browse files

Elevated path parameters to the path level, rather than method level



Change-Id: Ie5a7a2d0c8a5e6b4e64ee78e8eaf8776f94efde4
Signed-off-by: Walter Featherstone's avatarfeatherstone <walter.featherstone@viavisolutions.com>
parent b302ee8a
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
...@@ -7,7 +7,7 @@ info: ...@@ -7,7 +7,7 @@ info:
name: ETSI Forge copyright notice name: ETSI Forge copyright notice
url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt' url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
externalDocs: externalDocs:
description: ETSI GS MEC011 Application Enablement API, V1.1.1 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' url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf'
host: '127.0.0.1:8081' host: '127.0.0.1:8081'
basePath: /exampleAPI/mp1/v1/ basePath: /exampleAPI/mp1/v1/
...@@ -120,13 +120,13 @@ parameters: ...@@ -120,13 +120,13 @@ parameters:
type: string type: string
paths: paths:
'/applications/{appInstanceId}/dns_rules': '/applications/{appInstanceId}/dns_rules':
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
get: get:
description: This method retrieves information about all the DNS rules associated with a mobile edge application instance. description: This method retrieves information about all the DNS rules associated with a mobile edge application instance.
operationId: ApplicationsDnsRules.GET operationId: ApplicationsDnsRules.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
responses: responses:
'200': '200':
description: It is used to indicate nonspecific success. The response body contains a representation of the resource. description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
...@@ -138,14 +138,14 @@ paths: ...@@ -138,14 +138,14 @@ paths:
DnsRule: DnsRule:
$ref: '#/definitions/DnsRule' $ref: '#/definitions/DnsRule'
'/applications/{appInstanceId}/dns_rules/{dnsRuleId}': '/applications/{appInstanceId}/dns_rules/{dnsRuleId}':
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.DnsRuleId'
get: get:
description: This method retrieves information about a DNS rule associated with a mobile edge application instance. description: This method retrieves information about a DNS rule associated with a mobile edge application instance.
operationId: ApplicationsDnsRule.GET operationId: ApplicationsDnsRule.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.DnsRuleId'
responses: responses:
'200': '200':
description: It is used to indicate nonspecific success. The response body contains a representation of the resource. description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
...@@ -161,8 +161,6 @@ paths: ...@@ -161,8 +161,6 @@ paths:
- application/json - application/json
parameters: parameters:
- $ref: '#/parameters/Body.DnsRule' - $ref: '#/parameters/Body.DnsRule'
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.DnsRuleId'
responses: responses:
'200': '200':
description: It is used to indicate nonspecific success. The response body contains a representation of the resource. description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
...@@ -172,13 +170,13 @@ paths: ...@@ -172,13 +170,13 @@ paths:
DnsRule: DnsRule:
$ref: '#/definitions/DnsRule' $ref: '#/definitions/DnsRule'
'/applications/{appInstanceId}/subscriptions': '/applications/{appInstanceId}/subscriptions':
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
get: 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.' 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 operationId: ApplicationsSubscriptions.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
responses: responses:
'200': '200':
description: 'Upon success, a response body containing the list of links to the requested subscriptions is returned.' description: 'Upon success, a response body containing the list of links to the requested subscriptions is returned.'
...@@ -193,7 +191,6 @@ paths: ...@@ -193,7 +191,6 @@ paths:
produces: produces:
- application/json - application/json
parameters: parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Body.AppTerminationNotificationSubscription' - $ref: '#/parameters/Body.AppTerminationNotificationSubscription'
responses: responses:
'200': '200':
...@@ -204,15 +201,15 @@ paths: ...@@ -204,15 +201,15 @@ paths:
AppTerminationNotificationSubscription: AppTerminationNotificationSubscription:
$ref: '#/definitions/AppTerminationNotificationSubscription.Response' $ref: '#/definitions/AppTerminationNotificationSubscription.Response'
'/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}': '/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}':
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.SubscriptionType'
- $ref: '#/parameters/Path.SubscriptionId'
get: 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.' 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 operationId: ApplicationsSubscription.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.SubscriptionType'
- $ref: '#/parameters/Path.SubscriptionId'
responses: responses:
'200': '200':
description: 'Upon success, a response body containing the requested subscription is returned.' description: 'Upon success, a response body containing the requested subscription is returned.'
...@@ -230,13 +227,13 @@ paths: ...@@ -230,13 +227,13 @@ paths:
'204': '204':
description: No Content description: No Content
'/applications/{appInstanceId}/traffic_rules': '/applications/{appInstanceId}/traffic_rules':
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
get: get:
description: This method retrieves information about all the traffic rules associated with a mobile edge application instance. description: This method retrieves information about all the traffic rules associated with a mobile edge application instance.
operationId: ApplicationsTrafficRules.GET operationId: ApplicationsTrafficRules.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
responses: responses:
'200': '200':
description: It is used to indicate nonspecific success. The response body contains a representation of the resource. description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
...@@ -248,14 +245,14 @@ paths: ...@@ -248,14 +245,14 @@ paths:
TrafficRule: TrafficRule:
$ref: '#/definitions/TrafficRule' $ref: '#/definitions/TrafficRule'
'/applications/{appInstanceId}/traffic_rules/{trafficRuleId}': '/applications/{appInstanceId}/traffic_rules/{trafficRuleId}':
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.TrafficRuleId'
get: get:
description: This method retrieves information about all the traffic rules associated with a mobile edge application instance. description: This method retrieves information about all the traffic rules associated with a mobile edge application instance.
operationId: ApplicationsTrafficRule.GET operationId: ApplicationsTrafficRule.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.TrafficRuleId'
responses: responses:
'200': '200':
description: It is used to indicate nonspecific success. The response body contains a representation of the resource. description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
...@@ -271,8 +268,6 @@ paths: ...@@ -271,8 +268,6 @@ paths:
- application/json - application/json
parameters: parameters:
- $ref: '#/parameters/Body.TrafficRule' - $ref: '#/parameters/Body.TrafficRule'
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.TrafficRuleId'
responses: responses:
'200': '200':
description: 'Upon success, a response body containing data type describing the updated TrafficRule is returned.' description: 'Upon success, a response body containing data type describing the updated TrafficRule is returned.'
...@@ -317,13 +312,13 @@ paths: ...@@ -317,13 +312,13 @@ paths:
ServiceInfo: ServiceInfo:
$ref: '#/definitions/ServiceInfo' $ref: '#/definitions/ServiceInfo'
'/services/{serviceId}': '/services/{serviceId}':
parameters:
- $ref: '#/parameters/Path.ServiceId'
get: get:
description: This method retrieves information about a meService resource. This method is typically used in "service availability query" procedure description: This method retrieves information about a meService resource. This method is typically used in "service availability query" procedure
operationId: ServicesServiceId.GET operationId: ServicesServiceId.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.ServiceId'
responses: responses:
'200': '200':
description: It is used to indicate nonspecific success. The response body contains a representation of the resource. description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
...@@ -369,7 +364,6 @@ paths: ...@@ -369,7 +364,6 @@ paths:
produces: produces:
- application/json - application/json
parameters: parameters:
- $ref: '#/parameters/Path.ServiceId'
- $ref: '#/parameters/Body.ServiceInfo' - $ref: '#/parameters/Body.ServiceInfo'
responses: responses:
'200': '200':
...@@ -739,7 +733,7 @@ definitions: ...@@ -739,7 +733,7 @@ definitions:
type: string type: string
format: uri format: uri
rel: rel:
description: The values are as defined in the ÔÇ£subscriptionTypeÔÇØ attribute for each different Mp1 event subscription data type. description: The values are as defined in the "subscriptionType" attribute for each different Mp1 event subscription data type.
type: string type: string
Mp1SubscriptionLinkList: Mp1SubscriptionLinkList:
description: This type represents a list of links related to currently existing subscriptions for a mobile edge application instance. This information is returned when sending a request to receive current subscriptions. description: This type represents a list of links related to currently existing subscriptions for a mobile edge application instance. This information is returned when sending a request to receive current subscriptions.
...@@ -852,7 +846,7 @@ definitions: ...@@ -852,7 +846,7 @@ definitions:
- INACTIVE - INACTIVE
example: ACTIVE example: ACTIVE
ServiceInfo.TransportId: ServiceInfo.TransportId:
description: 'Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the ÔÇ£Transport information queryÔÇØ procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.' description: 'Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the "Transport information query" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.'
type: string type: string
example: Rest1 example: Rest1
ServiceInfo.Version: ServiceInfo.Version:
......
...@@ -9,6 +9,6 @@ properties: ...@@ -9,6 +9,6 @@ properties:
type: string type: string
format: uri format: uri
rel: rel:
description: The values are as defined in the subscriptionType attribute for each different Mp1 event subscription data type. description: The values are as defined in the "subscriptionType" attribute for each different Mp1 event subscription data type.
type: string type: string
description: Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the Transport information query procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise. description: Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the "Transport information query" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.
type: string type: string
example: Rest1 example: Rest1
\ No newline at end of file
...@@ -2,9 +2,6 @@ description: This method retrieves information about a DNS rule associated with ...@@ -2,9 +2,6 @@ description: This method retrieves information about a DNS rule associated with
operationId: ApplicationsDnsRule.GET operationId: ApplicationsDnsRule.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.DnsRuleId'
responses: responses:
200: 200:
......
...@@ -4,8 +4,6 @@ produces: ...@@ -4,8 +4,6 @@ produces:
- application/json - application/json
parameters: parameters:
- $ref: '#/parameters/Body.DnsRule' - $ref: '#/parameters/Body.DnsRule'
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.DnsRuleId'
responses: responses:
200: 200:
......
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.DnsRuleId'
get: get:
$ref: ./ApplicationsDnsRule.GET.yaml $ref: ./ApplicationsDnsRule.GET.yaml
......
...@@ -2,8 +2,6 @@ description: This method retrieves information about all the DNS rules associate ...@@ -2,8 +2,6 @@ description: This method retrieves information about all the DNS rules associate
operationId: ApplicationsDnsRules.GET operationId: ApplicationsDnsRules.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
responses: responses:
200: 200:
......
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
get: get:
$ref: ./ApplicationsDnsRules.GET.yaml $ref: ./ApplicationsDnsRules.GET.yaml
\ No newline at end of file
...@@ -2,10 +2,6 @@ description: The GET method requests information about a subscription for this r ...@@ -2,10 +2,6 @@ description: The GET method requests information about a subscription for this r
operationId: ApplicationsSubscription.GET operationId: ApplicationsSubscription.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.SubscriptionType'
- $ref: '#/parameters/Path.SubscriptionId'
responses: responses:
200: 200:
......
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.SubscriptionType'
- $ref: '#/parameters/Path.SubscriptionId'
get: get:
$ref: ./ApplicationsSubscription.GET.yaml $ref: ./ApplicationsSubscription.GET.yaml
......
...@@ -2,8 +2,6 @@ description: The GET method may be used to request information about all subscri ...@@ -2,8 +2,6 @@ description: The GET method may be used to request information about all subscri
operationId: ApplicationsSubscriptions.GET operationId: ApplicationsSubscriptions.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
responses: responses:
200: 200:
......
...@@ -3,7 +3,6 @@ operationId: ApplicationsSubscriptions.POST ...@@ -3,7 +3,6 @@ operationId: ApplicationsSubscriptions.POST
produces: produces:
- application/json - application/json
parameters: parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Body.AppTerminationNotificationSubscription' - $ref: '#/parameters/Body.AppTerminationNotificationSubscription'
# The alternative request # The alternative request
#- $ref: '#/parameters/Body.SerAvailabilityNotificationSubscription' #- $ref: '#/parameters/Body.SerAvailabilityNotificationSubscription'
......
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
get: get:
$ref: ./ApplicationsSubscriptions.GET.yaml $ref: ./ApplicationsSubscriptions.GET.yaml
......
...@@ -2,9 +2,6 @@ description: This method retrieves information about all the traffic rules assoc ...@@ -2,9 +2,6 @@ description: This method retrieves information about all the traffic rules assoc
operationId: ApplicationsTrafficRule.GET operationId: ApplicationsTrafficRule.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.TrafficRuleId'
responses: responses:
200: 200:
......
...@@ -4,8 +4,6 @@ produces: ...@@ -4,8 +4,6 @@ produces:
- application/json - application/json
parameters: parameters:
- $ref: '#/parameters/Body.TrafficRule' - $ref: '#/parameters/Body.TrafficRule'
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.TrafficRuleId'
responses: responses:
200: 200:
......
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.TrafficRuleId'
get: get:
$ref: ./ApplicationsTrafficRule.GET.yaml $ref: ./ApplicationsTrafficRule.GET.yaml
......
...@@ -2,8 +2,6 @@ description: This method retrieves information about all the traffic rules assoc ...@@ -2,8 +2,6 @@ description: This method retrieves information about all the traffic rules assoc
operationId: ApplicationsTrafficRules.GET operationId: ApplicationsTrafficRules.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
responses: responses:
200: 200:
......
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
get: get:
$ref: ./ApplicationsTrafficRules.GET.yaml $ref: ./ApplicationsTrafficRules.GET.yaml
\ No newline at end of file
...@@ -2,8 +2,7 @@ description: This method retrieves information about a meService resource. This ...@@ -2,8 +2,7 @@ description: This method retrieves information about a meService resource. This
operationId: ServicesServiceId.GET operationId: ServicesServiceId.GET
produces: produces:
- application/json - application/json
parameters:
- $ref: '#/parameters/Path.ServiceId'
responses: responses:
200: 200:
description: It is used to indicate nonspecific success. The response body contains a representation of the resource. description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment