A.2 Nspaf_SecuredPacket API
29.5443GPP5G SystemRelease 18Secured Packet Application Function (SP-AF) servicesStage 3TS
openapi: 3.0.0
info:
title: ‘Nspaf_SecuredPacket’
version: ‘1.2.0-alpha.1’
description: |
Nspaf Secured Packet Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.544, SP-AF Services, version V18.0.0
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.544/
servers:
– url: ‘{apiRoot}/nspaf-secured-packet/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
– {}
– oAuth2ClientCredentials:
– nspaf-secured-packet
paths:
/{supi}/provide-secured-packet:
post:
summary: request generation of a secured packet
operationId: ProvideSecuredPacket
tags:
– SecuredPacket Generation (Custom Operation)
parameters:
– name: supi
in: path
description: SUPI of the user
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/UiccConfigurationParameter’
responses:
‘200’:
description: Success
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SecuredPacket’
‘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’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{nrfApiRoot}/oauth2/token’
scopes:
nspaf-secured-packet: Access to the nspaf-secured-packet API
schemas:
# COMPLEX TYPES:
UiccConfigurationParameter:
description: Represents UICC Configuration Parameters.
type: object
oneOf:
– required: [routingId ]
– required: [steeringContainer ]
– required: [extendedSteeringContainer ]
properties:
routingId:
$ref: ‘#/components/schemas/RoutingId’
steeringContainer:
type: array
items:
$ref: ‘TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo’
minItems: 1
extendedSteeringContainer:
$ref: ‘#/components/schemas/ExtendedSteeringContainer’
ExtendedSteeringContainer:
description: Represents Extended Steering Containers.
type: object
properties:
steeringContainer:
type: array
items:
$ref: ‘TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo’
minItems: 1
sorCmci:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SorCmci’
storeSorCmciInMe:
type: boolean
# SIMPLE TYPES:
RoutingId:
description: Represents a routing indicator.
type: string
pattern: ‘^[0-9]{1,4}$’
# ENUMS:
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2019-10 |
CT4#94 |
C4-194013 |
Initial Draft. |
0.1.0 |
|||
|
2019-10 |
CT4#94 |
C4-194367 |
Notaf Overview |
0.2.0 |
|||
|
2019-10 |
CT4#94 |
C4-194488 |
Notaf_SecuredPacket-Provide service operation |
0.2.0 |
|||
|
2019-10 |
CT4#94 |
C4-194492 |
Resources |
0.2.0 |
|||
|
2019-10 |
CT4#94 |
C4-194516 |
Data Model |
0.2.0 |
|||
|
2019-10 |
CT4#94 |
C4-194490 |
OpenAPI Specification |
0.2.0 |
|||
|
2019-11 |
CT4#95 |
C4-195481 |
Clean Up |
0.3.0 |
|||
|
2019-12 |
CT#86 |
CP-193071 |
TS presented for information |
1.0.0 |
|||
|
2019-12 |
CT#86 |
CP-193285 |
A title updated |
1.0.1 |
|||
|
2020-03 |
CT4#96e |
C4-201119 |
Pseudo-CR on SOR |
1.1.0 |
|||
|
2020-03 |
CT4#96e |
C4-201123 |
Pseudo-CR on Clean Up |
1.1.0 |
|||
|
2020-03 |
CT4#96e |
C4-201217 |
Pseudo-CR on the necessary modifications to change OTAF NF name to SP-AF |
1.1.0 |
|||
|
2020-03 |
CT4#96e |
C4-201314 |
Pseudo-CR on API descriptions table in clause 5.1 |
1.1.0 |
|||
|
2020-03 |
CT#87e |
CP-200062 |
TS presented for approval |
2.0.0 |
|||
|
2020-03 |
CT#87e |
Approved at CT#87e |
16.0.0 |
||||
|
2020-07 |
CT#88e |
CP-201040 |
0001 |
1 |
C |
Clarification on Secured Packet format provided by SP-AF |
16.1.0 |
|
2020-07 |
CT#88e |
CP-201040 |
0002 |
F |
Storage of YAML files in ETSI Forge |
16.1.0 |
|
|
2020-07 |
CT#88e |
CP-201040 |
0003 |
1 |
F |
Miscellaneous Corrections |
16.1.0 |
|
2020-07 |
CT#88e |
CP-201073 |
0005 |
F |
3GPP TS 29.544 API Version and External doc Update |
16.1.0 |
|
|
2020-09 |
CT#89e |
CP-202110 |
0006 |
1 |
F |
Miscelaneous corrections |
16.2.0 |
|
2020-09 |
CT#89e |
CP-202096 |
0007 |
F |
API version and External doc update |
16.2.0 |
|
|
2020-12 |
CT#90e |
CP-203048 |
0008 |
F |
Storage of yaml files |
16.3.0 |
|
|
2021-06 |
CT#92e |
CP-211051 |
0011 |
F |
OpenAPI Reference |
17.0.0 |
|
|
2021-06 |
CT#92e |
CP-211028 |
0012 |
1 |
F |
Adding some missing description fields to data type definitions in OpenAPI specification files of the Nspaf_SecuredPacket API |
17.0.0 |
|
2021-06 |
CT#92e |
CP-211050 |
0013 |
F |
29.544 Rel-17 API version and External doc update |
17.0.0 |
|
|
2021-12 |
CT#94e |
CP-213197 |
0014 |
2 |
B |
SOR-CMCI support |
17.1.0 |
|
2021-12 |
CT#94e |
CP-213121 |
0015 |
F |
29.544 Rel-17 API version and External doc update |
17.1.0 |
|
|
2022-03 |
CT#95e |
CP-220041 |
0016 |
B |
Addition of SOR-CMCI related attribute as input to SP-AF |
17.2.0 |
|
|
2022-03 |
CT#95e |
CP-220066 |
0017 |
F |
API version and External doc update |
17.2.0 |
|
|
2022-06 |
CT#96 |
CP-221300 |
0018 |
1 |
F |
API version and External doc update |
17.3.0 |
|
2022-12 |
CT#98e |
CP-223027 |
0020 |
1 |
F |
Missing Mandatory Status Codes in OpenAPI |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223033 |
0021 |
F |
29.544 Rel-18 API version and External doc update |
18.0.0 |
|