Latest Generated OAS for MEC document (f56e440a) · Commits · MEC - Multi-access Edge Computing / MEC Federation enablement APIs

Auto_Generated_OAS_Outputs/gs_mec040v030101p.yaml

+74 −49

Original line number	Diff line number	Diff line
		@@ -14,18 +14,21 @@ paths:
		get:
		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.
		operationId: systeminfoGET
		operationId: FedresourcesSysteminfoGET
		tags:
		- serviceManagement
		parameters:
		- $ref: '#/components/parameters/Query.Systemid'
		- $ref: '#/components/parameters/Query.Systemname'
		- $ref: '#/components/parameters/Query.Systemprovider'
		responses:
		'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.
		content:
		application/json:
		schema:
		type: object
		properties:
		SystemInfo:
		type: array
		items:
		$ref: '#/components/schemas/SystemInfo'
		'400':
		$ref: '#/components/responses/400'
		@@ -38,7 +41,7 @@ paths:
		post:
		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."
		operationId: systeminfoPOST
		operationId: FedresourcesSysteminfoPOST
		tags:
		- serviceManagement
		requestBody:
		@@ -72,11 +75,12 @@ paths:
		$ref: '#/components/responses/403'
		'404':
		$ref: '#/components/responses/404'
		parameters: []
		/fed_resources/system_info/{systemId}:
		get:
		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.
		operationId: systeminfoByIdGET
		operationId: FedresourcesSysteminfoGETSystemid
		tags:
		- serviceManagement
		responses:
		@@ -97,10 +101,17 @@ paths:
		$ref: '#/components/responses/403'
		'404':
		$ref: '#/components/responses/404'
		parameters:
		- name: systemId
		in: path
		required: true
		description: The unique identifier of the systemId.
		schema:
		type: string
		patch:
		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.
		operationId: systeminfoByIdPATCH
		operationId: FedresourcesSysteminfoPATCHSystemid
		tags:
		- serviceManagement
		requestBody:
		@@ -131,10 +142,17 @@ paths:
		$ref: '#/components/responses/403'
		'404':
		$ref: '#/components/responses/404'
		parameters:
		- name: systemId
		in: path
		required: true
		description: The unique identifier of the systemId.
		schema:
		type: string
		delete:
		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.
		operationId: systeminfoByIdDELETE
		operationId: FedresourcesSysteminfoDELETESystemid
		tags:
		- serviceManagement
		responses:
		@@ -148,6 +166,13 @@ paths:
		$ref: '#/components/responses/403'
		'404':
		$ref: '#/components/responses/404'
		parameters:
		- name: systemId
		in: path
		required: true
		description: The unique identifier of the systemId.
		schema:
		type: string
		components:
		schemas:
		ProblemDetails:
		@@ -190,18 +215,12 @@ components:


		Shall be absent in POST request, and present otherwise.'
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: '1'
		type: string
		systemName:
		description: The name of the MEC system. This is how the MEC system identifies other MEC systems
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: '1'
		type: string
		systemProvider:
		description: Provider of the MEC system.
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: '1'
		type: string
		required:
		- systemId
		@@ -213,45 +232,35 @@ components:
		properties:
		systemName:
		description: The name of the MEC system. This is how the MEC system identifies other MEC systems.
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		endpoint:
		# 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'
		# x-etsi-mec-origin-type': EndPointInfo
		# x-etsi-mec-cardinality': 0..1
		x-etsi-notes: "NOTE:\tAt least one attribute shall exist."
		type: object
		description: "\|-\n NOTE:\tAt least one attribute shall exist."
		SystemUpdateNotificationSubscription:
		x-etsi-ref: 6.3.2
		type: object
		properties:
		subscriptionType:
		description: Shall be set to "SystemUpdateNotificationSubscription".
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: '1'
		type: string
		callbackReference:
		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.
		x-etsi-mec-origin-type: Uri
		x-etsi-mec-cardinality: '1'
		type: string
		format: uri
		_links:
		$ref: '#/components/schemas/_links'
		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.
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..N
		type: array
		minItems: 0
		items:
		type: string
		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'
		# x-etsi-mec-origin-type': TimeStamp
		# x-etsi-mec-cardinality': 0..1
		type: object
		required:
		- subscriptionType
		- callbackReference
		@@ -261,13 +270,9 @@ components:
		properties:
		notificationType:
		description: Shall be set to "SystemUpdateNotification".
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: '1'
		type: string
		updatedSystemInfo:
		description: Updated information of the MEC system(s) in the MEC federation.
		x-etsi-mec-origin-type: SystemInfo
		x-etsi-mec-cardinality: 1..N
		type: array
		minItems: 1
		items:
		@@ -284,14 +289,10 @@ components:
		properties:
		seconds:
		description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
		x-etsi-mec-origin-type: Uint32
		x-etsi-mec-cardinality: '1'
		type: integer
		format: uint32
		nanoSeconds:
		description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
		x-etsi-mec-origin-type: Uint32
		x-etsi-mec-cardinality: '1'
		type: integer
		format: uint32
		required:
		@@ -299,28 +300,22 @@ components:
		- nanoSeconds
		_links:
		description: Object containing hyperlinks related to the resource. This shall only be included in the HTTP responses.
		x-etsi-mec-origin-type: Structure (inlined)
		x-etsi-mec-cardinality: 0..1
		type: object
		properties:
		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'
		# x-etsi-mec-origin-type': LinkType
		# x-etsi-mec-cardinality': '1'
		type: object
		required:
		- self
		_links1:
		description: Object containing hyperlinks related to the resource.
		x-etsi-mec-origin-type: Structure (inlined)
		x-etsi-mec-cardinality: '1'
		type: object
		properties:
		subscription:
		# description': A link to the related subscription.
		description: A link to the related subscription.
		$ref: '#/components/schemas/LinkType'
		# x-etsi-mec-origin-type': LinkType
		# x-etsi-mec-cardinality': '1'
		type: object
		required:
		- subscription
		responses:
		@@ -350,5 +345,35 @@ components:
		application/problem+json:
		schema:
		$ref: '#/components/schemas/ProblemDetails'
		parameters: {}
		parameters:
		Query.Systemid:
		description: Identifier of the MEC system.
		name: systemid
		in: query
		required: false
		x-exportParamName: Query.Systemid
		schema:
		type: array
		items:
		type: string
		Query.Systemname:
		description: The name of the MEC system.
		name: systemname
		in: query
		required: false
		x-exportParamName: Query.Systemname
		schema:
		type: array
		items:
		type: string
		Query.Systemprovider:
		description: Provider of the MEC system.
		name: systemprovider
		in: query
		required: false
		x-exportParamName: Query.Systemprovider
		schema:
		type: array
		items:
		type: string