Autogenerated openapi version v030101 (63377f2e) · Commits · MEC - Multi-access Edge Computing / UE Identity API

UEidentityAPI.yaml

+138 −180

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:
	title: UE Identity API		contact:
	version: 3.1.1		url: https://forge.etsi.org/rep/mec/gs014-ue-identity-api
	description: The ETSI MEC ISG MEC014 UE Identity API described using OpenAPI		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:		license:
	name: BSD-3-Clause		name: BSD-3-Clause
	url: https://forge.etsi.org/legal-matters		url: https://forge.etsi.org/legal-matters
	contact:		version: 3.1.1
	email: cti_support@etsi.org
	externalDocs:
	description: ETSI GS MEC014 UE Identity API, V3.1.1
	url: http://www.etsi.org/deliver/etsi_gs/MEC/001_099/014/03.01.01_60/gs_mec014v030101p.pdf
	security:
	- OauthSecurity:
	- all
	servers:		servers:
	- url: https://127.0.0.1:8081/ui/v1		- url: https://localhost:8081/ui/v1
	tags:
	- name: ueIdentityTagInfo
	paths:		paths:
	"/{appInstanceId}/ue_identity_tag_info":		/{appInstanceId}/ue_identity_tag_info:
	parameters:
	- $ref: "#/components/parameters/Path.AppInstanceId"
	get:		get:
	summary: Retrieves information about a specific UeIdentityTagInfo resource		summary: Retrieve information about specific UeIdentityTagInfo.
	description: Retrieves information about a specific UeIdentityTagInfo resource		description: This method retrieves information about a UeIdentityTagInfo resource.
	operationId: UeIdentityTagInfo_GET		operationId: UeidentitytaginfoGETAppinstanceid
	tags:		tags:
	- ueIdentityTagInfo		- uEIdentity
	parameters:		parameters:
	- $ref: "#/components/parameters/Query.UeIdentityTag"		- $ref: '#/components/parameters/Query.Ueidentitytag'
			- name: appInstanceId
			in: path
			required: true
			description: The unique identifier of the appInstanceId.
			schema:
			type: string
	responses:		responses:
	"200":		'200':
	description: It is used to indicate nonspecific success. The response body		description: It is used to indicate nonspecific success. The response body contains a representation of the UeIdentityTagInfo resource.
	contains a representation of the UeIdentityTagInfo resource.
	content:		content:
	application/json:		application/json:
	schema:		schema:
	$ref: "#/components/schemas/UeIdentityTagInfo"		type: object
	"400":		properties:
	$ref: '#/components/responses/Error.400'		UeIdentityTagInfo:
	"403":		$ref: '#/components/schemas/UeIdentityTagInfo'
	$ref: '#/components/responses/Error.403'		'400':
	"404":		$ref: '#/components/responses/400'
	$ref: '#/components/responses/Error.404'		'404':
			$ref: '#/components/responses/404'
			'403':
			$ref: '#/components/responses/403'
	put:		put:
	summary: Register/De-register the information about a specific UeIdentityTagInfo resource		summary: Register/De-register the information about specific UeIdentityTagInfo.
	description: Register/De-register the information about a specific UeIdentityTagInfo		description: This method registers/deregisters one or more UE Identity tags. It has "replace" semantics.
	resource		operationId: UeidentitytaginfoPUTAppinstanceid
	operationId: UeIdentityTagInfo_PUT
	tags:		tags:
	- ueIdentityTagInfo		- uEIdentity
	requestBody:		requestBody:
			description: The updated "state" for each included UE Identity tag is included in the entity body of the request.
			required: true
	content:		content:
	application/json:		application/json:
	schema:		schema:
	$ref: "#/components/schemas/UeIdentityTagInfo"		type: object
	description: "'The updated \"state\" for each included UE Identity tag is included		properties:
	in the entity body of the request'"		UeIdentityTagInfo:
	required: true		$ref: '#/components/schemas/UeIdentityTagInfo'
	responses:		responses:
	"200":		'200':
	description: It is used to indicate success. The response body contains a		description: It is used to indicate success. The response body contains a representation of the UeIdentityTagInfo resource.
	representation of the UeIdentityTagInfo resource
	content:		content:
	application/json:		application/json:
	schema:		schema:
	$ref: "#/components/schemas/UeIdentityTagInfo"		type: object
	"400":		properties:
	$ref: '#/components/responses/Error.400'		UeIdentityTagInfo:
	"403":		$ref: '#/components/schemas/UeIdentityTagInfo'
	$ref: '#/components/responses/Error.403'		'400':
	"404":		$ref: '#/components/responses/400'
	$ref: '#/components/responses/Error.404'		'404':
	"412":		$ref: '#/components/responses/404'
	$ref: '#/components/responses/Error.412'		'403':
	components:		$ref: '#/components/responses/403'
			'412':
			$ref: '#/components/responses/412'
	parameters:		parameters:
	Path.AppInstanceId:		- name: appInstanceId
	name: appInstanceId
	in: path		in: path
	description: Represents a mobile edge application instance
	required: true		required: true
			description: The unique identifier of the appInstanceId.
	schema:		schema:
	type: string		type: string
	Query.UeIdentityTag:		components:
	name: ueIdentityTag
	in: query
	description: Represents a UE
	required: true
	schema:
	type: array
	items:
	type: string
	responses:
	Error.400:
	description: >-
	Bad Request.
	Incorrect parameters were passed in the request.In the returned
	ProblemDetails structure, the "detail" attribute should convey more
	information about the error.
	content:
	application/problem+json:
	schema:
	$ref: "#/components/schemas/ProblemDetails"
	text/plain:
	schema:
	$ref: '#/components/schemas/Empty'
	Error.403:
	description:
	Forbidden.
	The operation is not allowed given the current status of the
	resource. More information should be provided in the "detail"
	attribute of the "ProblemDetails" structure.
	content:
	application/problem+json:
	schema:
	$ref: "#/components/schemas/ProblemDetails"
	Error.404:
	description: >-
	Not Found.
	The client provided a URI that cannot be mapped to a valid resource
	URL. In the returned ProblemDetails structure, the "detail"
	attribute should convey more information about the error.
	content:
	application/problem+json:
	schema:
	$ref: "#/components/schemas/ProblemDetails"
	text/plain:
	schema:
	$ref: '#/components/schemas/Empty'
	Error.412:
	description: >-
	Precondition Failed.
	It is used when a condition has failed during conditional requests,
	e.g. when using ETags to avoid write conflicts.In the returned
	ProblemDetails structure, the "detail" attribute should convey more
	information about the error.
	content:
	application/problem+json:
	schema:
	$ref: "#/components/schemas/ProblemDetails"
	text/plain:
	schema:
	$ref: '#/components/schemas/Empty'
	securitySchemes:
	OauthSecurity:
	type: oauth2
	flows:
	clientCredentials:
	tokenUrl: https://oauth.exampleAPI/token
	scopes:
	all: Single oauth2 scope for API
	schemas:		schemas:
	Empty:
	description: Empty schema
	ProblemDetails:		ProblemDetails:
	type: object		type: object
	properties:		properties:
	type:		type:
	$ref: "#/components/schemas/Problem.type"
	title:
	$ref: "#/components/schemas/Problem.title"
	status:
	$ref: "#/components/schemas/Problem.status"
	detail:
	$ref: "#/components/schemas/Problem.detail"
	instance:
	$ref: "#/components/schemas/Problem.instance"
	Problem.type:
	type: string		type: string
	format: uri		format: uri
	description: A URI reference according to IETF RFC 3986 that identifies the problem		description: A URI reference according to IETF RFC 3986 that identifies the problem type
	type		title:
	Problem.title:
	type: string		type: string
	description: A short, human-readable summary of the problem type		description: A short, human-readable summary of the problem type
	Problem.status:		status:
	type: integer		type: integer
	format: uint32		format: uint32
	description: The HTTP status code for this occurrence of the problem		description: The HTTP status code for this occurrence of the problem
	Problem.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
	Problem.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
	UeIdentityTagInfo:		UeIdentityTagInfo:
	description: information of UE identity tag used in UE Identity feature		x-etsi-ref: 6.2.2
	type: object		type: object
	required:
	- ueIdentityTags
	properties:		properties:
	ueIdentityTags:		ueIdentityTags:
	$ref: "#/components/schemas/UeIdentityTags"
	UeIdentityTags:
	description: 1 to N tags presented by a MEC Application instance to a MEC Platform
	type: array		type: array
	items:		items:
			$ref: '#/components/schemas/UeIdentityTags'
	required:		required:
	- ueIdentityTag		- ueIdentityTags
	- state		UeIdentityTags:
			description: 1 to N tags presented by a MEC Application instance to a MEC Platform
			type: object
	properties:		properties:
	ueIdentityTag:		ueIdentityTag:
	$ref: "#/components/schemas/UeIdentityTag"
	state:
	$ref: "#/components/schemas/State"
	UeIdentityTag:
	description: Specific tag presented by a MEC Application instance to a MEC Platform		description: Specific tag presented by a MEC Application instance to a MEC Platform
	type: string		type: string
	example: UeTagA		state:
	State:		type: integer
	description: Status of the resource ueIdentityTagInfo
	type: string
	enum:		enum:
	- UNREGISTERED		- 0
	- REGISTERED		- 1
	example: REGISTERED		description: 'The following numeric values are defined:
	No newline at end of file
			0 = UNREGISTERED

			1 = REGISTERED'
			required:
			- ueIdentityTag
			- state
			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:
			Query.Ueidentitytag:
			description: Represents one or more UEs.
			name: ueidentitytag
			in: query
			required: true
			x-exportParamName: Query.Ueidentitytag
			schema:
			type: array
			items:
			type: string