Skip to content
GitLab
Commit d7e6abb2 authored by Michele Carignani's avatar Michele Carignani
Browse files

replacing dots with underscores in operationIds

parent 1f01c74f
Hide whitespace changes
Inline Side-by-side
Mp1.json
View file @ d7e6abb2
......@@ -156,7 +156,7 @@
],
"get": {
"description": "This method retrieves information about all the DNS rules associated with a mobile edge application instance.",
"operationId": "ApplicationsDnsRules.GET",
"operationId": "ApplicationsDnsRules_GET",
"produces": [
"application/json"
],
......@@ -237,7 +237,7 @@
],
"get": {
"description": "This method retrieves information about a DNS rule associated with a mobile edge application instance.",
"operationId": "ApplicationsDnsRule.GET",
"operationId": "ApplicationsDnsRule_GET",
"produces": [
"application/json"
],
......@@ -305,7 +305,7 @@
},
"put": {
"description": "This method activates, de-activates or updates a traffic rule.",
"operationId": "ApplicationsDnsRule.PUT",
"operationId": "ApplicationsDnsRule_PUT",
"produces": [
"application/json"
],
......@@ -396,7 +396,7 @@
],
"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",
"operationId": "ApplicationsSubscriptions_GET",
"produces": [
"application/json"
],
......@@ -452,7 +452,7 @@
},
"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",
"operationId": "ApplicationsSubscriptions_POST",
"produces": [
"application/json"
],
......@@ -533,7 +533,7 @@
],
"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",
"operationId": "ApplicationsSubscription_GET",
"produces": [
"application/json"
],
......@@ -589,7 +589,7 @@
},
"delete": {
"description": "This method deletes a meMp1Subscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
"operationId": "ApplicationsSubscription.DELETE",
"operationId": "ApplicationsSubscription_DELETE",
"produces": [
"application/json"
],
......@@ -633,7 +633,7 @@
],
"get": {
"description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
"operationId": "ApplicationsTrafficRules.GET",
"operationId": "ApplicationsTrafficRules_GET",
"produces": [
"application/json"
],
......@@ -730,7 +730,7 @@
],
"get": {
"description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
"operationId": "ApplicationsTrafficRule.GET",
"operationId": "ApplicationsTrafficRule_GET",
"produces": [
"application/json"
],
......@@ -814,7 +814,7 @@
},
"put": {
"description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
"operationId": "ApplicationsTrafficRules.PUT",
"operationId": "ApplicationsTrafficRules_PUT",
"produces": [
"application/json"
],
......@@ -916,7 +916,7 @@
"/services": {
"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",
"operationId": "Services_GET",
"produces": [
"application/json"
],
......@@ -1029,7 +1029,7 @@
},
"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",
"operationId": "Services_POST",
"produces": [
"application/json"
],
......@@ -1147,7 +1147,7 @@
],
"get": {
"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": [
"application/json"
],
......@@ -1246,7 +1246,7 @@
},
"put": {
"description": "This method updates the information about a meService resource",
"operationId": "ServicesServiceId.PUT",
"operationId": "ServicesServiceId_PUT",
"produces": [
"application/json"
],
......@@ -1363,7 +1363,7 @@
"/timing/current_time": {
"get": {
"description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
"operationId": "TimingCurrentTime.GET",
"operationId": "TimingCurrentTime_GET",
"produces": [
"application/json"
],
......@@ -1421,7 +1421,7 @@
"/timing/timing_caps": {
"get": {
"description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
"operationId": "TimingCaps.GET",
"operationId": "TimingCaps_GET",
"produces": [
"application/json"
],
......@@ -1479,7 +1479,7 @@
"/transports": {
"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",
"operationId": "Transports_GET",
"produces": [
"application/json"
],
......@@ -2638,4 +2638,4 @@
}
}
}
}
\ No newline at end of file
}
Mp1.yaml
View file @ d7e6abb2
......@@ -8,7 +8,8 @@ info:
url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
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'
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'
basePath: /exampleAPI/mp1/v1/
schemes:
......@@ -21,7 +22,9 @@ produces:
parameters:
Body.AppTerminationNotificationSubscription:
name: AppTerminationNotificationSubscription
description: Entity body in the request contains a subscription to the mobile edge application termination notifications that is to be created.
description: >-
Entity body in the request contains a subscription to the mobile edge
application termination notifications that is to be created.
in: body
required: true
schema:
......@@ -35,14 +38,18 @@ parameters:
$ref: '#/definitions/DnsRule'
Body.SerAvailabilityNotificationSubscription:
name: SerAvailabilityNotificationSubscription
description: Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created.
description: >-
Entity body in the request contains a subscription to the mobile edge
service availability notifications that is to be created.
in: body
required: true
schema:
$ref: '#/definitions/SerAvailabilityNotificationSubscription'
Body.ServiceInfo:
name: ServiceInfo
description: New ServiceInfo with updated "state" is included as entity body of the request
description: >-
New ServiceInfo with updated "state" is included as entity body of the
request
in: body
required: true
schema:
......@@ -56,7 +63,9 @@ parameters:
$ref: '#/definitions/TrafficRule'
Path.AppInstanceId:
name: appInstanceId
description: Represents a mobile edge application instance. Note that the appInstanceId is allocated by the mobile edge platform manager.
description: >-
Represents a mobile edge application instance. Note that the appInstanceId
is allocated by the mobile edge platform manager.
in: path
required: true
type: string
......@@ -70,14 +79,18 @@ parameters:
format: uri
Path.SubscriptionId:
name: subscriptionId
description: Represents a subscription to the notifications from the mobile edge platform.
description: >-
Represents a subscription to the notifications from the mobile edge
platform.
in: path
required: true
type: string
format: uri
Path.SubscriptionType:
name: subscriptionType
description: Represents a subscription type to the notifications from the mobile edge platform.
description: >-
Represents a subscription type to the notifications from the mobile edge
platform.
in: path
required: true
type: string
......@@ -98,13 +111,21 @@ parameters:
format: uri
Query.Ser_category_id:
name: ser_category_id
description: A mobile edge application instance may use ser_category_id as an input parameter to query the availability of a list of mobile edge service instances in a serCategory. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
description: >-
A mobile edge application instance may use ser_category_id as an input
parameter to query the availability of a list of mobile edge service
instances in a serCategory. Either "ser_instance_id" or "ser_name" or
"ser_category_id" or none of them shall be present.
in: query
required: false
type: string
Query.Ser_instance_id:
name: ser_instance_id
description: A mobile edge application instance may use multiple ser_instance_ids as an input parameter to query the availability of a list of mobile edge service instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
description: >-
A mobile edge application instance may use multiple ser_instance_ids as an
input parameter to query the availability of a list of mobile edge service
instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or
none of them shall be present.
in: query
required: false
type: array
......@@ -112,7 +133,11 @@ parameters:
type: string
Query.Ser_name:
name: ser_name
description: A mobile edge application instance may use multiple ser_names as an input parameter to query the availability of a list of mobile edge service instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
description: >-
A mobile edge application instance may use multiple ser_names as an input
parameter to query the availability of a list of mobile edge service
instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or
none of them shall be present.
in: query
required: false
type: array
......@@ -123,13 +148,17 @@ paths:
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
get:
description: This method retrieves information about all the DNS rules associated with a mobile edge application instance.
operationId: ApplicationsDnsRules.GET
description: >-
This method retrieves information about all the DNS rules associated
with a mobile edge application instance.
operationId: ApplicationsDnsRules_GET
produces:
- application/json
responses:
'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.
schema:
type: array
items:
......@@ -174,13 +203,17 @@ paths:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.DnsRuleId'
get:
description: This method retrieves information about a DNS rule associated with a mobile edge application instance.
operationId: ApplicationsDnsRule.GET
description: >-
This method retrieves information about a DNS rule associated with a
mobile edge application instance.
operationId: ApplicationsDnsRule_GET
produces:
- application/json
responses:
'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.
schema:
type: object
properties:
......@@ -220,14 +253,16 @@ paths:
$ref: '#/definitions/ProblemDetails'
put:
description: 'This method activates, de-activates or updates a traffic rule.'
operationId: ApplicationsDnsRule.PUT
operationId: ApplicationsDnsRule_PUT
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.DnsRule'
responses:
'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.
schema:
type: object
properties:
......@@ -276,13 +311,18 @@ paths:
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
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
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
produces:
- application/json
responses:
'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.
schema:
type: object
properties:
......@@ -312,17 +352,23 @@ paths:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
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
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
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.AppTerminationNotificationSubscription'
responses:
'201':
description: Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created.
description: >-
Entity body in the request contains a subscription to the mobile
edge service availability notifications that is to be created.
headers:
location:
location:
description: The resource URI of the created resource
type: string
format: uri
......@@ -360,13 +406,18 @@ paths:
- $ref: '#/parameters/Path.SubscriptionType'
- $ref: '#/parameters/Path.SubscriptionId'
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
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
produces:
- application/json
responses:
'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.
schema:
type: object
properties:
......@@ -396,8 +447,11 @@ paths:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
delete:
description: This method deletes a meMp1Subscription. This method is typically used in "Unsubscribing from service availability event notifications" procedure.
operationId: ApplicationsSubscription.DELETE
description: >-
This method deletes a meMp1Subscription. This method is typically used
in "Unsubscribing from service availability event notifications"
procedure.
operationId: ApplicationsSubscription_DELETE
produces:
- application/json
responses:
......@@ -423,13 +477,17 @@ paths:
parameters:
- $ref: '#/parameters/Path.AppInstanceId'
get:
description: This method retrieves information about all the traffic rules associated with a mobile edge application instance.
operationId: ApplicationsTrafficRules.GET
description: >-
This method retrieves information about all the traffic rules associated
with a mobile edge application instance.
operationId: ApplicationsTrafficRules_GET
produces:
- application/json
responses:
'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.
schema:
type: array
items:
......@@ -485,13 +543,17 @@ paths:
- $ref: '#/parameters/Path.AppInstanceId'
- $ref: '#/parameters/Path.TrafficRuleId'
get:
description: This method retrieves information about all the traffic rules associated with a mobile edge application instance.
operationId: ApplicationsTrafficRule.GET
description: >-
This method retrieves information about all the traffic rules associated
with a mobile edge application instance.
operationId: ApplicationsTrafficRule_GET
produces:
- application/json
responses:
'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.
schema:
type: object
properties:
......@@ -541,15 +603,19 @@ paths:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
put:
description: This method retrieves information about all the traffic rules associated with a mobile edge application instance.
operationId: ApplicationsTrafficRules.PUT
description: >-
This method retrieves information about all the traffic rules associated
with a mobile edge application instance.
operationId: ApplicationsTrafficRules_PUT
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.TrafficRule'
responses:
'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.
schema:
type: object
properties:
......@@ -607,8 +673,10 @@ paths:
$ref: '#/definitions/ProblemDetails'
/services:
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
description: >-
This method retrieves information about a list of meService resources.
This method is typically used in "service availability query" procedure
operationId: Services_GET
produces:
- application/json
parameters:
......@@ -617,7 +685,9 @@ paths:
- $ref: '#/parameters/Query.Ser_category_id'
responses:
'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.
schema:
type: array
items:
......@@ -680,17 +750,22 @@ paths:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
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
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
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.ServiceInfo'
responses:
'201':
description: 'Upon success, the HTTP response shall include a Location HTTP header that contains the resource URI of the created resource.'
description: >-
Upon success, the HTTP response shall include a Location HTTP header
that contains the resource URI of the created resource.
headers:
location:
location:
description: The resource URI of the created resource
type: string
format: uri
......@@ -757,13 +832,17 @@ paths:
parameters:
- $ref: '#/parameters/Path.ServiceId'
get:
description: This method retrieves information about a meService resource. This method is typically used in "service availability query" procedure
operationId: ServicesServiceId.GET
description: >-
This method retrieves information about a meService resource. This
method is typically used in "service availability query" procedure
operationId: ServicesServiceId_GET
produces:
- application/json
responses:
'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.
schema:
type: object
properties:
......@@ -825,14 +904,16 @@ paths:
$ref: '#/definitions/ProblemDetails'
put:
description: This method updates the information about a meService resource
operationId: ServicesServiceId.PUT
operationId: ServicesServiceId_PUT
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.ServiceInfo'
responses:
'200':
description: 'Upon success, a response body containing data type describing the updated ServiceInfo is returned'
description: >-
Upon success, a response body containing data type describing the
updated ServiceInfo is returned
schema:
type: object
properties:
......@@ -901,13 +982,17 @@ paths:
$ref: '#/definitions/ProblemDetails'
/timing/current_time:
get:
description: This method retrieves the information of the platform's current time which corresponds to the get platform time procedure
operationId: TimingCurrentTime.GET
description: >-
This method retrieves the information of the platform's current time
which corresponds to the get platform time procedure
operationId: TimingCurrentTime_GET
produces:
- application/json
responses:
'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.
schema:
type: object
properties:
......@@ -938,13 +1023,17 @@ paths:
$ref: '#/definitions/ProblemDetails'
/timing/timing_caps:
get:
description: This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query
operationId: TimingCaps.GET
description: >-
This method retrieves the information of the platform's timing
capabilities which corresponds to the timing capabilities query
operationId: TimingCaps_GET
produces:
- application/json
responses:
'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.
schema:
type: object
properties:
......@@ -975,13 +1064,19 @@ paths:
$ref: '#/definitions/ProblemDetails'
/transports:
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
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
produces:
- application/json
responses:
'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.
schema:
type: array
items:
......@@ -1014,7 +1109,9 @@ paths:
$ref: '#/definitions/ProblemDetails'
definitions:
AppTerminationNotification.MaxGracefulTimeout:
description: Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.
description: >-
Maximum timeout value in seconds for graceful termination or graceful stop
of an application instance.
type: string
format: uint32
example: 10
......@@ -1023,7 +1120,10 @@ definitions:
type: string
example: AppTerminationNotification
AppTerminationNotification:
description: This type represents the information that the mobile edge platform notifies the subscribed application instance about the corresponding application instance termination/stop.
description: >-
This type represents the information that the mobile edge platform
notifies the subscribed application instance about the corresponding
application instance termination/stop.
type: object
required:
- notificationType
......@@ -1041,11 +1141,18 @@ definitions:
type: string
example: ID1
AppTerminationNotificationSubscription.CallbackReference:
description: URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge application instance management information. This shall be included in both the request and the response.
description: >-