Latest auto generated OAS for MEC040 (cd45cffa) · Commits · MEC - Multi-access Edge Computing / MEC Federation enablement APIs

Auto_Generated_OAS_Outputs/gs_mec040v030101p.yaml

0 → 100644

+354 −0

Original line number	Diff line number	Diff line
		openapi: 3.1.0
		jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
		info:
		contact:
		url: https://forge.etsi.org/rep/mec/gs014-ue-identity-api
		title: ETSI GS MEC 014 UE Identity API
		description: "The present document focuses on the UE Identity functionality. It describes the related application policy information (including authorization, access control and traffic rule pattern format), information flows, required information and service aggregation patterns. The present document specifies the necessary API, data model and data format, considering existing API(s) if applicable. \n"
		license:
		name: BSD-3-Clause
		url: https://forge.etsi.org/legal-matters
		version: 3.1.1
		paths:
		/fed_resources/system_info:
		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
		tags:
		- serviceManagement
		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:
		$ref: '#/components/schemas/SystemInfo'
		'400':
		$ref: '#/components/responses/400'
		'401':
		$ref: '#/components/responses/401'
		'403':
		$ref: '#/components/responses/403'
		'404':
		$ref: '#/components/responses/404'
		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
		tags:
		- serviceManagement
		requestBody:
		description: Entity body in the request contains SystemInfo to be created. The attribute "systemId" shall be absent.
		required: true
		content:
		application/json:
		schema:
		type: object
		properties:
		SystemInfo:
		$ref: '#/components/schemas/SystemInfo'
		responses:
		'201':
		description: 'It is used to indicate that the system_info resource is successfully created.


		The HTTP response includes a "Location" HTTP header that contains the URI of the created resource.'
		content:
		application/json:
		schema:
		type: object
		properties:
		SystemInfo:
		$ref: '#/components/schemas/SystemInfo'
		'400':
		$ref: '#/components/responses/400'
		'401':
		$ref: '#/components/responses/401'
		'403':
		$ref: '#/components/responses/403'
		'404':
		$ref: '#/components/responses/404'
		/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
		tags:
		- serviceManagement
		responses:
		'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.
		content:
		application/json:
		schema:
		type: object
		properties:
		SystemInfo:
		$ref: '#/components/schemas/SystemInfo'
		'400':
		$ref: '#/components/responses/400'
		'401':
		$ref: '#/components/responses/401'
		'403':
		$ref: '#/components/responses/403'
		'404':
		$ref: '#/components/responses/404'
		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
		tags:
		- serviceManagement
		requestBody:
		description: It contains attributes to be update.
		required: true
		content:
		application/json:
		schema:
		type: object
		properties:
		SystemInfoUpdate:
		$ref: '#/components/schemas/SystemInfoUpdate'
		responses:
		'200':
		description: It is used to indicate that the system_info resource is successfully updated.
		content:
		application/json:
		schema:
		type: object
		properties:
		SystemInfo:
		$ref: '#/components/schemas/SystemInfo'
		'400':
		$ref: '#/components/responses/400'
		'401':
		$ref: '#/components/responses/401'
		'403':
		$ref: '#/components/responses/403'
		'404':
		$ref: '#/components/responses/404'
		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
		tags:
		- serviceManagement
		responses:
		'204':
		$ref: '#/components/responses/204'
		'400':
		$ref: '#/components/responses/400'
		'401':
		$ref: '#/components/responses/401'
		'403':
		$ref: '#/components/responses/403'
		'404':
		$ref: '#/components/responses/404'
		components:
		schemas:
		ProblemDetails:
		type: object
		properties:
		type:
		type: string
		format: uri
		description: A URI reference according to IETF RFC 3986 that identifies the problem type
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: URI
		title:
		type: string
		description: A short, human-readable summary of the problem type
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: String
		status:
		type: integer
		format: uint32
		description: The HTTP status code for this occurrence of the problem
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: Uint32
		detail:
		type: string
		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:
		type: string
		format: uri
		description: A URI reference that identifies the specific occurrence of the problem
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: URI
		SystemInfo:
		x-etsi-ref: 6.2.2
		type: object
		properties:
		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.'
		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
		- systemName
		- systemProvider
		SystemInfoUpdate:
		x-etsi-ref: 6.2.3
		type: object
		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.
		$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."
		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.
		$ref: '#/components/schemas/TimeStamp'
		# x-etsi-mec-origin-type': TimeStamp
		# x-etsi-mec-cardinality': 0..1
		required:
		- subscriptionType
		- callbackReference
		SystemUpdateNotification:
		x-etsi-ref: 6.4.2
		type: object
		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:
		$ref: '#/components/schemas/SystemInfo'
		_links:
		$ref: '#/components/schemas/_links1'
		required:
		- notificationType
		- updatedSystemInfo
		- _links
		TimeStamp:
		x-etsi-ref: 6.5.2
		type: object
		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:
		- seconds
		- 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).
		$ref: '#/components/schemas/LinkType'
		# x-etsi-mec-origin-type': LinkType
		# x-etsi-mec-cardinality': '1'
		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.
		$ref: '#/components/schemas/LinkType'
		# x-etsi-mec-origin-type': LinkType
		# x-etsi-mec-cardinality': '1'
		required:
		- subscription
		responses:
		'200':
		description: OK
		'400':
		description: 'Bad Request: used to indicate that incorrect parameters were passed to the request.'
		content:
		application/problem+json:
		schema:
		$ref: '#/components/schemas/ProblemDetails'
		'403':
		description: 'Forbidden: operation is not allowed given the current status of the resource.'
		content:
		application/problem+json:
		schema:
		$ref: '#/components/schemas/ProblemDetails'
		'404':
		description: 'Not Found: used when a client provided a URI that cannot be mapped to a valid resource URI.'
		content:
		application/problem+json:
		schema:
		$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: {}