Merge branch 'REL-15' of https://forge.etsi.org/gitlab/3GPP/openapis-playground into REL-15 (81e375da) · Commits · All Groups / 5G APIs

README.md

+68 −68

File changed.

Preview size limit exceeded, changes collapsed.

TS29502_Nsmf_PDUSession.yaml

+122 −59

Original line number	Diff line number	Diff line
		openapi: 3.0.0

		info:
		version: '1.0.1'
		version: '1.0.2'
		title: 'Nsmf_PDUSession'
		description: 'SMF PDU Session Service'
		description: \|
		SMF PDU Session Service.
		© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.

		externalDocs:
		description: 3GPP TS 29.502 V15.3.0; 5G System; Session Management Services; Stage 3
		description: 3GPP TS 29.502 V15.4.0; 5G System; Session Management Services; Stage 3
		url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.502/

		servers:
		@@ -14,7 +17,7 @@ servers:
		variables:
		apiRoot:
		default: https://example.com
		description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501. The sm-contexts and pdu-sessions resources can be distributed on different processing instances or hosts. Thus the authority and/or deployment-specific string of the apiRoot of the created individual sm context and pdu-session resources' URIs may differ from the authority and/or deployment-specific string of the apiRoot of the sm-contexts and pdu-sessions collections' URIs.
		description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. The sm-contexts and pdu-sessions resources can be distributed on different processing instances or hosts. Thus the authority and/or deployment-specific string of the apiRoot of the created individual sm context and pdu-session resources' URIs may differ from the authority and/or deployment-specific string of the apiRoot of the sm-contexts and pdu-sessions collections' URIs.

		security:
		- {}
		@@ -65,6 +68,12 @@ paths:
		description: successful notification
		'307':
		description: temporary redirect
		headers:
		Location:
		required: true
		description: 'A URI pointing to the endpoint of another NF service consumer to which the notification should be sent'
		schema:
		type: string
		'400':
		$ref: 'TS29571_CommonData.yaml#/components/responses/400'
		'403':
		@@ -111,15 +120,27 @@ paths:
		type: string
		headers:
		Location:
		description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-pdusession/v1/sm-contexts/{smContextRef}'
		description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-pdusession/{apiVersion}/sm-contexts/{smContextRef}'
		required: true
		schema:
		type: string

		'307':
		description: temporary redirect
		headers:
		Location:
		description: 'An alternative URI of the resource located on an alternative service instance within the SMF that was selected by the AMF'
		required: true
		schema:
		type: string
		'308':
		description: permanent redirect
		headers:
		Location:
		description: 'An alternative URI of the resource located on an alternative service instance within the SMF that was selected by the AMF'
		required: true
		schema:
		type: string
		'400':
		description: unsuccessful creation of an SM context - bad request
		content:
		@@ -856,14 +877,26 @@ paths:
		type: string
		headers:
		Location:
		description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-pdusession/v1/pdu-sessions/{pduSessionRef}'
		description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-pdusession/{apiVersion}/pdu-sessions/{pduSessionRef}'
		required: true
		schema:
		type: string
		'307':
		description: temporary redirect
		headers:
		Location:
		description: 'An alternative URI of the resource located on an alternative service instance within the SMF that was selected by the AMF'
		required: true
		schema:
		type: string
		'308':
		description: permanent redirect
		headers:
		Location:
		description: 'An alternative URI of the resource located on an alternative service instance within the SMF that was selected by the AMF'
		required: true
		schema:
		type: string
		'400':
		$ref: '#/components/responses/PduSessionCreateError'
		'403':
		@@ -1127,6 +1160,8 @@ components:
		type: boolean
		targetId:
		$ref: 'TS29518_Namf_Communication.yaml#/components/schemas/NgRanTargetId'
		epsBearerCtxStatus:
		$ref: '#/components/schemas/EpsBearerContextStatus'
		required:
		- servingNfId
		- servingNetwork
		@@ -1155,6 +1190,8 @@ components:
		minItems: 1
		hoState:
		$ref: '#/components/schemas/HoState'
		gpsi:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
		smfServiceInstanceId:
		type: string
		recoveryTime:
		@@ -1167,8 +1204,6 @@ components:
		properties:
		pei:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Pei'
		gpsi:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
		servingNfId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
		guami:
		@@ -1395,6 +1430,12 @@ components:
		type: string
		oldPduSessionId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
		epsBearerCtxStatus:
		$ref: '#/components/schemas/EpsBearerContextStatus'
		amfNfId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
		guami:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Guami'
		required:
		- dnn
		- vsmfId
		@@ -1449,6 +1490,8 @@ components:
		alwaysOnGranted:
		type: boolean
		default: false
		gpsi:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
		upSecurity:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/UpSecurity'
		roamingChargingProfile:
		@@ -1537,6 +1580,14 @@ components:
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageReport'
		minItems: 1
		secondaryRatUsageInfo:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo'
		minItems: 1
		anTypeCanBeChanged:
		type: boolean
		default: false
		required:
		- requestIndication

		@@ -1566,9 +1617,12 @@ components:
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageReport'
		minItems: 1
		secondaryRatUsageInfo:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo'
		minItems: 1

		ReleasedData:
		type: object

		VsmfUpdateData:
		type: object
		@@ -1680,6 +1734,11 @@ components:
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageReport'
		minItems: 1
		secondaryRatUsageInfo:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo'
		minItems: 1

		StatusNotification:
		type: object
		@@ -2003,6 +2062,10 @@ components:
		Teid:
		type: string
		pattern: '^[A-F0-9]{8}$'

		EpsBearerContextStatus:
		type: string
		pattern: '^[A-Fa-f0-9]{4}$'
		#
		# ENUMERATIONS
		#
		@@ -2120,7 +2183,7 @@ components:
		- EPS_FALLBACK
		- REL_DUE_TO_UP_SEC
		- DNN_CONGESTION
		- S-NSSAI_CONGESTION
		- S_NSSAI_CONGESTION
		- REL_DUE_TO_REACTIVATION
		- 5G_AN_NOT_RESPONDING
		- REL_DUE_TO_SLICE_NOT_AVAILABLE
		@@ -2140,7 +2203,7 @@ components:
		- EPS_FALLBACK
		- REL_DUE_TO_UP_SEC
		- DNN_CONGESTION
		- S-NSSAI_CONGESTION
		- S_NSSAI_CONGESTION
		- REL_DUE_TO_REACTIVATION
		- 5G_AN_NOT_RESPONDING
		- REL_DUE_TO_SLICE_NOT_AVAILABLE

