A.2 Npanf_ProseKey API
29.5533GPP5G ProSe Anchor Services5G SystemRelease 18Stage 3TS
openapi: 3.0.0
info:
title: Npanf_ProseKey
version: 1.1.0-alpha.1
description: |
PAnF ProseKey Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.553 V18.0.0; 5G System; 5G ProSe Anchor Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.553/
servers:
– url: ‘{apiRoot}/npanf-prosekey/<apiVersion>‘
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
– {}
– oAuth2ClientCredentials:
– npanf-prosekey
paths:
/prose-keys/register:
post:
summary: Register the Prose Key
operationId: ProseKeyRegistration
tags:
– prosekey registration
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/ProseContextInfo’
required: true
responses:
‘204’:
description: Successful Response
‘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:
description: Unexpected error
/prose-keys/retrieve:
post:
summary: retrieve the prose key
operationId: ProseKeyRetrieval
tags:
– Prose Key Retrieval
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/ProseKeyRequest’
required: true
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/ProseKeyResponse’
‘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:
description: Unexpected error
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{nrfApiRoot}/oauth2/token’
scopes:
npanf-prosekey: Access to the Npanf_ProseKey API
schemas:
#
# Structured Data Types
#
ProseContextInfo:
description: Prose Context Info.
type: object
properties:
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
5gPruk:
$ref: ‘#/components/schemas/5GPruk’
5gPrukId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/5GPrukId’
relayServiceCode:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/RelayServiceCode’
required:
– supi
– 5gPruk
– 5gPrukId
– relayServiceCode
ProseKeyRequest:
description: Prose Key Request.
type: object
properties:
5gPrukId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/5GPrukId’
relayServiceCode:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/RelayServiceCode’
required:
– 5gPrukId
– relayServiceCode
ProseKeyResponse:
description: Prose Key Response.
type: object
properties:
5gPruk:
$ref: ‘#/components/schemas/5GPruk’
required:
– 5gPruk
#
# Simple Data Types
#
5GPruk:
description: ProSe Remote User Key over Control Plane
type: string
pattern: ‘^[A-Fa-f0-9]{64}$’
#
# Enumeration Data Types
#
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2022-08 |
CT4#111e |
C4-224498 |
Initial draft Implementation of pCRs agreed in CT4#111-e including C4-224430,C4-224046,C4-224431,C4-224432,C4-224592,C4-224433,C4-224593,C4-224373,C4-224374,C4-224594,C4-224595,C4-224377,C4-224378,C4-224596 |
0.1.0 |
|||
|
2022-09 |
CT#97-e |
CP-222239 |
TS presented for information and approval |
1.0.0 |
|||
|
2022-09 |
CT#97-e |
Approved in CT#97-e |
17.0.0 |
||||
|
2022-12 |
CT#98-e |
CP-223054 |
0002 |
2 |
F |
5GPRUK Name Alignment |
17.1.0 |
|
2022-12 |
CT#98-e |
CP-223054 |
0003 |
1 |
F |
Remove editor’s note and white spaces |
17.1.0 |
|
2022-12 |
CT#98-e |
CP-223028 |
0001 |
1 |
F |
Missing Mandatory Status Codes in OpenAPI |
18.0.0 |
|
2022-12 |
CT#98-e |
CP-223033 |
0007 |
– |
F |
29.553 Rel-18 API version and External doc update |
18.0.0 |