Edit TS29175_Nimsas_ImsParameterProvision.yaml, preliminary implementation of CRs after CT4#130 (d2070dbe) · Commits · All Groups / 5G APIs

TS29175_Nimsas_ImsParameterProvision.yaml

+43 −56

Original line number	Diff line number	Diff line
		openapi: 3.0.0

		info:
		title: 'IMS AS ParameterProvision Service'
		title: 'IMS AS ImsParameterProvision Service'
		version: 1.0.0-alpha.1
		description: \|
		Nimsas_ImsParameterProvision Service.
		@@ -10,7 +10,7 @@ info:

		externalDocs:
		description: >
		3GPP TS 29.175 V19.2.0; IP Multimedia Subsystem; IP Multimedia Subsystem (IMS) Application
		3GPP TS 29.175 V19.3.0; IP Multimedia Subsystem; IP Multimedia Subsystem (IMS) Application
		Server (AS) Services; Stage 3
		url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.175'

		@@ -27,26 +27,24 @@ security:
		- nimsas-ipp

		paths:
		//{imsUeId}/ims-pp-data-store/{afInstanceId}:

		/{imsUeId}/ims-pp-data-store/{afInstanceId}:
		put:
		summary: Update the IMS parameter provisioning data for a specific IMS user.
		operationId: UpdateImsParameterProvisioningDataEntry
		summary: Creates or updates the parameter provisioning data entry.
		operationId: CreateUpdatePpDataEntry
		tags:
		- Update IMS ParameterProvisioning Data Entry
		security:
		- {}
		- oAuth2ClientCredentials:
		- nimsas-ipp
		- ImsParameterProvisioningDataEntry
		parameters:
		- name: imsUeId
		in: path
		description: IMS Identity
		description: Contains the IMS public identity.
		required: true
		schema:
		$ref: 'TS29562_Nhss_imsUECM.yaml#/components/schemas/ImsUeId'
		type: string
		pattern: '^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}\|impu-tel\:\+[0-9]{5,15})$'
		- name: afInstanceId
		in: path
		description: AF instance Identity
		description: Contains the AF instance identity.
		required: true
		schema:
		type: string
		@@ -57,37 +55,36 @@ paths:
		$ref: '#/components/schemas/ImsPpDataEntry'
		required: true
		responses:
		'200':
		'201':
		description: >
		Successful creation of the IMS ParameterProvisioning Data Entry per AF.
		Created, a representation of the created ImsParameterProvisioningDataEntry resource
		is returned.
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/ImsPpDataEntry'
		'204':
		description: No content
		'307':
		description: Temporary Redirect
		content:
		application/json:
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
		headers:
		Location:
		description: The URI pointing to the resource located on the redirect target IMS AS.
		description: >
		Contains the URI of the newly created resource, according to the structure:
		{apiRoot}/nhss-ims-uecm/v1/{imsUeId}/imsas-registration
		required: true
		schema:
		type: string
		'308':
		description: Permanent Redirect
		'200':
		description: >
		OK, a representation of the updated ImsParameterProvisioningDataEntry resource
		is returned..
		content:
		application/json:
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
		headers:
		Location:
		description: The URI pointing to the resource located on the redirect target IMS AS.
		schema:
		type: string
		$ref: '#/components/schemas/ImsPpDataEntry'
		'204':
		description: No content, the ImsParameterProvisioningDataEntry resource is updated.
		'307':
		$ref: 'TS29571_CommonData.yaml#/components/responses/307'
		'308':
		$ref: 'TS29571_CommonData.yaml#/components/responses/308'
		'400':
		$ref: 'TS29571_CommonData.yaml#/components/responses/400'
		'401':
		@@ -96,8 +93,6 @@ paths:
		$ref: 'TS29571_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		'409':
		$ref: 'TS29571_CommonData.yaml#/components/responses/409'
		'411':
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413':
		@@ -113,34 +108,30 @@ paths:
		'503':
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		description: Unexpected error

		$ref: 'TS29571_CommonData.yaml#/components/responses/default'

		delete:
		summary: delete the IMS parameter provisioning data for a specific IMS user.
		operationId: DeleteImsParameterProvisioningDataEntry
		summary: Delete the parameter provisioning data entry.
		operationId: DeletePpDataEntry
		tags:
		- Delete IMS parameter provisioning data entry
		security:
		- {}
		- oAuth2ClientCredentials:
		- nimsas-ipp
		- ImsParameterProvisioningDataEntry
		parameters:
		- name: imsUeId
		in: path
		description: Individual IMS parameter provisioning data entry
		description: Contains the IMS public identity.
		required: true
		schema:
		$ref: 'TS29562_Nhss_imsUECM.yaml#/components/schemas/ImsUeId'
		type: string
		pattern: '^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}\|impu-tel\:\+[0-9]{5,15})$'
		- name: afInstanceId
		in: path
		description: AF instance Identity
		description: Contains the AF instance identity.
		required: true
		schema:
		type: string
		responses:
		'204':
		description: No content
		description: No content, the ImsParameterProvisioningDataEntry resource is deleted.
		'307':
		$ref: 'TS29571_CommonData.yaml#/components/responses/307'
		'308':
		@@ -164,7 +155,6 @@ paths:
		default:
		$ref: 'TS29571_CommonData.yaml#/components/responses/default'


		components:

		securitySchemes:
		@@ -178,14 +168,11 @@ components:

		schemas:

		# STRUCTURED DATA TYPES
		# Structured data types

		ImsPpDataEntry:
		description: The IMS parameter provision data entry per AF.
		description: Contains the IMS parameter provision data i.e. the RCD properties.
		type: object
		properties:
		rcdPropData:
		rcdProp:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/RcdProperties'

		# ENUMS

Admin message