Autogenerated openapi version v030101 (ff5e07a6) · Commits · MEC - Multi-access Edge Computing / Application Mobility Service API

MEC021_AppMobilityService.yaml

+63 −51

Original line number	Diff line number	Diff line
		@@ -8,19 +8,19 @@ info:
		license:
		name: BSD-3-Clause
		url: https://forge.etsi.org/legal-matters
		version: 2.2.1
		version: 3.1.1
		servers:
		- url: https://localhost/amsi/v1
		paths:
		/app_mobility_services:
		get:
		summary: Query multiple Application Mobility Service resources.
		description: The GET method is to retrieve information about the registered Application Mobility Service. Upon success, the response contains entity body with the list of application mobility services that are present for the requestor.
		description: The GET method is to retrieve information about the registered Application Mobility Service. Upon success, the response message content contains the list of application mobility services that are present for the requestor.
		operationId: AppmobilityservicesGET
		tags:
		- app_mobility_services
		parameters:
		- $ref: '#/components/parameters/Query.Filter'
		- $ref: '#/components/parameters/Query.filter'
		- $ref: '#/components/parameters/Query.All_fields'
		- $ref: '#/components/parameters/Query.Fields'
		- $ref: '#/components/parameters/Query.Exclude_fields'
		@@ -30,7 +30,7 @@ paths:
		description: 'Information about zero or more application mobility services was queried successfully.


		The response body shall contain in an array the representations of zero or more application mobility services.'
		The response message content shall contain in an array the representations of zero or more application mobility services.'
		content:
		application/json:
		schema:
		@@ -51,7 +51,7 @@ paths:
		$ref: '#/components/responses/429'
		post:
		summary: Create an Application Mobility Service resource.
		description: The POST method is used to create a new application mobility service for the service requester. Upon success, the response contains entity body of created application mobility service with the service ID.
		description: The POST method is used to create a new application mobility service for the service requester. Upon success, the response message content contains created application mobility service with the service ID.
		operationId: AppmobilityservicesPOST
		tags:
		- app_mobility_services
		@@ -94,7 +94,7 @@ paths:
		/app_mobility_services/{appMobilityServiceId}:
		get:
		summary: Read an Application Mobility Service resource.
		description: The GET method is used to retrieve information about this individual application mobility service. Upon success, the response contains entity body with the data type describing the registered Application Mobility Service.
		description: The GET method is used to retrieve information about this individual application mobility service. Upon success, the response message content contains the data type describing the registered Application Mobility Service.
		operationId: AppmobilityservicesGETAppmobilityserviceid
		tags:
		- app_mobility_services
		@@ -129,7 +129,7 @@ paths:
		type: string
		put:
		summary: Update an individual Application Mobility Service resource.
		description: The PUT method is used to update the existing individual application mobility service. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request.
		description: The PUT method is used to update the existing individual application mobility service. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message content of the PUT request.
		operationId: AppmobilityservicesPUTAppmobilityserviceid
		tags:
		- app_mobility_services
		@@ -145,7 +145,7 @@ paths:
		$ref: '#/components/schemas/RegistrationInfo'
		responses:
		'200':
		description: Upon success, a response body containing data type describing the updated application mobility service.
		description: Upon success, the returned response message content contains data type describing the updated application mobility service.
		content:
		application/json:
		schema:
		@@ -212,7 +212,7 @@ paths:
		description: 'The request is acknowledged.


		The response body shall be empty.'
		The response message content shall be empty.'
		content:
		application/json:
		schema:
		@@ -238,15 +238,15 @@ paths:
		/subscriptions:
		get:
		summary: Retrieve information of multiple subscriptions to notifications of Application Mobility Service event.
		description: The GET method is used to retrieve information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor.
		description: The GET method is used to retrieve information about the subscriptions for this requestor. Upon success, the response message content contains the list of links to the subscriptions that are present for the requestor.
		operationId: SubscriptionsGET
		tags:
		- subscriptions
		parameters:
		- $ref: '#/components/parameters/Query.Subscriptiontype'
		- $ref: '#/components/parameters/Query.subscriptionType'
		responses:
		'200':
		description: Upon success, a response body containing the list of links to requestor's subscriptions is returned.
		description: Upon success, the returned response message content contains the list of links to requestor's subscriptions.
		content:
		application/json:
		schema:
		@@ -268,12 +268,12 @@ paths:
		$ref: '#/components/responses/429'
		post:
		summary: Subscribe to notifications of Application Mobility Service event.
		description: The POST method is used to create a new subscription to Application Mobility Service notifications. Upon success, the response contains entity body describing the created subscription.
		description: The POST method is used to create a new subscription to Application Mobility Service notifications. Upon success, the response message content contains description of the created subscription.
		operationId: SubscriptionsPOST
		tags:
		- subscriptions
		requestBody:
		description: 'The entity body in the request contains data type of the specific AMS event subscription that is to be created, where the data type options are listed below and defined in clauses 7.3.2 through 7.3.4:
		description: 'The request message content contains data type of the specific AMS event subscription that is to be created, where the data type options are listed below and defined in clauses 7.3.2 through 7.3.4:

		MobilityProcedureSubscription.

		@@ -317,7 +317,7 @@ paths:
		post:
		summary: Callback POST used to send a notification
		description: Subscription notification
		operationId: notificationPOST531833
		operationId: notificationPOST977810
		requestBody:
		description: Subscription notification
		required: true
		@@ -339,13 +339,13 @@ paths:
		/subscriptions/{subscriptionId}:
		get:
		summary: Read information of subscription of Application Mobility Service.
		description: The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription.
		description: The GET method is used to retrieve information about this subscription. Upon success, the response message content contains the data type describing the subscription.
		operationId: SubscriptionsGETSubscriptionid
		tags:
		- subscriptions
		responses:
		'200':
		description: 'Upon success, a response body containing data type describing the specific AMS event subscription is returned. The allowed data types for subscriptions are defined in clauses 7.3.2 and 7.3.3 as follows:
		description: 'Upon success, the returned response message content contains data type describing the specific AMS event subscription. The allowed data types for subscriptions are defined in clauses 7.3.2 and 7.3.3 as follows:

		MobilityProcedureSubscription.

		@@ -378,12 +378,12 @@ paths:
		type: string
		put:
		summary: Update an individual subscription to notification of Application Mobility Service event.
		description: The PUT method is used to update the existing individual subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new subscription parameters received within the message body of the PUT request.
		description: The PUT method is used to update the existing individual subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new subscription parameters received within the message content of the PUT request.
		operationId: SubscriptionsPUTSubscriptionid
		tags:
		- subscriptions
		requestBody:
		description: 'Updated NotificationSubscription is included as entity body of the request. The allowed data types for subscriptions are defined in clauses 7.3.2 and 7.3.3 as follows:
		description: 'Updated NotificationSubscription is included as the request message content. The allowed data types for subscriptions are defined in clauses 7.3.2 and 7.3.3 as follows:

		MobilityProcedureSubscription.

		@@ -397,7 +397,7 @@ paths:
		$ref: '#/components/schemas/MobilityProcedureSubscription'
		responses:
		'200':
		description: 'Upon success, a response body containing data type describing the updated subscription is returned. The allowed data types for subscriptions are defined in clauses 7.3.2 and 7.3.3 as follows:
		description: 'Upon success, the returned response message content contains data type describing the updated subscription. The allowed data types for subscriptions are defined in clauses 7.3.2 and 7.3.3 as follows:

		MobilityProcedureSubscription.

		@@ -459,14 +459,14 @@ paths:
		/queries/adjacent_app_instances:
		get:
		summary: Read information of adjacent application instance(s).
		description: The GET method is to retrieve the information of adjacent application instances. Upon success, the response contains entity body with the list of available application instance information.
		description: The GET method is to retrieve the information of adjacent application instances. Upon success, the response message content contains the list of available application instance information.
		operationId: QueriesAdjacentappinstancesGET
		tags:
		- adjacent_app_instances
		parameters:
		- $ref: '#/components/parameters/Query.Filter1'
		- $ref: '#/components/parameters/Query.All_fields'
		- $ref: '#/components/parameters/Query.Fields'
		- $ref: '#/components/parameters/Query.filter1'
		- $ref: '#/components/parameters/Query.All_fields1'
		- $ref: '#/components/parameters/Query.Fields1'
		- $ref: '#/components/parameters/Query.Exclude_fields1'
		- $ref: '#/components/parameters/Query.Exclude_default1'
		responses:
		@@ -474,7 +474,7 @@ paths:
		description: 'Information about zero or more adjacent application instances was queried successfully.


		The response body shall contain in an array the representations of zero or more adjacent application instance information.'
		The response message content shall contain in an array the representations of zero or more adjacent application instance information.'
		content:
		application/json:
		schema:
		@@ -517,7 +517,7 @@ paths:
		$ref: '#/components/schemas/MobilityProcedureNotification'
		responses:
		'204':
		description: The notification was delivered successfully. The response body shall be empty.
		description: The notification was delivered successfully. The response message content shall be empty.
		content:
		application/json:
		schema:
		@@ -1038,7 +1038,7 @@ components:
		required:
		- subscription
		_links4:
		description: 'Hyperlink related to the resource. '
		description: Hyperlink related to the resource.
		type: object
		properties:
		subscription:
		@@ -1119,7 +1119,7 @@ components:
		schema:
		$ref: '#/components/schemas/ProblemDetails'
		parameters:
		Query.Filter:
		Query.filter:
		description: 'Attribute-based filtering parameters according to ETSI GS MEC 009 [4].

		The API producer shall support receiving filtering parameters as part of the URI query string.
		@@ -1130,54 +1130,50 @@ components:
		name: filter
		in: query
		required: false
		x-exportParamName: Query.Filter
		x-exportParamName: Query.filter
		schema:
		type: string
		Query.All_fields:
		description: "Include all complex attributes in the response. See clause 6.18 in ETSI GS\_MEC\_009 [4] for details. The API producer shall support this parameter."
		name: all_fields
		description: "Include all complex attributes in the response. See clause 6.18 in ETSI GS\_MEC\_009\_[4] for details. The API producer shall support this parameter."
		name: All_fields
		in: query
		required: false
		x-exportParamName: Query.All_fields
		schema:
		type: string
		Query.Fields:
		description: "Complex attributes to be included into the response. See clause 6.18 in ETSI GS\_MEC 009 [4] for details. The API producer should support this parameter."
		name: fields
		description: "Complex attributes to be included into the response. See clause 6.18 in ETSI GS\_MEC\_009 [4] for details. The API producer should support this parameter."
		name: Fields
		in: query
		required: false
		x-exportParamName: Query.Fields
		schema:
		type: string
		Query.Exclude_fields:
		description: "Complex attributes to be excluded from the response. See clause 6.18 in ETSI GS\_MEC 009 [4] for details. The API producer should support this parameter."
		name: exclude_fields
		description: "Complex attributes to be excluded from the response. See clause 6.18 in ETSI GS\_MEC\_009 [4] for details. The API producer should support this parameter."
		name: Exclude_fields
		in: query
		required: false
		x-exportParamName: Query.Exclude_fields
		schema:
		type: string
		Query.Exclude_default:
		description: 'Indicates to exclude the following complex attributes from the response. See clause 6.18 in ETSI GS MEC 009 [4] for details. The API producer shall support this parameter.

		The following attributes shall be excluded from the RegistrationInfo structure in the response body if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", "exclude_default" are provided:

		n/a.'
		name: exclude_default
		description: "Indicates to exclude the following complex attributes from the response. See clause\_6.18 in ETSI GS MEC 009 [4] for details. The API producer shall support this parameter.\nThe following attributes shall be excluded from the RegistrationInfo structure in the response message content if this parameter is provided, or none of the parameters \"all_fields\", \"fields\", \"exclude_fields\", \"exclude_default\" are provided:\nn/a."
		name: Exclude_default
		in: query
		required: false
		x-exportParamName: Query.Exclude_default
		schema:
		type: string
		Query.Subscriptiontype:
		Query.subscriptionType:
		description: "Query parameter to filter on a specific subscription type. Permitted values:\nmobility_proc\tMobility Procedure\nadj_app_info\tAdjacent Application Info."
		name: subscriptiontype
		name: subscriptionType
		in: query
		required: false
		x-exportParamName: Query.Subscriptiontype
		x-exportParamName: Query.subscriptionType
		schema:
		type: string
		Query.Filter1:
		Query.filter1:
		description: 'Attribute-based filtering parameters according to ETSI GS MEC 009 [4].

		The API producer shall support receiving filtering parameters as part of the URI query string.
		@@ -1185,15 +1181,31 @@ components:
		All attribute names that appear in the AdjacentAppInstanceInfo and in data types referenced from it shall be supported in attribute-based filtering parameters.

		See clause 6.19 in ETSI GS MEC 009 [4] for details.'
		name: filter
		name: filter1
		in: query
		required: false
		x-exportParamName: Query.filter1
		schema:
		type: string
		Query.All_fields1:
		description: "Include all complex attributes in the response. See clause 6.18 in ETSI GS\_MEC\_009 [4] for details. The API producer shall support this parameter."
		name: All_fields1
		in: query
		required: false
		x-exportParamName: Query.All_fields1
		schema:
		type: string
		Query.Fields1:
		description: "Complex attributes to be included into the response. See clause 6.18 in ETSI GS\_MEC 009 [4] for details. The API producer should support this parameter."
		name: Fields1
		in: query
		required: false
		x-exportParamName: Query.Filter1
		x-exportParamName: Query.Fields1
		schema:
		type: string
		Query.Exclude_fields1:
		description: Complex attributes to be excluded from the response. See clause 6.18 in ETSI GS MEC 009 [4] for details. The API producer should support this parameter.
		name: exclude_fields
		name: Exclude_fields1
		in: query
		required: false
		x-exportParamName: Query.Exclude_fields1
		@@ -1204,10 +1216,10 @@ components:

		See clause 6.18 in ETSI GS MEC 009 [4] for details. The API producer shall support this parameter.

		The following attributes shall be excluded from the AdjacentAppInstanceInfo structure in the response body if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", "exclude_default" are provided:
		The following attributes shall be excluded from the AdjacentAppInstanceInfo structure in the response message content if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", "exclude_default" are provided:

		n/a.'
		name: exclude_default
		name: Exclude_default1
		in: query
		required: false
		x-exportParamName: Query.Exclude_default1