2020-05-18 21:00:37 +00:00
openapi : 3.0 .0
info :
2021-07-07 08:32:55 +00:00
title : 3gpp-service-parameter
version : 1.0 .2
2020-05-18 21:00:37 +00:00
description : |
2021-07-07 08:32:55 +00:00
API for AF service paramter
© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
2020-05-18 21:00:37 +00:00
All rights reserved.
externalDocs :
2021-07-07 08:32:55 +00:00
description : 3GPP TS 29.522 V16.8.0; 5G System; Network Exposure Function Northbound APIs.
2020-05-18 21:00:37 +00:00
url : 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security :
- {}
- oAuth2ClientCredentials : [ ]
servers :
2021-07-07 08:32:55 +00:00
- url : '{apiRoot}/3gpp-service-parameter/v1'
2020-05-18 21:00:37 +00:00
variables :
apiRoot :
default : https://example.com
description : apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.
paths :
/{afId}/subscriptions:
parameters :
- name : afId
in : path
description : Identifier of the AF
required : true
schema :
type : string
get :
summary : read all of the active subscriptions for the AF
tags :
2021-07-07 08:32:55 +00:00
- Service Parameter Subscriptions
2020-05-18 21:00:37 +00:00
responses :
'200' :
description : OK.
content :
application/json :
schema :
type : array
items :
2021-07-07 08:32:55 +00:00
$ref : '#/components/schemas/ServiceParameterData'
minItems : 0
'307' :
$ref : 'TS29122_CommonData.yaml#/components/responses/307'
'308' :
$ref : 'TS29122_CommonData.yaml#/components/responses/308'
2020-05-18 21:00:37 +00:00
'400' :
$ref : 'TS29122_CommonData.yaml#/components/responses/400'
'401' :
$ref : 'TS29122_CommonData.yaml#/components/responses/401'
'403' :
$ref : 'TS29122_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29122_CommonData.yaml#/components/responses/404'
'406' :
$ref : 'TS29122_CommonData.yaml#/components/responses/406'
'429' :
$ref : 'TS29122_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29122_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29122_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29122_CommonData.yaml#/components/responses/default'
post :
summary : Creates a new subscription resource
tags :
2021-07-07 08:32:55 +00:00
- Service Parameter Subscriptions
2020-05-18 21:00:37 +00:00
requestBody :
description : Request to create a new subscription resource
required : true
content :
application/json :
schema :
2021-07-07 08:32:55 +00:00
$ref : '#/components/schemas/ServiceParameterData'
2020-05-18 21:00:37 +00:00
responses :
'201' :
description : Created (Successful creation of subscription)
content :
application/json :
schema :
2021-07-07 08:32:55 +00:00
$ref : '#/components/schemas/ServiceParameterData'
2020-05-18 21:00:37 +00:00
headers :
Location :
description : 'Contains the URI of the newly created resource'
required : true
schema :
type : string
'400' :
$ref : 'TS29122_CommonData.yaml#/components/responses/400'
'401' :
$ref : 'TS29122_CommonData.yaml#/components/responses/401'
'403' :
$ref : 'TS29122_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29122_CommonData.yaml#/components/responses/404'
'411' :
$ref : 'TS29122_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29122_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29122_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29122_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29122_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29122_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29122_CommonData.yaml#/components/responses/default'
/{afId}/subscriptions/{subscriptionId}:
parameters :
- name : afId
in : path
description : Identifier of the AF
required : true
schema :
type : string
- name : subscriptionId
in : path
description : Identifier of the subscription resource
required : true
schema :
type : string
get :
summary : read an active subscriptions for the SCS/AS and the subscription Id
tags :
2021-07-07 08:32:55 +00:00
- Individual Service Parameter Subscription
2020-05-18 21:00:37 +00:00
responses :
'200' :
description : OK (Successful get the active subscription)
content :
application/json :
schema :
2021-07-07 08:32:55 +00:00
$ref : '#/components/schemas/ServiceParameterData'
'307' :
$ref : 'TS29122_CommonData.yaml#/components/responses/307'
'308' :
$ref : 'TS29122_CommonData.yaml#/components/responses/308'
2020-05-18 21:00:37 +00:00
'400' :
$ref : 'TS29122_CommonData.yaml#/components/responses/400'
'401' :
$ref : 'TS29122_CommonData.yaml#/components/responses/401'
'403' :
$ref : 'TS29122_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29122_CommonData.yaml#/components/responses/404'
'406' :
$ref : 'TS29122_CommonData.yaml#/components/responses/406'
'429' :
$ref : 'TS29122_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29122_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29122_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29122_CommonData.yaml#/components/responses/default'
2021-07-07 08:32:55 +00:00
put :
summary : Updates/replaces an existing subscription resource
tags :
- Individual Service Parameter Subscription
requestBody :
description : Parameters to update/replace the existing subscription
required : true
content :
application/json :
schema :
$ref : '#/components/schemas/ServiceParameterData'
responses :
'200' :
description : OK (Successful update of the subscription)
content :
application/json :
schema :
$ref : '#/components/schemas/ServiceParameterData'
'307' :
$ref : 'TS29122_CommonData.yaml#/components/responses/307'
'308' :
$ref : 'TS29122_CommonData.yaml#/components/responses/308'
'400' :
$ref : 'TS29122_CommonData.yaml#/components/responses/400'
'401' :
$ref : 'TS29122_CommonData.yaml#/components/responses/401'
'403' :
$ref : 'TS29122_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29122_CommonData.yaml#/components/responses/404'
'411' :
$ref : 'TS29122_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29122_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29122_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29122_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29122_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29122_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29122_CommonData.yaml#/components/responses/default'
2020-05-18 21:00:37 +00:00
patch :
summary : Updates/replaces an existing subscription resource
tags :
2021-07-07 08:32:55 +00:00
- Individual Service Parameter Subscription
2020-05-18 21:00:37 +00:00
requestBody :
required : true
content :
application/merge-patch+json :
schema :
2021-07-07 08:32:55 +00:00
$ref : '#/components/schemas/ServiceParameterDataPatch'
2020-05-18 21:00:37 +00:00
responses :
'200' :
description : OK. The subscription was modified successfully.
content :
application/json :
schema :
2021-07-07 08:32:55 +00:00
$ref : '#/components/schemas/ServiceParameterData'
'307' :
$ref : 'TS29122_CommonData.yaml#/components/responses/307'
'308' :
$ref : 'TS29122_CommonData.yaml#/components/responses/308'
2020-05-18 21:00:37 +00:00
'400' :
$ref : 'TS29122_CommonData.yaml#/components/responses/400'
'401' :
$ref : 'TS29122_CommonData.yaml#/components/responses/401'
'403' :
$ref : 'TS29122_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29122_CommonData.yaml#/components/responses/404'
'411' :
$ref : 'TS29122_CommonData.yaml#/components/responses/411'
'413' :
$ref : 'TS29122_CommonData.yaml#/components/responses/413'
'415' :
$ref : 'TS29122_CommonData.yaml#/components/responses/415'
'429' :
$ref : 'TS29122_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29122_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29122_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29122_CommonData.yaml#/components/responses/default'
2021-07-07 08:32:55 +00:00
2020-05-18 21:00:37 +00:00
delete :
summary : Deletes an already existing subscription
tags :
2021-07-07 08:32:55 +00:00
- Individual Service Parameter Subscription
2020-05-18 21:00:37 +00:00
responses :
'204' :
description : No Content (Successful deletion of the existing subscription)
2021-07-07 08:32:55 +00:00
'307' :
$ref : 'TS29122_CommonData.yaml#/components/responses/307'
'308' :
$ref : 'TS29122_CommonData.yaml#/components/responses/308'
2020-05-18 21:00:37 +00:00
'400' :
$ref : 'TS29122_CommonData.yaml#/components/responses/400'
'401' :
$ref : 'TS29122_CommonData.yaml#/components/responses/401'
'403' :
$ref : 'TS29122_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29122_CommonData.yaml#/components/responses/404'
'429' :
$ref : 'TS29122_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29122_CommonData.yaml#/components/responses/500'
'503' :
$ref : 'TS29122_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29122_CommonData.yaml#/components/responses/default'
components :
securitySchemes :
oAuth2ClientCredentials :
type : oauth2
flows :
clientCredentials :
tokenUrl : '{tokenUrl}'
scopes : {}
schemas :
2021-07-07 08:32:55 +00:00
ServiceParameterData :
2020-05-18 21:00:37 +00:00
type : object
properties :
2021-07-07 08:32:55 +00:00
afServiceId :
type : string
description : Identifies a service on behalf of which the AF is issuing the request.
appId :
type : string
description : Identifies an application.
dnn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnn'
snssai :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
2020-05-18 21:00:37 +00:00
externalGroupId :
$ref : 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'
2021-07-07 08:32:55 +00:00
anyUeInd :
type : boolean
description : Identifies whether the AF request applies to any UE. This attribute shall set to "true" if applicable for any UE, otherwise, set to "false".
2020-05-18 21:00:37 +00:00
gpsi :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
2021-07-07 08:32:55 +00:00
ueIpv4 :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ueIpv6 :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
ueMac :
$ref : 'TS29571_CommonData.yaml#/components/schemas/MacAddr48'
self :
$ref : 'TS29122_CommonData.yaml#/components/schemas/Link'
paramOverPc5 :
$ref : '#/components/schemas/ParameterOverPc5'
paramOverUu :
$ref : '#/components/schemas/ParameterOverUu'
mtcProviderId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation'
2020-05-18 21:00:37 +00:00
suppFeat :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
2021-07-07 08:32:55 +00:00
ServiceParameterDataPatch :
2020-05-18 21:00:37 +00:00
type : object
properties :
2021-07-07 08:32:55 +00:00
paramOverPc5 :
$ref : '#/components/schemas/ParameterOverPc5Rm'
paramOverUu :
$ref : '#/components/schemas/ParameterOverUuRm'
ParameterOverPc5 :
type : string
ParameterOverPc5Rm :
type : string
nullable : true
ParameterOverUu :
type : string
ParameterOverUuRm :
type : string
nullable : true