Updated specifications: fix on examples, callback and minor. (2cb7fa96) · Commits · MEC - Multi-access Edge Computing / Radio Network Information API

RniAPI.yaml

+203 −48

Original line number	Original line	Diff line number	Diff line
	@@ -5,16 +5,25 @@ info:
	contact:		contact:
	url: https://forge.etsi.org/rep/mec/gs012-rnis-api		url: https://forge.etsi.org/rep/mec/gs012-rnis-api
	version: '2.1.1'		version: '2.1.1'
			license:
			name: BSD-3-Clause
			url: 'https://forge.etsi.org/legal-matters'
	jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema		jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema

			externalDocs:
			description: ETSI GS MEC 012 Radio Network Information API, V2.1.1
			url: http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf
	servers:		servers:
	- url: https://localhost/rni/v2		- url: https://localhost/rni/v2
	variables: {}
			tags:
			- name: rni
	paths:		paths:
	/queries/rab_info:		/queries/rab_info:
	get:		get:
	tags:		tags:
	- rni		- rni
	summary: rab_infoGET		summary: 'Retrieve information on Radio Access Bearers'
	description: Queries information about the Radio Access Bearers		description: Queries information about the Radio Access Bearers
	operationId: rab_infoGET		operationId: rab_infoGET
	parameters:		parameters:
	@@ -174,7 +183,7 @@ paths:
	get:		get:
	tags:		tags:
	- rni		- rni
	summary: plmn_infoGET		summary: 'Queries information about the Mobile Network'
	description: Queries information about the Mobile Network		description: Queries information about the Mobile Network
	operationId: plmn_infoGET		operationId: plmn_infoGET
	parameters:		parameters:
	@@ -248,7 +257,7 @@ paths:
	get:		get:
	tags:		tags:
	- rni		- rni
	summary: s1_bearer_infoGET		summary: Retrieve S1-U bearer information related to specific UE(s)'
	description: Queries information about the S1 bearer(s)		description: Queries information about the S1 bearer(s)
	operationId: s1_bearer_infoGET		operationId: s1_bearer_infoGET
	parameters:		parameters:
	@@ -372,7 +381,7 @@ paths:
	get:		get:
	tags:		tags:
	- rni		- rni
	summary: layer2_meas_infoGET		summary: 'Retrieve information on layer 2 measurements'
	description: Queries information about the layer 2 measurements.		description: Queries information about the layer 2 measurements.
	operationId: layer2_meas_infoGET		operationId: layer2_meas_infoGET
	parameters:		parameters:
	@@ -755,7 +764,7 @@ paths:
	get:		get:
	tags:		tags:
	- rni		- rni
	summary: subscriptionLinkList_subscriptionsGET		summary: 'Queries information on subscriptions for notifications'
	description: Queries information on subscriptions for notifications		description: Queries information on subscriptions for notifications
	operationId: subscriptionLinkList_subscriptionsGET		operationId: subscriptionLinkList_subscriptionsGET
	parameters:		parameters:
	@@ -774,7 +783,10 @@ paths:
	application/json:		application/json:
	schema:		schema:
	$ref: '#/components/schemas/SubscriptionLinkList'		$ref: '#/components/schemas/SubscriptionLinkList'
	example:
			examples:
			example-ofsub-link-list:
			value:
	_links:		_links:
	self:		self:
	href: http://meAppServer.example.com/rni/v2/subscriptions		href: http://meAppServer.example.com/rni/v2/subscriptions
	@@ -784,6 +796,7 @@ paths:
	href: http://meAppServer.example.com/rni/v2/subscriptions/sub123		href: http://meAppServer.example.com/rni/v2/subscriptions/sub123
	callbackReference: http://my.callback.com/rni-cell-change/some-id		callbackReference: http://my.callback.com/rni-cell-change/some-id
	subscriptionType: CellChangeSubscription		subscriptionType: CellChangeSubscription

	'400':		'400':
	description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'		description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
	headers: {}		headers: {}
	@@ -830,7 +843,7 @@ paths:
	post:		post:
	tags:		tags:
	- rni		- rni
	summary: subscriptionsPOST		summary: 'Creates a new subscription to Radio Network Information notifications'
	description: Creates a new subscription to Radio Network Information notifications		description: Creates a new subscription to Radio Network Information notifications
	operationId: subscriptionsPOST		operationId: subscriptionsPOST
	parameters: []		parameters: []
	@@ -851,6 +864,27 @@ paths:
	- $ref: '#/components/schemas/S1BearerSubscription'		- $ref: '#/components/schemas/S1BearerSubscription'
	description: Subscription to be created		description: Subscription to be created
	contentMediaType: application/json		contentMediaType: application/json
			examples:
			example-cell-change-subscription:callbacks:
			value:
			subscriptionType: CellChangeSubscription
			callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
			filterCriteriaAssocHo:
			appInstanceId: 'myApp'
			associateId:
			- type: 1
			value: '10.100.0.1'
			ecgi:
			- plmn:
			mnc: '01'
			mcc: '001'
			cellId: 'ACBDEFA'
			hoStatus:
			- 1
			- 2
			expiryDeadline:
			seconds: 1977836800
			nanoSeconds: 0
	required: true		required: true
	responses:		responses:
	'201':		'201':
	@@ -870,6 +904,32 @@ paths:
	- $ref: '#/components/schemas/CaReconfSubscription'		- $ref: '#/components/schemas/CaReconfSubscription'
	- $ref: '#/components/schemas/S1BearerSubscription'		- $ref: '#/components/schemas/S1BearerSubscription'
	contentMediaType: application/json		contentMediaType: application/json
			examples:
			example-call-change-subscription:
			value:
			subscriptionType: CellChangeSubscription
			callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
			_links:
			self:
			href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
			filterCriteriaAssocHo:
			appInstanceId: 'myApp'
			associateId:
			- type: 1
			value: '10.100.0.1'
			ecgi:
			- plmn:
			mnc: '01'
			mcc: '001'
			cellId: 'ACBDEFA'
			hoStatus:
			- 1
			- 2
			expiryDeadline:
			seconds: 1977836800
			nanoSeconds: 0


	'400':		'400':
	description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'		description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
	headers: {}		headers: {}
	@@ -919,11 +979,12 @@ paths:
	application/problem+json:		application/problem+json:
	schema:		schema:
	$ref: '#/components/schemas/ProblemDetails'		$ref: '#/components/schemas/ProblemDetails'
	example:		examples:
	application/problem+json:		application/problem+json:
			value:
	type: https://meAppServer.example.com/rni/v2/probs/too-many targets		type: https://meAppServer.example.com/rni/v2/probs/too-many targets
	title: Too many targets		title: Too many targets
	status: '422'		status: 422
	detail: The target area for the request is considered too large		detail: The target area for the request is considered too large
	instance: /meAppClient.example.com/77777/msgs/abc		instance: /meAppClient.example.com/77777/msgs/abc
	'429':		'429':
	@@ -933,13 +994,56 @@ paths:
	application/problem+json:		application/problem+json:
	schema:		schema:
	$ref: '#/components/schemas/ProblemDetails'		$ref: '#/components/schemas/ProblemDetails'

			callbacks:
			notification:
			'{$request.body#/notificationSubscription.callbackReference}':
			post:
			summary: 'Callback POST used to send a notification'
			description: 'Notification from RNIS, content based on subscription type'
			operationId: notificationPOST
			requestBody:
			description: Subscription notification
			required: true
			content:
			application/json:
			schema:
			$ref: '#/components/schemas/InlineNotification'
			examples:
			message:
			value:
			notificationType: CellChangeNotification
			associateId:
			- type: 1
			value: '10.100.0.1'
			hoStatus: 1
			srcEcgi:
			plmn:
			mnc: '01'
			mcc: '001'
			cellId: 'ACBDEFA'
			tempUeId:
			mmec: 1
			mtmsi: 001011231231234
			timeStamp:
			seconds: 1977836800
			nanoSeconds: 0
			trgEcgi:
			plmn:
			mnc: '01'
			mcc: '001'
			cellId: 'FEDCBAA'
			responses:
			'204':
			description: "No content"

	deprecated: false		deprecated: false
	parameters: []		parameters: []
	/subscriptions/{subscriptionId}:		/subscriptions/{subscriptionId}:
	get:		get:
	tags:		tags:
	- rni		- rni
	summary: subscriptionsGET		summary: 'Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
	description: Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)		description: Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)
	operationId: subscriptionsGET		operationId: subscriptionsGET
	parameters:		parameters:
	@@ -968,6 +1072,31 @@ paths:
	- $ref: '#/components/schemas/CaReconfSubscription'		- $ref: '#/components/schemas/CaReconfSubscription'
	- $ref: '#/components/schemas/S1BearerSubscription'		- $ref: '#/components/schemas/S1BearerSubscription'
	contentMediaType: application/json		contentMediaType: application/json
			examples:
			example-of-cell-change-subscription:
			value:
			subscriptionType: CellChangeSubscription
			callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
			_links:
			self:
			href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
			filterCriteriaAssocHo:
			appInstanceId: 'myApp'
			associateId:
			- type: 1
			value: '10.100.0.1'
			ecgi:
			- plmn:
			mnc: '01'
			mcc: '001'
			cellId: 'ACBDEFA'
			hoStatus:
			- 1
			- 2
			expiryDeadline:
			seconds: 1977836800
			nanoSeconds: 0

	'400':		'400':
	description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'		description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
	headers: {}		headers: {}
	@@ -1014,7 +1143,7 @@ paths:
	put:		put:
	tags:		tags:
	- rni		- rni
	summary: subscriptionsPUT		summary: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
	description: Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)		description: Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)
	operationId: subscriptionsPUT		operationId: subscriptionsPUT
	parameters:		parameters:
	@@ -1042,6 +1171,30 @@ paths:
	- $ref: '#/components/schemas/S1BearerSubscription'		- $ref: '#/components/schemas/S1BearerSubscription'
	description: Subscription to be modified		description: Subscription to be modified
	contentMediaType: application/json		contentMediaType: application/json
			examples:
			example-of-cell-change-subscription:
			value:
			subscriptionType: CellChangeSubscription
			callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
			_links:
			self:
			href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
			filterCriteriaAssocHo:
			appInstanceId: 'myApp'
			associateId:
			- type: 1
			value: '10.100.0.1'
			ecgi:
			- plmn:
			mnc: '01'
			mcc: '001'
			cellId: 'ACBDEFA'
			hoStatus:
			- 1
			- 2
			expiryDeadline:
			seconds: 1977836800
			nanoSeconds: 0
	required: true		required: true
	responses:		responses:
	'200':		'200':
	@@ -1061,6 +1214,30 @@ paths:
	- $ref: '#/components/schemas/CaReconfSubscription'		- $ref: '#/components/schemas/CaReconfSubscription'
	- $ref: '#/components/schemas/S1BearerSubscription'		- $ref: '#/components/schemas/S1BearerSubscription'
	contentMediaType: application/json		contentMediaType: application/json
			examples:
			example-of-cell-change-subscription:
			value:
			subscriptionType: CellChangeSubscription
			callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
			_links:
			self:
			href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
			filterCriteriaAssocHo:
			appInstanceId: 'myApp'
			associateId:
			- type: 1
			value: '10.100.0.1'
			ecgi:
			- plmn:
			mnc: '01'
			mcc: '001'
			cellId: 'ACBDEFA'
			hoStatus:
			- 1
			- 2
			expiryDeadline:
			seconds: 1977836800
			nanoSeconds: 0
	'400':		'400':
	description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'		description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
	headers: {}		headers: {}
	@@ -1110,11 +1287,12 @@ paths:
	application/problem+json:		application/problem+json:
	schema:		schema:
	$ref: '#/components/schemas/ProblemDetails'		$ref: '#/components/schemas/ProblemDetails'
	example:		examples:
	application/problem+json:		application/problem+json:
	type: https://meAppServer.example.com/rni/v2/probs/too-many targets		value:
			type: https://meAppServer.example.com/rni/v2/probs/too-many-targets
	title: Too many targets		title: Too many targets
	status: '422'		status: 422
	detail: The target area for the request is considered too large		detail: The target area for the request is considered too large
	instance: /meAppClient.example.com/77777/msgs/abc		instance: /meAppClient.example.com/77777/msgs/abc
	'429':		'429':
	@@ -1128,7 +1306,7 @@ paths:
	delete:		delete:
	tags:		tags:
	- rni		- rni
	summary: subscriptionsDELETE		summary: Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)
	description: Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)		description: Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)
	operationId: subscriptionsDELETE		operationId: subscriptionsDELETE
	parameters:		parameters:
	@@ -1772,7 +1950,7 @@ components:
	minItems: 0		minItems: 0
	type: array		type: array
	items:		items:
	$ref: '#/components/schemas/ResultsPerCsiRsIndex2'		$ref: '#/components/schemas/ResultsPerCsiRsIndex'
	description: ''		description: ''
	ResultsPerSsbIndex:		ResultsPerSsbIndex:
	title: ResultsPerSsbIndex		title: ResultsPerSsbIndex
	@@ -1793,7 +1971,7 @@ components:
	minItems: 0		minItems: 0
	type: array		type: array
	items:		items:
	$ref: '#/components/schemas/ResultsPerSsbIndex2'		$ref: '#/components/schemas/ResultsPerSsbIndex'
	description: ''		description: ''
	RsIndexResults:		RsIndexResults:
	title: RsIndexResults		title: RsIndexResults
	@@ -2706,24 +2884,6 @@ components:
	description: This attribute indicates the maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.		description: This attribute indicates the maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
	contentEncoding: int32		contentEncoding: int32
	description: The QoS Information for the E-RAB as defined below.		description: The QoS Information for the E-RAB as defined below.
	ResultsPerCsiRsIndex2:
	title: ResultsPerCsiRsIndex2
	type: object
	properties:
	csiRsIndex:
	type: integer
	contentEncoding: int32
	csiRsResults:
	$ref: '#/components/schemas/MeasQuantityResultsNr'
	ResultsPerSsbIndex2:
	title: ResultsPerSsbIndex2
	type: object
	properties:
	ssbIndex:
	type: integer
	contentEncoding: int32
	ssbResults:
	$ref: '#/components/schemas/MeasQuantityResultsNr'
	S1BearerInfoDetailed:		S1BearerInfoDetailed:
	title: S1BearerInfoDetailed		title: S1BearerInfoDetailed
	type: object		type: object
	@@ -2925,8 +3085,3 @@ components:
	description: Information on E-RAB as defined below.		description: Information on E-RAB as defined below.
	security:		security:
	- {}		- {}
	tags:
	- name: rni
	externalDocs:
	description: ETSI GS MEC 012 Radio Network Information API, V2.1.1
	url: http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf

Admin message