TS29503_Nudm_EE.yaml

+11 −5

Original line number	Diff line number	Diff line
		openapi: 3.0.0

		info:
		version: '1.0.1'
		version: '1.0.2'
		title: 'Nudm_EE'
		description: 'Nudm Event Exposure Service'
		description: \|
		Nudm Event Exposure Service.
		© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.

		externalDocs:
		description: 3GPP TS 29.503 Unified Data Management Services, version 15.3.0
		description: 3GPP TS 29.503 Unified Data Management Services, version 15.4.0
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'

		servers:
		@@ -14,7 +17,7 @@ servers:
		variables:
		apiRoot:
		default: https://example.com
		description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501.
		description: apiRoot as defined in clause clause 4.4 of 3GPP TS 29.501.

		security:
		- oAuth2ClientCredentials:
		@@ -215,6 +218,9 @@ components:
		$ref: '#/components/schemas/ReportingOptions'
		supportedFeatures:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
		subscriptionId:
		type: string


		MonitoringConfiguration:
		type: object

TS29503_Nudm_PP.yaml

+8 −7

Original line number	Diff line number	Diff line
		openapi: 3.0.0

		info:
		version: '1.0.0'
		version: '1.0.1'
		title: 'Nudm_PP'
		description: 'Nudm Parameter Provision Service'
		description: \|
		Nudm Parameter Provision Service.
		© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.

		externalDocs:
		description: 3GPP TS 29.503 Unified Data Management Services, version 15.3.0
		description: 3GPP TS 29.503 Unified Data Management Services, version 15.4.0
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'

		servers:
		@@ -14,7 +17,7 @@ servers:
		variables:
		apiRoot:
		default: https://example.com
		description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501.
		description: apiRoot as defined in clause clause 4.4 of 3GPP TS 29.501.

		security:
		- oAuth2ClientCredentials:
		@@ -133,5 +136,3 @@ components:


		# ENUMS:
		No newline at end of file

TS29503_Nudm_SDM.yaml

+126 −25

