A.2 Nsmf_NIDD API
29.5423GPP5G SystemRelease 18Session management services for Non-IP Data Delivery (NIDD)Stage 3TS
openapi: 3.0.0
info:
version: ‘1.2.0-alpha.1’
title: ‘Nsmf_NIDD’
description: |
SMF NIDD Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.542 V18.0.0; 5G System; Session Management Services for Non-IP Data Delivery (NIDD); Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.542/
servers:
– url: ‘{apiRoot}/nsmf-nidd/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
security:
– {}
– oAuth2ClientCredentials:
– nsmf-nidd
paths:
‘/pdu-sessions/{pduSessionRef}/deliver’:
post:
summary: Delivery Service Operation
tags:
– Individual PDU session
operationId: Deliver
parameters:
– name: pduSessionRef
in: path
description: PDU session reference
required: true
schema:
type: string
requestBody:
description: representation of the payload of Deliver Request
required: true
content:
multipart/related: # message with a binary body part
schema:
type: object
properties:
jsonData:
$ref: ‘#/components/schemas/DeliverReqData’
binaryMtData:
type: string
format: binary
encoding:
jsonData:
contentType: application/json
binaryMtData:
contentType: application/vnd.3gpp.5gnas
headers:
Content-Id:
schema:
type: string
responses:
‘204’:
description: successful transfering of Delivery
‘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’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
‘504’:
description: unsuccessful delivery of mobile terminated data – gateway timeout
content:
application/json:
schema:
$ref: ‘#/components/schemas/DeliverError’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{nrfApiRoot}/oauth2/token’
scopes:
nsmf-nidd: Access to the nsmf-nidd API
schemas:
#
# STRUCTURED DATA TYPES
#
DeliverReqData:
description: Representation of the payload of a Deliver Request.
type: object
properties:
mtData:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/RefToBinaryData’
required:
– mtData
DeliverAddInfo:
description: Additional information in an error response to a Deliver Request.
type: object
properties:
maxWaitingTime:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DurationSec’
#
# DATA TYPES DESCRIBING ALTERNATIVE OR COMBINATION OF DATA TYPES
#
DeliverError:
description: Representation of the payload in an error response to a Deliver Request.
allOf:
– $ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
– $ref: ‘#/components/schemas/DeliverAddInfo’
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2020-03 |
CT4#96-e |
C4-201267 |
Initial Draft. |
0.1.0 |
|||
|
2020-03 |
CT#87e |
CP-200093 |
Presented for information and approval |
1.0.0 |
|||
|
2020-03 |
CT#87e |
Approved at CT#87e |
16.0.0 |
||||
|
2020-06 |
CT#88e |
CP-201071 |
0001 |
2 |
F |
Storage of YAML files in ETSI Forge |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201046 |
0003 |
F |
Miscellaneous Corrections |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201073 |
0004 |
F |
29.542 Rel-16 API version and External doc update |
16.1.0 |
|
|
2020-09 |
CT#89e |
CP-202105 |
0005 |
F |
Optionality of DeliverError |
16.2.0 |
|
|
2020-12 |
CT#90e |
CP-203032 |
0007 |
F |
YAML files in 3GPP Forge |
16.3.0 |
|
|
2021-03 |
CT#91e |
CP-210037 |
0010 |
1 |
F |
HTTP 3xx redirection |
17.0.0 |
|
2021-03 |
CT#91e |
CP-210034 |
0011 |
1 |
F |
OpenAPI Reference |
17.0.0 |
|
2021-03 |
CT#91e |
CP-210054 |
0013 |
– |
F |
29.542 Rel-16 API version and External doc update |
17.0.0 |
|
2021-06 |
CT#92e |
CP-210050 |
0014 |
1 |
F |
Resolving Warning in Nsmf_NIDD API |
17.1.0 |
|
2021-06 |
CT#92e |
CP-210050 |
0017 |
1 |
A |
Redirect Response |
17.1.0 |
|
2021-06 |
CT#92e |
CP-210050 |
0018 |
F |
29.542 Rel-17 API version and External doc update |
17.1.0 |
|
|
2021-09 |
CT#93e |
CP-212060 |
0021 |
– |
A |
3xx description correction for SCP |
17.2.0 |
|
2022-03 |
CT#95e |
CP-220025 |
0025 |
1 |
F |
SMF reference model update |
17.3.0 |
|
2022-06 |
CT#96 |
CP-221051 |
0027 |
F |
29.542 Rel-17 API version and External doc update |
17.4.0 |
|
|
2022-12 |
CT#98 |
CP-223028 |
0029 |
1 |
F |
Missing Mandatory Status Codes in OpenAPI |
18.0.0 |
|
2022-12 |
CT#98 |
CP-223033 |
0030 |
F |
29.542 Rel-18 API version and External doc update |
18.0.0 |
|