diff --git a/Mp1.json b/Mp1.json index bf3492f0cd75cf60af1c3d58b4e1598dcad04f23..e6504ccc2bbcc2199df458cdc54a3f1c9db9a01e 100644 --- a/Mp1.json +++ b/Mp1.json @@ -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" ], @@ -239,7 +239,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" ], @@ -307,7 +307,7 @@ }, "put": { "description": "This method activates, de-activates or updates a traffic rule.", - "operationId": "ApplicationsDnsRule.PUT", + "operationId": "ApplicationsDnsRule_PUT", "produces": [ "application/json" ], @@ -398,7 +398,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" ], @@ -454,7 +454,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" ], @@ -535,7 +535,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" ], @@ -591,7 +591,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" ], @@ -635,7 +635,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" ], @@ -736,7 +736,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" ], @@ -822,7 +822,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" ], @@ -926,7 +926,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" ], @@ -1041,7 +1041,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" ], @@ -1159,7 +1159,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" ], @@ -1258,7 +1258,7 @@ }, "put": { "description": "This method updates the information about a meService resource", - "operationId": "ServicesServiceId.PUT", + "operationId": "ServicesServiceId_PUT", "produces": [ "application/json" ], @@ -1375,7 +1375,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" ], @@ -1433,7 +1433,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" ], @@ -1491,7 +1491,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" ], @@ -2653,4 +2653,4 @@ } } } -} \ No newline at end of file +} diff --git a/Mp1.yaml b/Mp1.yaml index 037848e81a97533371508759b3e487c997f03030..4b447a70f1926cbf98af0b40450efee4bf5f4180 100644 --- a/Mp1.yaml +++ b/Mp1.yaml @@ -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: @@ -1023,7 +1118,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 +1139,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: >- + 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. type: string format: uri AppTerminationNotificationSubscription: - 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: - subscriptionType @@ -1099,7 +1204,9 @@ definitions: version: $ref: '#/definitions/CategoryRef.Version' CurrentTime: - description: This type represents the information provided by the mobile edge platform in response to the Get Platform Time Request message. + description: >- + This type represents the information provided by the mobile edge platform + in response to the Get Platform Time Request message. type: object required: - nanoSeconds @@ -1109,12 +1216,16 @@ definitions: seconds: type: integer format: uint32 - description: 'The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC' + description: >- + The seconds part of the time. Time is defined as Unix-time since + January 1, 1970, 00:00:00 UTC example: 1577836800 nanoSeconds: type: integer format: uint32 - description: 'The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC' + description: >- + The nanoseconds part of the time. Time is defined as Unix-time since + January 1, 1970, 00:00:00 UTC example: 0 timeSourceStatus: type: string @@ -1226,12 +1337,16 @@ definitions: port: $ref: '#/definitions/EndPointInfo.Address.Port' EndPointInfo.Addresses: - description: Entry point information of the service as one or more pairs of IP address and port + description: >- + Entry point information of the service as one or more pairs of IP address + and port type: array items: $ref: '#/definitions/EndPointInfo.Address' EndPointInfo.Alternative: - description: 'Entry point information of the service in a format defined by an implementation, or in an external specification.' + description: >- + Entry point information of the service in a format defined by an + implementation, or in an external specification. type: object EndPointInfo.Uri: description: Entry point information of the service @@ -1239,7 +1354,9 @@ definitions: format: uri example: '/meMp1/service/EntryPoint' EndPointInfo.Uris: - description: 'Entry point information of the service as string, formatted according to URI syntax' + description: >- + Entry point information of the service as string, formatted according to + URI syntax type: array items: $ref: '#/definitions/EndPointInfo.Uri' @@ -1284,10 +1401,15 @@ definitions: type: string format: uri 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 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. type: object required: - _links @@ -1324,7 +1446,9 @@ definitions: Problem.type: type: string format: uri - description: A URI reference according to IETF RFC 3986 that identifies the problem type + description: >- + A URI reference according to IETF RFC 3986 that identifies the problem + type SecurityInfo.OAuth2Info.GrantTypes: description: List of supported OAuth 2.0 grant types type: string @@ -1367,11 +1491,17 @@ definitions: $ref: '#/definitions/LinkType' readOnly: true SerAvailabilityNotificationSubscription.CallbackReference: - description: URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge service availability information. This shall be included in both the request and the response. + description: >- + URI selected by the mobile edge application instance to receive + notifications on the subscribed mobile edge service availability + information. This shall be included in both the request and the response. type: string format: uri SerAvailabilityNotificationSubscription: - description: This type represents a subscription to the notifications from the mobile edge platform regarding the availability of a mobile edge service or a list of mobile edge services. + description: >- + This type represents a subscription to the notifications from the mobile + edge platform regarding the availability of a mobile edge service or a + list of mobile edge services. type: object required: - subscriptionType @@ -1382,7 +1512,8 @@ definitions: subscriptionType: $ref: '#/definitions/SerAvailabilityNotificationSubscription.SubscriptionType' callbackReference: - $ref: '#/definitions/SerAvailabilityNotificationSubscription.CallbackReference' + $ref: >- + #/definitions/SerAvailabilityNotificationSubscription.CallbackReference _links: $ref: '#/definitions/Self' filteringCriteria: @@ -1400,11 +1531,15 @@ definitions: - PROTOBUF3 example: 'JSON' ServiceInfo.SerInstanceId: - description: Identifier of the service instance assigned by the MEPM / mobile edge platform. + description: >- + Identifier of the service instance assigned by the MEPM / mobile edge + platform. type: string example: 'ServiceInstance123' ServiceInfo.SerName: - description: The name of the service. This is how the service producing mobile edge application identifies the service instance it produces. + description: >- + The name of the service. This is how the service producing mobile edge + application identifies the service instance it produces. type: string example: 'ExampleService' ServiceInfo.State: @@ -1415,7 +1550,12 @@ definitions: - INACTIVE example: 'ACTIVE' 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 example: 'Rest1' ServiceInfo.Version: @@ -1479,12 +1619,16 @@ definitions: format: uint32 example: 1 TimingCaps.NtpServers.MaxPollingInterval: - description: 'Maximum poll interval for NTP messages, in seconds as a power of two. Range 3...17' + description: >- + Maximum poll interval for NTP messages, in seconds as a power of two. + Range 3...17 type: integer format: uint32 example: 17 TimingCaps.NtpServers.MinPollingInterval: - description: 'Minimum poll interval for NTP messages, in seconds as a power of two. Range 3...17' + description: >- + Minimum poll interval for NTP messages, in seconds as a power of two. + Range 3...17 type: integer format: uint32 example: 3 @@ -1558,15 +1702,21 @@ definitions: seconds: type: integer format: uint32 - description: 'The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC' + description: >- + The seconds part of the time. Time is defined as Unix-time since + January 1, 1970, 00:00:00 UTC example: 1577836800 nanoSeconds: type: integer format: uint32 - description: 'The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC' + description: >- + The nanoseconds part of the time. Time is defined as Unix-time since + January 1, 1970, 00:00:00 UTC example: 0 TimingCaps: - description: This type represents the information provided by the mobile edge platform in response to the Timing capabilities Query message. + description: >- + This type represents the information provided by the mobile edge platform + in response to the Timing capabilities Query message. type: object properties: timeStamp: @@ -1586,7 +1736,9 @@ definitions: type: string example: '192.168.1.1' TrafficFilter.DSCP: - description: Used to match all IPv4 packets that have the same Differentiated Services Code Point (DSCP) + description: >- + Used to match all IPv4 packets that have the same Differentiated Services + Code Point (DSCP) type: integer format: uint32 example: 0 @@ -1599,7 +1751,9 @@ definitions: type: string example: '?' TrafficFilter.QCI: - description: Used to match all packets that have the same Quality Class Indicator (QCI). + description: >- + Used to match all packets that have the same Quality Class Indicator + (QCI). type: integer format: uint32 example: 1 @@ -1625,12 +1779,20 @@ definitions: type: object properties: srcAddress: - description: 'An IP address or a range of IP address. For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses. For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.' + description: >- + An IP address or a range of IP address. For IPv4, the IP address could + be an IP address plus mask, or an individual IP address, or a range of + IP addresses. For IPv6, the IP address could be an IP prefix, or a + range of IP prefixes. type: array items: $ref: '#/definitions/TrafficFilter.Address' dstAddress: - description: 'An IP address or a range of IP address. For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses. For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.' + description: >- + An IP address or a range of IP address. For IPv4, the IP address could + be an IP address plus mask, or an individual IP address, or a range of + IP addresses. For IPv6, the IP address could be an IP prefix, or a + range of IP prefixes. type: array items: $ref: '#/definitions/TrafficFilter.Address' @@ -1681,7 +1843,9 @@ definitions: tC: $ref: '#/definitions/TrafficFilter.TC' TrafficRule.Action: - description: The action of the ME host data plane when a packet matches the trafficFilter + description: >- + The action of the ME host data plane when a packet matches the + trafficFilter type: string enum: - DROP @@ -1692,7 +1856,9 @@ definitions: - DUPLICATE_AS_IS example: 'DROP' TrafficRule.FilterType: - description: Definition of filter per FLOW or PACKET. If flow the filter match UE->EPC packet and the reverse packet is handled in the same context + description: >- + Definition of filter per FLOW or PACKET. If flow the filter match UE->EPC + packet and the reverse packet is handled in the same context type: string enum: - FLOW @@ -1703,7 +1869,9 @@ definitions: type: string example: 'TrafficRule1' TrafficRule.Priority: - description: 'Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence' + description: >- + Priority of this traffic rule. If traffic rule conflicts, the one with + higher priority take precedence type: integer format: uint32 example: 1 diff --git a/README.md b/README.md index f0d08e417a4a675d642ba77a834559c5827c49e5..33fecac32f3dc70d23955f16562d968f01d232e2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Mobile Edge Platform Application Enablement API +# Multi-access Edge Computing (MEC); MEC Platform Application Enablement API This repository contains OpenAPIs descriptions for the interfaces specified in ETSI GS MEC 011. @@ -12,7 +12,7 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E ## ETSI Forge Copyright statement -Copyright (c) ETSI 2018. +Copyright (c) ETSI 2019. This software is subject to copyrights owned by ETSI. Non-exclusive permission is hereby granted, free of charge, to copy, reproduce and amend this file diff --git a/paths/ApplicationsDnsRule.GET.yaml b/paths/ApplicationsDnsRule.GET.yaml index 392df9bc63441700ad20818632274db8fa211039..ef4b631e480b7550164eb01190b752ffc410811e 100644 --- a/paths/ApplicationsDnsRule.GET.yaml +++ b/paths/ApplicationsDnsRule.GET.yaml @@ -1,5 +1,5 @@ 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 diff --git a/paths/ApplicationsDnsRule.PUT.yaml b/paths/ApplicationsDnsRule.PUT.yaml index d916e95f97908346d327f68a414884b614e8c914..826142f822ec4511cbaa698d7998a40581da36a8 100644 --- a/paths/ApplicationsDnsRule.PUT.yaml +++ b/paths/ApplicationsDnsRule.PUT.yaml @@ -1,5 +1,5 @@ description: This method activates, de-activates or updates a traffic rule. -operationId: ApplicationsDnsRule.PUT +operationId: ApplicationsDnsRule_PUT produces: - application/json parameters: diff --git a/paths/ApplicationsDnsRules.GET.yaml b/paths/ApplicationsDnsRules.GET.yaml index 490aee82fd3614ef48001987b5d3745cc6737ee6..ea3bffea3a5fd004c80485d4b78b5aad343f5b5a 100644 --- a/paths/ApplicationsDnsRules.GET.yaml +++ b/paths/ApplicationsDnsRules.GET.yaml @@ -1,5 +1,5 @@ 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 diff --git a/paths/ApplicationsSubscription.DELETE.yaml b/paths/ApplicationsSubscription.DELETE.yaml index ca094f6da81619306625a6a205bdc66ea598016e..65050a28c1dc292ee6e91452eabc28a6d916ecca 100644 --- a/paths/ApplicationsSubscription.DELETE.yaml +++ b/paths/ApplicationsSubscription.DELETE.yaml @@ -1,5 +1,5 @@ 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 diff --git a/paths/ApplicationsSubscription.GET.yaml b/paths/ApplicationsSubscription.GET.yaml index c43f3c18ca990a76e4422560efba73a2ceb5fb79..b2ef5ad1eee41ba6b0fa33f3efc4d935043c421f 100644 --- a/paths/ApplicationsSubscription.GET.yaml +++ b/paths/ApplicationsSubscription.GET.yaml @@ -1,5 +1,5 @@ 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 diff --git a/paths/ApplicationsSubscriptions.GET.yaml b/paths/ApplicationsSubscriptions.GET.yaml index bb6717194ececbcf86a3c3a7c5bb867b1723bffb..8553d511658009f7f90722f455a5a868da087cee 100644 --- a/paths/ApplicationsSubscriptions.GET.yaml +++ b/paths/ApplicationsSubscriptions.GET.yaml @@ -1,5 +1,5 @@ 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 diff --git a/paths/ApplicationsSubscriptions.POST.yaml b/paths/ApplicationsSubscriptions.POST.yaml index 591271ba605feb96f03533376f93ef644a8eab33..ff02e655194e79c4dc6683f4bd286d586d2f414a 100644 --- a/paths/ApplicationsSubscriptions.POST.yaml +++ b/paths/ApplicationsSubscriptions.POST.yaml @@ -1,5 +1,5 @@ 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 parameters: diff --git a/paths/ApplicationsTrafficRule.GET.yaml b/paths/ApplicationsTrafficRule.GET.yaml index 8b20a8c21b38b7ad460b8ec7ab8b05012cb4b555..0201600c561575df01e0cd46300cba2cfc453bdc 100644 --- a/paths/ApplicationsTrafficRule.GET.yaml +++ b/paths/ApplicationsTrafficRule.GET.yaml @@ -1,5 +1,5 @@ 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 diff --git a/paths/ApplicationsTrafficRule.PUT.yaml b/paths/ApplicationsTrafficRule.PUT.yaml index 4eaa30be57af81cfa44962372451d105aee4d0f1..8b448a2ace15eac6b911f41ffad403418596c4af 100644 --- a/paths/ApplicationsTrafficRule.PUT.yaml +++ b/paths/ApplicationsTrafficRule.PUT.yaml @@ -1,5 +1,5 @@ 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 parameters: diff --git a/paths/ApplicationsTrafficRules.GET.yaml b/paths/ApplicationsTrafficRules.GET.yaml index 137d1bf70dc4000ed162a7af8071378b4d7cfec6..7466b262705a37e7289a351cff041720e813a76d 100644 --- a/paths/ApplicationsTrafficRules.GET.yaml +++ b/paths/ApplicationsTrafficRules.GET.yaml @@ -1,5 +1,5 @@ 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 diff --git a/paths/Services.GET.yaml b/paths/Services.GET.yaml index ffe923386aa3535e6b2ab3037604f9a78bd33569..04ff25ceca8dd1d573f6acbc10cf7d5767e0f390 100644 --- a/paths/Services.GET.yaml +++ b/paths/Services.GET.yaml @@ -1,5 +1,5 @@ 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 parameters: diff --git a/paths/Services.POST.yaml b/paths/Services.POST.yaml index 4a9e461f241fea157ed123e04067d235028fe196..c85b789b945cd2b1bb54540f222669dc0889381b 100644 --- a/paths/Services.POST.yaml +++ b/paths/Services.POST.yaml @@ -1,5 +1,5 @@ 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 parameters: diff --git a/paths/ServicesServiceId.GET.yaml b/paths/ServicesServiceId.GET.yaml index 4c40c3791c670fae6f5c2bff6f8e95030966f2ca..98b1e39c2b8b8222e7922defdfcf3c679f4e1fba 100644 --- a/paths/ServicesServiceId.GET.yaml +++ b/paths/ServicesServiceId.GET.yaml @@ -1,5 +1,5 @@ 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 diff --git a/paths/ServicesServiceId.PUT.yaml b/paths/ServicesServiceId.PUT.yaml index a2038bc42ce69fe14822501cd0a83f97896158c9..9cd2e383d85b9c5cdafb257683a3dfdc371ee8b9 100644 --- a/paths/ServicesServiceId.PUT.yaml +++ b/paths/ServicesServiceId.PUT.yaml @@ -1,5 +1,5 @@ description: This method updates the information about a meService resource -operationId: ServicesServiceId.PUT +operationId: ServicesServiceId_PUT produces: - application/json parameters: diff --git a/paths/TimingCaps.GET.yaml b/paths/TimingCaps.GET.yaml index 259593b10b35661289fc40decd546e97f6ad1f84..c8fb3476da35c15d70df3f951fd2eb6bb649ca76 100644 --- a/paths/TimingCaps.GET.yaml +++ b/paths/TimingCaps.GET.yaml @@ -1,5 +1,5 @@ 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 diff --git a/paths/TimingCurrentTime.GET.yaml b/paths/TimingCurrentTime.GET.yaml index fb5402684290ac3032bffaf9685b0050b8b82539..c6579f02b43b55a6ae377517689bd6c8e9438c9f 100644 --- a/paths/TimingCurrentTime.GET.yaml +++ b/paths/TimingCurrentTime.GET.yaml @@ -1,5 +1,5 @@ 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 diff --git a/paths/Transports.GET.yaml b/paths/Transports.GET.yaml index 05dbed3fc6cbaa488b4c403c0ceed279b4fb710f..e20963b7723f43c86b3a0dbadfbe55f871fa487f 100644 --- a/paths/Transports.GET.yaml +++ b/paths/Transports.GET.yaml @@ -1,5 +1,5 @@ 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