Original line number	Diff line number	Diff line
		openapi: 3.0.0

		info:
		version: '2.0.0'
		version: '2.0.1'
		title: 'Nudm_SDM'
		description: 'Nudm Subscriber Data Management Service'
		description: \|
		Nudm Subscriber Data Management Service.
		© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.

		externalDocs:
		description: 3GPP TS 29.503 Unified Data Management Services, version 15.3.0
		description: 3GPP TS 29.503 Unified Data Management Services, version 15.4.0
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'

		servers:
		@@ -14,7 +17,7 @@ servers:
		variables:
		apiRoot:
		default: https://example.com
		description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501.
		description: apiRoot as defined in clause clause 4.4 of 3GPP TS 29.501.

		security:
		- oAuth2ClientCredentials:
		@@ -25,7 +28,7 @@ paths:
		/{supi}:
		get:
		summary: retrieve multiple data sets
		operationId: Get
		operationId: GetDataSets
		tags:
		- Retrieval of multiple data sets
		parameters:
		@@ -98,7 +101,7 @@ paths:
		/{supi}/nssai:
		get:
		summary: retrieve a UE's subscribed NSSAI
		operationId: Get
		operationId: GetNSSAI
		tags:
		- Slice Selection Subscription Data Retrieval
		parameters:
		@@ -163,7 +166,7 @@ paths:
		/{supi}/am-data:
		get:
		summary: retrieve a UE's Access and Mobility Subscription Data
		operationId: Get
		operationId: GetAmData
		tags:
		- Access and Mobility Subscription Data Retrieval
		parameters:
		@@ -228,7 +231,7 @@ paths:
		/{supi}/smf-select-data:
		get:
		summary: retrieve a UE's SMF Selection Subscription Data
		operationId: Get
		operationId: GetSmfSelData
		tags:
		- SMF Selection Subscription Data Retrieval
		parameters:
		@@ -293,7 +296,7 @@ paths:
		/{supi}/ue-context-in-smf-data:
		get:
		summary: retrieve a UE's UE Context In SMF Data
		operationId: Get
		operationId: GetUeCtxInSmfData
		tags:
		- UE Context In SMF Data Retrieval
		parameters:
		@@ -328,7 +331,7 @@ paths:
		/{supi}/ue-context-in-smsf-data:
		get:
		summary: retrieve a UE's UE Context In SMSF Data
		operationId: Get
		operationId: GetUeCtxInSmsfData
		tags:
		- UE Context In SMSF Data Retrieval
		parameters:
		@@ -363,7 +366,7 @@ paths:
		/{supi}/trace-data:
		get:
		summary: retrieve a UE's Trace Configuration Data
		operationId: Get
		operationId: GetTraceConfigData
		tags:
		- Trace Configuration Data Retrieval
		parameters:
		@@ -428,7 +431,7 @@ paths:
		/{supi}/sm-data:
		get:
		summary: retrieve a UE's Session Management Subscription Data
		operationId: Get
		operationId: GetSmData
		tags:
		- Session Management Subscription Data Retrieval
		parameters:
		@@ -505,7 +508,7 @@ paths:
		/{supi}/sms-data:
		get:
		summary: retrieve a UE's SMS Subscription Data
		operationId: Get
		operationId: GetSmsData
		tags:
		- SMS Subscription Data Retrieval
		parameters:
		@@ -569,7 +572,7 @@ paths:
		/{supi}/sms-mng-data:
		get:
		summary: retrieve a UE's SMS Management Subscription Data
		operationId: Get
		operationId: GetSmsMngtData
		tags:
		- SMS Management Subscription Data Retrieval
		parameters:
		@@ -658,7 +661,7 @@ paths:
		$ref: '#/components/schemas/SdmSubscription'
		headers:
		Location:
		description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-sdm/v1/{supi}/sdm-subscriptions/{subscriptionId}'
		description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/sdm-subscriptions/{subscriptionId}'
		required: true
		schema:
		type: string
		@@ -693,12 +696,24 @@ paths:
		application/problem+json:
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
		headers:
		Location:
		description: 'Contains the new Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected'
		required: true
		schema:
		type: string
		'308':
		description: Permanent Redirect
		content:
		application/problem+json:
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
		headers:
		Location:
		description: 'Contains the new Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected'
		required: true
		schema:
		type: string
		'400':
		$ref: 'TS29571_CommonData.yaml#/components/responses/400'
		'404':
		@@ -783,7 +798,7 @@ paths:
		/{gpsi}/id-translation-result:
		get:
		summary: retrieve a UE's SUPI
		operationId: Get
		operationId: GetSupi
		tags:
		- GPSI to SUPI Translation
		parameters:
		@@ -841,7 +856,7 @@ paths:
		/{supi}/am-data/sor-ack:
		put:
		summary: Nudm_Sdm Info service operation
		operationId: Info
		operationId: SorAckInfo
		tags:
		- Providing acknowledgement of Steering of Roaming
		parameters:
		@@ -870,7 +885,7 @@ paths:
		/{supi}/am-data/upu-ack:
		put:
		summary: Nudm_Sdm Info for UPU service operation
		operationId: PutUpuAck
		operationId: UpuAck
		tags:
		- Providing acknowledgement of UE Parameters Update
		parameters:
		@@ -962,7 +977,7 @@ paths:
		/shared-data-subscriptions:
		post:
		summary: subscribe to notifications for shared data
		operationId: Subscribe to shared data
		operationId: SubscribeToSharedData
		tags:
		- Subscription Creation for shared data
		requestBody:
		@@ -980,7 +995,7 @@ paths:
		$ref: '#/components/schemas/SdmSubscription'
		headers:
		Location:
		description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-sdm/v1/shared-data-subscriptions/{subscriptionId}'
		description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-sdm/<apiVersion>/shared-data-subscriptions/{subscriptionId}'
		required: true
		schema:
		type: string
		@@ -1016,7 +1031,7 @@ paths:
		/shared-data-subscriptions/{subscriptionId}:
		delete:
		summary: unsubscribe from notifications for shared data
		operationId: Unsubscribe for shared data
		operationId: UnsubscribeForSharedData
		tags:
		- Subscription Deletion for shared data
		parameters:
		@@ -1039,7 +1054,7 @@ paths:
		description: Unexpected error
		patch:
		summary: modify the subscription
		operationId: Modify
		operationId: ModifySharedDataSubs
		tags:
		- Subscription Modification
		parameters:
		@@ -1073,6 +1088,71 @@ paths:
		default:
		description: Unexpected error

		/group-data/group-identifiers:
		get:
		summary: Mapping of Group Identifiers
		operationId: GetGroupIdentifiers
		tags:
		- Group Identifiers
		parameters:
		- name: ext-group-id
		in: query
		description: External Group Identifier
		required: false
		schema:
		$ref: '#/components/schemas/ExtGroupId'
		- name: int-group-id
		in: query
		description: Internal Group Identifier
		required: false
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'
		- name: supported-features
		in: query
		description: Supported Features
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
		- name: If-None-Match
		in: header
		description: Validator for conditional requests, as described in RFC 7232, 3.2
		schema:
		type: string
		- name: If-Modified-Since
		in: header
		description: Validator for conditional requests, as described in RFC 7232, 3.3
		schema:
		type: string
		responses:
		'200':
		description: Expected response to a valid request
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/GroupIdentifiers'
		headers:
		Cache-Control:
		description: Cache-Control containing max-age, as described in RFC 7234, 5.2
		schema:
		type: string
		ETag:
		description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3
		schema:
		type: string
		Last-Modified:
		description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2
		schema:
		type: string
		'400':
		$ref: 'TS29571_CommonData.yaml#/components/responses/400'
		'404':
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		'500':
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'503':
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		description: Unexpected error

		components:
		securitySchemes:
		oAuth2ClientCredentials:
		@@ -1332,8 +1412,10 @@ components:
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'
		minItems: 1
		sharedDnnConfigurationsIds:
		sharedDnnConfigurationsId:
		$ref: '#/components/schemas/SharedDataId'
		odbPacketServices:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/OdbPacketServices'

		DnnConfiguration:
		type: object
		@@ -1412,7 +1494,7 @@ components:
		smsSubscribed:
		$ref: '#/components/schemas/SmsSubscribed'
		sharedSmsSubsDataId:
		$ref: '#/components/schemas/SharedDataIds'
		$ref: '#/components/schemas/SharedDataId'

		SmsManagementSubscriptionData:
		type: object
		@@ -1473,6 +1555,11 @@ components:
		properties:
		expires:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		monitoredResourceUris:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
		minItems: 1

		ModificationNotification:
		type: object
		@@ -1532,6 +1619,8 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/SharedDataId'
		minItems: 1
		uniqueItems: true

		UpuInfo:
		type: object
		@@ -1598,6 +1687,14 @@ components:
		minItems: 1
		- $ref: '#/components/schemas/SecuredPacket'

		GroupIdentifiers:
		type: object
		properties:
		extGroupId:
		$ref: '#/components/schemas/ExtGroupId'
		intGroupId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'


		# SIMPLE TYPES:

		@@ -1643,6 +1740,10 @@ components:
		UpuRegInd:
		type: boolean

		ExtGroupId:
		type: string
		pattern: '^extgroupid-[^@]+@[^@]+$'


		# ENUMS: