Autogenerated openapi version v030101 (ec2b0785) · Commits · MEC - Multi-access Edge Computing / MEC Federation enablement APIs

MEC040_fedEnablement.yaml

+125 −94

Original line number	Original line	Diff line number	Diff line
	openapi: 3.1.0		openapi: 3.1.0
			jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
	info:		info:
	contact:		contact:
	url: https://forge.etsi.org/rep/mec/gs040-fed-enablement-api		url: https://forge.etsi.org/rep/mec/gs040-fed-enablement-api
	version: 3.1.1
	title: ETSI GS MEC 040 - MEC Federation enablement APIs		title: ETSI GS MEC 040 - MEC Federation enablement APIs
	description: The ETSI MEC ISG MEC040 Federation enablement API described using OpenAPI		description: 'The ETSI MEC ISG MEC040 Federation enablement API described using OpenAPI

			'
	license:		license:
	name: BSD-3-Clause		name: BSD-3-Clause
	url: 'https://forge.etsi.org/legal-matters'		url: https://forge.etsi.org/legal-matters
	externalDocs:		version: 3.1.1
	description: ETSI GS MEC 040 Federation enablement API, v3.1.1
	url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/040/03.01.01_60/gs_mec040v030101p.pdf
	servers:		servers:
	- url: https://localhost/fed-enablement/v1		- url: https://localhost/fed_enablement/v1

	paths:		paths:
	/fed_resources/system_info:		/fed_resources/system_info:
	get:		get:
	summary: Retrieve a list of system_info resources (see clause 6 for data model) of federation members.		summary: Retrieve a list of system_info resources (see clause 6 for data model) of federation members.
	description: The GET method retrieves the information of a list of system_info resources of federation members. This method is typically used in the sequence of "MEC system discovery" as described in clause 5.2.2.2. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables 7.3.3.1-1 and 7.3.3.1-2.		description: The GET method retrieves the information of a list of system_info resources of federation members. This method is typically used in the sequence of "MEC system discovery" as described in clause 5.2.2.2. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables 7.3.3.1-1 and 7.3.3.1-2.
	operationId: systeminfoGET		operationId: FedresourcesSysteminfoGET
	tags:		tags:
	- systemInfo		- systemInfo
	parameters:		parameters:
	- $ref: '#/components/parameters/Query.systemId'		- $ref: '#/components/parameters/Query.Systemid'
	- $ref: '#/components/parameters/Query.systemName'		- $ref: '#/components/parameters/Query.Systemname'
	- $ref: '#/components/parameters/Query.systemProvider'		- $ref: '#/components/parameters/Query.Systemprovider'
	responses:		responses:
	'200':		'200':
	description: It is used to indicate that the query for retrieving system_info resource(s) is successful. Response body containing one or multiple system_info resources shall be returned.		description: It is used to indicate that the query for retrieving system_info resource(s) is successful. Response body containing one or multiple system_info resources shall be returned.
	@@ -46,7 +45,7 @@ paths:
	post:		post:
	summary: Create new system_info resource for a given MEC system.		summary: Create new system_info resource for a given MEC system.
	description: "The POST method creates the information of system_info resources to the MEC federator. This method is typically used in the sequence of \"Registration of MEC system to the federation\" as described in clause 5.2.2.1. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables\_7.3.3.4-1 and 7.3.3.4-2."		description: "The POST method creates the information of system_info resources to the MEC federator. This method is typically used in the sequence of \"Registration of MEC system to the federation\" as described in clause 5.2.2.1. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables\_7.3.3.4-1 and 7.3.3.4-2."
	operationId: systeminfoPOST		operationId: FedresourcesSysteminfoPOST
	tags:		tags:
	- systemInfo		- systemInfo
	requestBody:		requestBody:
	@@ -80,15 +79,14 @@ paths:
	$ref: '#/components/responses/403'		$ref: '#/components/responses/403'
	'404':		'404':
	$ref: '#/components/responses/404'		$ref: '#/components/responses/404'
			parameters: []
	/fed_resources/system_info/{systemId}:		/fed_resources/system_info/{systemId}:
	get:		get:
	summary: Retrieve the system_info resource of the federation member with systemId as its system identifier.		summary: Retrieve the system_info resource of the federation member with systemId as its system identifier.
	description: The GET method retrieves the system_info resource information. This method is typically used in the sequence of "MEC system discovery" as described in clause 5.2.2.2. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables 7.4.3.1-1 and 7.4.3.1-2.		description: The GET method retrieves the system_info resource information. This method is typically used in the sequence of "MEC system discovery" as described in clause 5.2.2.2. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables 7.4.3.1-1 and 7.4.3.1-2.
	operationId: systeminfoByIdGET		operationId: FedresourcesSysteminfoGETSystemid
	tags:		tags:
	- systemInfo		- systemInfo
	parameters:
	- $ref: '#/components/parameters/Path.systemId'
	responses:		responses:
	'200':		'200':
	description: It is used to indicate that the query for retrieving system_info resource is successful. Response body containing one system_info resource shall be returned.		description: It is used to indicate that the query for retrieving system_info resource is successful. Response body containing one system_info resource shall be returned.
	@@ -107,14 +105,19 @@ paths:
	$ref: '#/components/responses/403'		$ref: '#/components/responses/403'
	'404':		'404':
	$ref: '#/components/responses/404'		$ref: '#/components/responses/404'
			parameters:
			- name: systemId
			in: path
			required: true
			description: The unique identifier of the systemId.
			schema:
			type: string
	patch:		patch:
	summary: Update the system_info resource for a given MEC system.		summary: Update the system_info resource for a given MEC system.
	description: The PATCH method updates the information of system_info resources stored in the MEC federator through previous registration. This method is typically used in the sequence of "Update of MEC system to the federation" as described in clause 5.2.2.2. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables 7.4.3.3-1 and 7.4.3.3-2.		description: The PATCH method updates the information of system_info resources stored in the MEC federator through previous registration. This method is typically used in the sequence of "Update of MEC system to the federation" as described in clause 5.2.2.2. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables 7.4.3.3-1 and 7.4.3.3-2.
	operationId: systeminfoByIdPATCH		operationId: FedresourcesSysteminfoPATCHSystemid
	tags:		tags:
	- systemInfo		- systemInfo
	parameters:
	- $ref: '#/components/parameters/Path.systemId'
	requestBody:		requestBody:
	description: It contains attributes to be update.		description: It contains attributes to be update.
	required: true		required: true
	@@ -143,14 +146,19 @@ paths:
	$ref: '#/components/responses/403'		$ref: '#/components/responses/403'
	'404':		'404':
	$ref: '#/components/responses/404'		$ref: '#/components/responses/404'
			parameters:
			- name: systemId
			in: path
			required: true
			description: The unique identifier of the systemId.
			schema:
			type: string
	delete:		delete:
	summary: Delete the system_info resource for a given MEC system.		summary: Delete the system_info resource for a given MEC system.
	description: The DELETE method deletes the information of system_info resources stored in the MEF. This method is typically used in the sequence of "Deregistration of MEC system to the federation" as described in clause 5.2.2.1.1. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables 7.4.3.5-1 and 7.4.3.5-2.		description: The DELETE method deletes the information of system_info resources stored in the MEF. This method is typically used in the sequence of "Deregistration of MEC system to the federation" as described in clause 5.2.2.1.1. The method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in Tables 7.4.3.5-1 and 7.4.3.5-2.
	operationId: systeminfoByIdDELETE		operationId: FedresourcesSysteminfoDELETESystemid
	tags:		tags:
	- systemInfo		- systemInfo
	parameters:
	- $ref: '#/components/parameters/Path.systemId'
	responses:		responses:
	'204':		'204':
	$ref: '#/components/responses/204'		$ref: '#/components/responses/204'
	@@ -162,6 +170,13 @@ paths:
	$ref: '#/components/responses/403'		$ref: '#/components/responses/403'
	'404':		'404':
	$ref: '#/components/responses/404'		$ref: '#/components/responses/404'
			parameters:
			- name: systemId
			in: path
			required: true
			description: The unique identifier of the systemId.
			schema:
			type: string
	components:		components:
	schemas:		schemas:
	ProblemDetails:		ProblemDetails:
	@@ -181,19 +196,66 @@ components:
	detail:		detail:
	type: string		type: string
	description: A human-readable explanation specific to this occurrence of the problem		description: A human-readable explanation specific to this occurrence of the problem
	x-etsi-mec-cardinality: 0..1
	x-etsi-mec-origin-type: String
	instance:		instance:
	type: string		type: string
	format: uri		format: uri
	description: A URI reference that identifies the specific occurrence of the problem		description: A URI reference that identifies the specific occurrence of the problem
			Addresses:
			description: Entry point information of the service as one or more pairs of IP address and port. See note.
			type: object
			minItems: 0
			properties:
			host:
			description: Host portion of the address.
			type: string
			port:
			description: Port portion of the address.
			type: integer
			required:
			- host
			- port
			LinkType:
			type: object
			required:
			- href
			properties:
			href:
			type: string
			format: uri
			description: The hyperlink reference.
			EndPointInfo:
			x-etsi-ref: 8.1.5.3
			type: object
			properties:
			uris:
			description: Entry point information of the service as string, formatted according to URI syntax (see IETF RFC 3986 [8]). Shall be used for REST APIs. See note.
			type: array
			minItems: 0
			items:
			type: string
			fqdn:
			description: Fully Qualified Domain Name of the service. See note.
			type: array
			minItems: 0
			items:
			type: string
			addresses:
			type: array
			items:
			$ref: '#/components/schemas/Addresses'
			alternative:
			description: "Entry point information of the service in a format defined by an implementation, or in an external specification. See\_note."
			type: object
			description: "\|-\n NOTE:\tExactly one of \"uris\", \"fqdn\", \"addresses\" or \"alternative\" shall be present."
	SystemInfo:		SystemInfo:
	title: SystemInfo		x-etsi-ref: 6.2.2
	type: object		type: object
	description: This type represents an information provided by the MEC orchestrator as a part of the "Registration of MEC system to the federation"
	properties:		properties:
	systemId:		systemId:
	description: 'Identifier of the MEC system. For the uniqueness of the identifier across the federated MEC systems, UUID format [i.9] is recommended. Shall be absent in POST request, and present otherwise.'		description: 'Identifier of the MEC system. For the uniqueness of the identifier across the federated MEC systems, UUID format [i.9] is recommended.


			Shall be absent in POST request, and present otherwise.'
	type: string		type: string
	systemName:		systemName:
	description: The name of the MEC system. This is how the MEC system identifies other MEC systems		description: The name of the MEC system. This is how the MEC system identifies other MEC systems
	@@ -206,30 +268,19 @@ components:
	- systemName		- systemName
	- systemProvider		- systemProvider
	SystemInfoUpdate:		SystemInfoUpdate:
	title: SystemInfoUpdate		x-etsi-ref: 6.2.3
	type: object		type: object
	description: \|
	This type represents an information provided by MEC orchestrator as a part of the
	"Update of MEC system(s) to the federation".

	NOTE: At least one attribute shall exist.
	properties:		properties:
	systemName:		systemName:
	description: The name of the MEC system. This is how the MEC system identifies other MEC systems.		description: The name of the MEC system. This is how the MEC system identifies other MEC systems.
	type: string		type: string
	endpoint:		endpoint:
	# description': Endpoint information (e.g. URI, FQDN, IP address) of MEC federator.
	$ref: '#/components/schemas/EndPointInfo'
	# x-etsi-mec-origin-type': EndPointInfo
	# x-etsi-mec-cardinality': 0..1
	EndPointInfo:
	title: EndPointInfo
	type: string
	description: Endpoint information (e.g. URI, FQDN, IP address) of MEC federator.		description: Endpoint information (e.g. URI, FQDN, IP address) of MEC federator.
			$ref: '#/components/schemas/EndPointInfo'
			description: "\|-\n NOTE:\tAt least one attribute shall exist."
	SystemUpdateNotificationSubscription:		SystemUpdateNotificationSubscription:
	title: SystemUpdateNotificationSubscription		x-etsi-ref: 6.3.2
	type: object		type: object
	description: This type represents a subscription to the notifications from the MEC federator related to information update of the MEC systems in the MEC federation.
	properties:		properties:
	subscriptionType:		subscriptionType:
	description: Shall be set to "SystemUpdateNotificationSubscription".		description: Shall be set to "SystemUpdateNotificationSubscription".
	@@ -238,8 +289,8 @@ components:
	description: URI selected by the MEC orchestrator to receive notifications on the subscribed MEC system information updates in the MEC federation. This shall be included in both the request and the response.		description: URI selected by the MEC orchestrator to receive notifications on the subscribed MEC system information updates in the MEC federation. This shall be included in both the request and the response.
	type: string		type: string
	format: uri		format: uri
	links:		_links:
	$ref: '#/components/schemas/links'		$ref: '#/components/schemas/_links'
	systemId:		systemId:
	description: Identifier(s) to uniquely specify the target MEC system(s) for the subscription. If absent, the subscription should include all MEC systems in the MEC federation.		description: Identifier(s) to uniquely specify the target MEC system(s) for the subscription. If absent, the subscription should include all MEC systems in the MEC federation.
	type: array		type: array
	@@ -247,17 +298,14 @@ components:
	items:		items:
	type: string		type: string
	expiryDeadline:		expiryDeadline:
	# description': The expiration time of the subscription determined by the MEC Federation Enablement Service.		description: The expiration time of the subscription determined by the MEC Federation Enablement Service.
	$ref: '#/components/schemas/TimeStamp'		$ref: '#/components/schemas/TimeStamp'
	# x-etsi-mec-origin-type': TimeStamp
	# x-etsi-mec-cardinality': 0..1
	required:		required:
	- subscriptionType		- subscriptionType
	- callbackReference		- callbackReference
	SystemUpdateNotification:		SystemUpdateNotification:
	title: SystemUpdateNotification		x-etsi-ref: 6.4.2
	type: object		type: object
	description: This type represents the information that the MEC federator notifies the subscribed MEC orchestrator about the information update of the MEC systems in the MEC federation.
	properties:		properties:
	notificationType:		notificationType:
	description: Shall be set to "SystemUpdateNotification".		description: Shall be set to "SystemUpdateNotification".
	@@ -268,16 +316,15 @@ components:
	minItems: 1		minItems: 1
	items:		items:
	$ref: '#/components/schemas/SystemInfo'		$ref: '#/components/schemas/SystemInfo'
	links:		_links:
	$ref: '#/components/schemas/links1'		$ref: '#/components/schemas/_links1'
	required:		required:
	- notificationType		- notificationType
	- updatedSystemInfo		- updatedSystemInfo
	- links		- _links
	TimeStamp:		TimeStamp:
	title: TimeStamp		x-etsi-ref: 6.5.2
	type: object		type: object
	description: The expiration time of the subscription determined by the MEC Federation Enablement Service.
	properties:		properties:
	seconds:		seconds:
	description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.		description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
	@@ -290,42 +337,27 @@ components:
	required:		required:
	- seconds		- seconds
	- nanoSeconds		- nanoSeconds
	links:		_links:
	title: links
	description: Object containing hyperlinks related to the resource. This shall only be included in the HTTP responses.		description: Object containing hyperlinks related to the resource. This shall only be included in the HTTP responses.
	type: object		type: object
	properties:		properties:
	self:		self:
	#description': Self-referring URI. The URI shall be unique within the MEC Federation Enablement API as it acts as an ID for the subscription (SubscriptionId).		description: Self-referring URI. The URI shall be unique within the MEC Federation Enablement API as it acts as an ID for the subscription (SubscriptionId).
	$ref: '#/components/schemas/LinkType'		$ref: '#/components/schemas/LinkType'
	# x-etsi-mec-origin-type': LinkType
	# x-etsi-mec-cardinality': '1'
	required:		required:
	- self		- self
	links1:		_links1:
	title: links1
	description: Object containing hyperlinks related to the resource.		description: Object containing hyperlinks related to the resource.
	type: object		type: object
	properties:		properties:
	subscription:		subscription:
	# description': A link to the related subscription.		description: A link to the related subscription.
	$ref: '#/components/schemas/LinkType'		$ref: '#/components/schemas/LinkType'
	# x-etsi-mec-origin-type': LinkType
	# x-etsi-mec-cardinality': '1'
	required:		required:
	- subscription		- subscription
	LinkType:
	title: LinkType
	description: Self-referring URI. The URI shall be unique within the MEC Federation Enablement API as it acts as an ID for the subscription (SubscriptionId).
	type: object
	properties:
	href:
	description: URI referring to a resource.
	format: uri
	type: string
	required:
	- href
	responses:		responses:
			'200':
			description: OK
	'204':		'204':
	description: No Content		description: No Content
	'400':		'400':
	@@ -335,7 +367,7 @@ components:
	schema:		schema:
	$ref: '#/components/schemas/ProblemDetails'		$ref: '#/components/schemas/ProblemDetails'
	'401':		'401':
	description: 'Unauthorized: used when the client did not submit credentials.'		description: 'Unauthorized: used when the request is not authenticated, e.g. when the client did not submit credentials.'
	content:		content:
	application/problem+json:		application/problem+json:
	schema:		schema:
	@@ -352,42 +384,41 @@ components:
	application/problem+json:		application/problem+json:
	schema:		schema:
	$ref: '#/components/schemas/ProblemDetails'		$ref: '#/components/schemas/ProblemDetails'
			'412':
			description: 'Precondition failed: used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
			content:
			application/problem+json:
			schema:
			$ref: '#/components/schemas/ProblemDetails'
	parameters:		parameters:
	Query.systemId:		Query.Systemid:
	description: Identifier of the MEC system.		description: Identifier of the MEC system.
	name: systemId		name: systemid
	in: query		in: query
	required: false		required: false
	x-exportParamName: Query.systemId		x-exportParamName: Query.Systemid
	schema:		schema:
	type: array		type: array
	items:		items:
	type: string		type: string
	Path.systemId:		Query.Systemname:
	description: Identifier of the MEC system.
	name: systemId
	in: path
	required: true
	x-exportParamName: Path.systemId
	schema:
	type: string
	Query.systemName:
	description: The name of the MEC system.		description: The name of the MEC system.
	name: systemName		name: systemname
	in: query		in: query
	required: false		required: false
	x-exportParamName: Query.systemName		x-exportParamName: Query.Systemname
	schema:		schema:
	type: array		type: array
	items:		items:
	type: string		type: string
	Query.systemProvider:		Query.Systemprovider:
	description: Provider of the MEC system.		description: Provider of the MEC system.
	name: systemProvider		name: systemprovider
	in: query		in: query
	required: false		required: false
	x-exportParamName: Query.systemProvider		x-exportParamName: Query.Systemprovider
	schema:		schema:
	type: array		type: array
	items:		items:
	type: string		type: string