2020-05-18 21:00:37 +00:00
openapi : 3.0 .0
2020-06-04 18:12:05 +00:00
2020-05-18 21:00:37 +00:00
info :
2021-07-07 08:32:55 +00:00
version : '1.1.4'
2020-05-18 21:00:37 +00:00
title : 'NRF NFManagement Service'
description : |
NRF NFManagement Service.
2021-07-07 08:32:55 +00:00
© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
2020-05-18 21:00:37 +00:00
All rights reserved.
2020-06-04 18:12:05 +00:00
externalDocs :
2021-07-07 08:32:55 +00:00
description : 3GPP TS 29.510 V16.8.0; 5G System; Network Function Repository Services; Stage 3
2020-06-04 18:12:05 +00:00
url : 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.510/'
2020-05-18 21:00:37 +00:00
servers :
- url : '{apiRoot}/nnrf-nfm/v1'
variables :
apiRoot :
default : https://example.com
2020-06-04 18:12:05 +00:00
description : apiRoot as defined in clause 4.4 of 3GPP TS 29.501
2020-05-18 21:00:37 +00:00
security :
- {}
- oAuth2ClientCredentials :
- nnrf-nfm
2020-06-04 18:12:05 +00:00
2020-05-18 21:00:37 +00:00
paths :
/nf-instances :
get :
summary : Retrieves a collection of NF Instances
operationId : GetNFInstances
tags :
- NF Instances (Store)
parameters :
- name : nf-type
in : query
description : Type of NF
required : false
schema :
$ref : '#/components/schemas/NFType'
- name : limit
in : query
description : How many items to return at one time
required : false
schema :
type : integer
responses :
'200' :
description : Expected response to a valid request
content :
application/3gppHal+json :
schema :
type : object
properties :
_links :
type : object
description : 'List of the URI of NF instances. It has two members whose names are item and self. The item one contains an array of URIs.'
additionalProperties :
$ref : 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema'
minProperties : 1
2021-03-08 12:25:09 +00:00
'307' :
description : Temporary Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
'308' :
description : Permanent Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
2020-05-18 21:00:37 +00:00
'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'
'406' :
$ref : 'TS29571_CommonData.yaml#/components/responses/406'
'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'
'501' :
$ref : 'TS29571_CommonData.yaml#/components/responses/501'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
options :
summary : Discover communication options supported by NRF for NF Instances
operationId : OptionsNFInstances
tags :
- NF Instances (Store)
responses :
'200' :
description : OK
2021-03-08 12:25:09 +00:00
content :
application/json :
schema :
$ref : '#/components/schemas/OptionsResponse'
headers :
Accept-Encoding :
description : Accept-Encoding, described in IETF RFC 7694
schema :
type : string
'204' :
description : No Content
2020-05-18 21:00:37 +00:00
headers :
Accept-Encoding :
description : Accept-Encoding, described in IETF RFC 7694
schema :
type : string
2021-03-08 12:25:09 +00:00
'307' :
description : Temporary Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
'308' :
description : Permanent Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
2020-05-18 21:00:37 +00:00
'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'
'405' :
$ref : 'TS29571_CommonData.yaml#/components/responses/405'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29571_CommonData.yaml#/components/responses/500'
'501' :
$ref : 'TS29571_CommonData.yaml#/components/responses/501'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
/nf-instances/{nfInstanceID}:
get :
summary : Read the profile of a given NF Instance
operationId : GetNFInstance
tags :
- NF Instance ID (Document)
parameters :
- name : nfInstanceID
in : path
description : Unique ID of the NF Instance
required : true
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
2021-03-08 12:25:09 +00:00
- name : requester-features
in : query
description : Features supported by the NF Service Consumer
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
2020-05-18 21:00:37 +00:00
responses :
'200' :
description : Expected response to a valid request
2021-07-07 08:32:55 +00:00
headers :
ETag :
description : Entity Tag containing a strong validator, described in IETF RFC 7232, 2.3
schema :
type : string
2020-05-18 21:00:37 +00:00
content :
application/json :
schema :
$ref : '#/components/schemas/NFProfile'
2021-03-08 12:25:09 +00:00
'307' :
description : Temporary Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
'308' :
description : Permanent Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
2020-05-18 21:00:37 +00:00
'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'
'406' :
$ref : 'TS29571_CommonData.yaml#/components/responses/406'
'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'
'501' :
$ref : 'TS29571_CommonData.yaml#/components/responses/501'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
put :
summary : Register a new NF Instance
operationId : RegisterNFInstance
tags :
- NF Instance ID (Document)
parameters :
- name : nfInstanceID
in : path
required : true
description : Unique ID of the NF Instance to register
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
- name : Content-Encoding
in : header
2020-06-04 18:12:05 +00:00
description : Content-Encoding, described in IETF RFC 7231
schema :
type : string
- name : Accept-Encoding
in : header
description : Accept-Encoding, described in IETF RFC 7231
2020-05-18 21:00:37 +00:00
schema :
type : string
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/NFProfile'
required : true
responses :
'200' :
description : OK (Profile Replacement)
content :
application/json :
schema :
$ref : '#/components/schemas/NFProfile'
headers :
Accept-Encoding :
description : Accept-Encoding, described in IETF RFC 7694
schema :
type : string
2020-06-04 18:12:05 +00:00
Content-Encoding :
description : Content-Encoding, described in IETF RFC 7231
schema :
type : string
2021-07-07 08:32:55 +00:00
ETag :
description : Entity Tag containing a strong validator, described in IETF RFC 7232, 2.3
schema :
type : string
2020-05-18 21:00:37 +00:00
'201' :
description : Expected response to a valid request
content :
application/json :
schema :
$ref : '#/components/schemas/NFProfile'
headers :
Location :
description: 'Contains the URI of the newly created resource, according to the structure : {apiRoot}/nnrf-nfm/v1/nf-instances/{nfInstanceId}'
required : true
schema :
type : string
Accept-Encoding :
description : Accept-Encoding, described in IETF RFC 7694
schema :
type : string
2020-06-04 18:12:05 +00:00
Content-Encoding :
description : Content-Encoding, described in IETF RFC 7231
schema :
type : string
2021-07-07 08:32:55 +00:00
ETag :
description : Entity Tag containing a strong validator, described in IETF RFC 7232, 2.3
schema :
type : string
2021-03-08 12:25:09 +00:00
'307' :
description : Temporary Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
'308' :
description : Permanent Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
2020-05-18 21:00:37 +00:00
'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'
'501' :
$ref : 'TS29571_CommonData.yaml#/components/responses/501'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
patch :
summary : Update NF Instance profile
operationId : UpdateNFInstance
tags :
- NF Instance ID (Document)
parameters :
- name : nfInstanceID
in : path
required : true
description : Unique ID of the NF Instance to update
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
2020-06-04 18:12:05 +00:00
- name : Content-Encoding
in : header
description : Content-Encoding, described in IETF RFC 7231
schema :
type : string
- name : Accept-Encoding
in : header
description : Accept-Encoding, described in IETF RFC 7231
schema :
type : string
2021-07-07 08:32:55 +00:00
- name : If-Match
in : header
description : Validator for conditional requests, as described in IETF RFC 7232, 3.2
schema :
type : string
2020-05-18 21:00:37 +00:00
requestBody :
content :
application/json-patch+json :
schema :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
minItems : 1
required : true
responses :
'200' :
description : Expected response to a valid request
content :
application/json :
schema :
$ref : '#/components/schemas/NFProfile'
2020-06-04 18:12:05 +00:00
headers :
Accept-Encoding :
description : Accept-Encoding, described in IETF RFC 7694
schema :
type : string
2021-07-07 08:32:55 +00:00
ETag :
description : Entity Tag containing a strong validator, described in IETF RFC 7232, 2.3
schema :
type : string
2020-06-04 18:12:05 +00:00
Content-Encoding :
description : Content-Encoding, described in IETF RFC 7231
schema :
type : string
2020-05-18 21:00:37 +00:00
'204' :
description : Expected response with empty body
2020-06-04 18:12:05 +00:00
headers :
Accept-Encoding :
description : Accept-Encoding, described in IETF RFC 7694
schema :
type : string
2021-03-08 12:25:09 +00:00
'307' :
description : Temporary Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
'308' :
description : Permanent Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
2020-05-18 21:00:37 +00:00
'400' :
$ref : 'TS29571_CommonData.yaml#/components/responses/400'
'403' :
$ref : 'TS29571_CommonData.yaml#/components/responses/403'
'404' :
$ref : 'TS29571_CommonData.yaml#/components/responses/404'
2021-07-07 08:32:55 +00:00
'409' :
$ref : 'TS29571_CommonData.yaml#/components/responses/409'
2020-05-18 21:00:37 +00:00
'411' :
$ref : 'TS29571_CommonData.yaml#/components/responses/411'
2021-07-07 08:32:55 +00:00
'412' :
$ref : 'TS29571_CommonData.yaml#/components/responses/412'
2020-05-18 21:00:37 +00:00
'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'
'501' :
$ref : 'TS29571_CommonData.yaml#/components/responses/501'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
delete :
summary : Deregisters a given NF Instance
operationId : DeregisterNFInstance
tags :
- NF Instance ID (Document)
parameters :
- name : nfInstanceID
in : path
required : true
description : Unique ID of the NF Instance to deregister
schema :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
responses :
'204' :
description : Expected response to a successful deregistration
2021-03-08 12:25:09 +00:00
'307' :
description : Temporary Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
'308' :
description : Permanent Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
2020-05-18 21:00:37 +00:00
'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'
'429' :
$ref : 'TS29571_CommonData.yaml#/components/responses/429'
'500' :
$ref : 'TS29571_CommonData.yaml#/components/responses/500'
'501' :
$ref : 'TS29571_CommonData.yaml#/components/responses/501'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
/subscriptions :
post :
summary : Create a new subscription
operationId : CreateSubscription
tags :
- Subscriptions (Collection)
2020-06-04 18:12:05 +00:00
parameters :
- name : Content-Encoding
in : header
description : Content-Encoding, described in IETF RFC 7231
schema :
type : string
- name : Accept-Encoding
in : header
description : Accept-Encoding, described in IETF RFC 7231
schema :
type : string
2020-05-18 21:00:37 +00:00
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/SubscriptionData'
required : true
responses :
'201' :
description : Expected response to a valid request
content :
application/json :
schema :
$ref : '#/components/schemas/SubscriptionData'
headers :
Location :
description: 'Contains the URI of the newly created resource, according to the structure : {apiRoot}/nnrf-nfm/v1/subscriptions/{subscriptionId}'
required : true
schema :
type : string
2020-06-04 18:12:05 +00:00
Accept-Encoding :
description : Accept-Encoding, described in IETF RFC 7694
schema :
type : string
Content-Encoding :
description : Content-Encoding, described in IETF RFC 7231
schema :
type : string
2021-03-08 12:25:09 +00:00
'307' :
description : Temporary Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
'308' :
description : Permanent Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
2020-05-18 21:00:37 +00:00
'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'
'501' :
$ref : 'TS29571_CommonData.yaml#/components/responses/501'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
callbacks :
onNFStatusEvent :
'{$request.body#/nfStatusNotificationUri}' :
post :
2020-06-04 18:12:05 +00:00
parameters :
- name : Content-Encoding
in : header
description : Content-Encoding, described in IETF RFC 7231
schema :
type : string
2020-05-18 21:00:37 +00:00
requestBody :
description : Notification Payload
content :
application/json :
schema :
$ref : '#/components/schemas/NotificationData'
responses :
'204' :
description : Expected response to a successful callback processing
2020-06-04 18:12:05 +00:00
headers :
Accept-Encoding :
description : Accept-Encoding, described in IETF RFC 7694
schema :
type : string
2021-03-08 12:25:09 +00:00
'307' :
description : Temporary Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on another NF service consumer instance'
required : true
schema :
type : string
'308' :
description : Permanent Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on another NF service consumer instance'
required : true
schema :
type : string
2020-05-18 21:00:37 +00:00
'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'
'501' :
$ref : 'TS29571_CommonData.yaml#/components/responses/501'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
/subscriptions/{subscriptionID}:
patch :
summary : Updates a subscription
operationId : UpdateSubscription
tags :
- Subscription ID (Document)
parameters :
- name : subscriptionID
in : path
required : true
description : Unique ID of the subscription to update
schema :
type : string
pattern : '^([0-9]{5,6}-)?[^-]+$'
2020-06-04 18:12:05 +00:00
- name : Content-Encoding
in : header
description : Content-Encoding, described in IETF RFC 7231
schema :
type : string
- name : Accept-Encoding
in : header
description : Accept-Encoding, described in IETF RFC 7231
schema :
type : string
2020-05-18 21:00:37 +00:00
requestBody :
content :
application/json-patch+json :
schema :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
required : true
responses :
'200' :
description : Expected response to a valid request
content :
application/json :
schema :
$ref : '#/components/schemas/SubscriptionData'
2020-06-04 18:12:05 +00:00
headers :
Accept-Encoding :
description : Accept-Encoding, described in IETF RFC 7694
schema :
type : string
Content-Encoding :
description : Content-Encoding, described in IETF RFC 7231
schema :
type : string
2020-05-18 21:00:37 +00:00
'204' :
description : No Content
2020-06-04 18:12:05 +00:00
headers :
Accept-Encoding :
description : Accept-Encoding, described in IETF RFC 7694
schema :
type : string
2021-03-08 12:25:09 +00:00
'307' :
description : Temporary Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
'308' :
description : Permanent Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
2020-05-18 21:00:37 +00:00
'400' :
$ref : 'TS29571_CommonData.yaml#/components/responses/400'
'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'
'501' :
$ref : 'TS29571_CommonData.yaml#/components/responses/501'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
delete :
summary : Deletes a subscription
operationId : RemoveSubscription
tags :
- Subscription ID (Document)
parameters :
- name : subscriptionID
in : path
required : true
description : Unique ID of the subscription to remove
schema :
type : string
pattern : '^([0-9]{5,6}-)?[^-]+$'
responses :
'204' :
description : Expected response to a successful subscription removal
2021-03-08 12:25:09 +00:00
'307' :
description : Temporary Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
'308' :
description : Permanent Redirect
content :
2021-07-07 08:32:55 +00:00
application/json :
2021-03-08 12:25:09 +00:00
schema :
2021-07-07 08:32:55 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
2021-03-08 12:25:09 +00:00
headers :
Location :
description : 'The URI pointing to the resource located on the redirect target NRF'
required : true
schema :
type : string
2020-05-18 21:00:37 +00:00
'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'
'501' :
$ref : 'TS29571_CommonData.yaml#/components/responses/501'
'503' :
$ref : 'TS29571_CommonData.yaml#/components/responses/503'
default :
$ref : 'TS29571_CommonData.yaml#/components/responses/default'
components :
securitySchemes :
oAuth2ClientCredentials :
type : oauth2
2020-06-04 18:12:05 +00:00
flows :
clientCredentials :
2020-05-18 21:00:37 +00:00
tokenUrl : '/oauth2/token'
scopes :
nnrf-nfm : Access to the Nnrf_NFManagement API
schemas :
NFProfile :
2021-03-08 12:25:09 +00:00
description : Information of an NF Instance registered in the NRF
2020-05-18 21:00:37 +00:00
type : object
required :
- nfInstanceId
- nfType
- nfStatus
2021-07-07 08:32:55 +00:00
# anyOf:
# - required: [ fqdn ]
# - required: [ ipv4Addresses ]
# - required: [ ipv6Addresses ]
2020-05-18 21:00:37 +00:00
properties :
nfInstanceId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
nfInstanceName :
type : string
nfType :
$ref : '#/components/schemas/NFType'
nfStatus :
$ref : '#/components/schemas/NFStatus'
heartBeatTimer :
type : integer
plmnList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
minItems : 1
2020-06-04 18:12:05 +00:00
snpnList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
minItems : 1
2020-05-18 21:00:37 +00:00
sNssais :
type : array
items :
2021-03-08 12:25:09 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai'
2020-05-18 21:00:37 +00:00
minItems : 1
perPlmnSnssaiList :
type : array
items :
$ref : '#/components/schemas/PlmnSnssai'
minItems : 1
nsiList :
type : array
items :
type : string
minItems : 1
fqdn :
$ref : '#/components/schemas/Fqdn'
interPlmnFqdn :
$ref : '#/components/schemas/Fqdn'
ipv4Addresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
minItems : 1
ipv6Addresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
minItems : 1
allowedPlmns :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
minItems : 1
2020-06-04 18:12:05 +00:00
allowedSnpns :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
minItems : 1
2020-05-18 21:00:37 +00:00
allowedNfTypes :
type : array
items :
$ref : '#/components/schemas/NFType'
minItems : 1
allowedNfDomains :
type : array
items :
type : string
minItems : 1
allowedNssais :
type : array
items :
2021-03-08 12:25:09 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai'
2020-05-18 21:00:37 +00:00
minItems : 1
priority :
type : integer
minimum : 0
maximum : 65535
capacity :
type : integer
minimum : 0
maximum : 65535
load :
type : integer
minimum : 0
maximum : 100
2020-06-04 18:12:05 +00:00
loadTimeStamp :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
2020-05-18 21:00:37 +00:00
locality :
type : string
udrInfo :
$ref : '#/components/schemas/UdrInfo'
2021-03-08 12:25:09 +00:00
udrInfoList :
type : object
additionalProperties :
2020-05-18 21:00:37 +00:00
$ref : '#/components/schemas/UdrInfo'
2021-03-08 12:25:09 +00:00
minProperties : 1
2020-05-18 21:00:37 +00:00
udmInfo :
$ref : '#/components/schemas/UdmInfo'
2021-03-08 12:25:09 +00:00
udmInfoList :
type : object
additionalProperties :
2020-05-18 21:00:37 +00:00
$ref : '#/components/schemas/UdmInfo'
2021-03-08 12:25:09 +00:00
minProperties : 1
2020-05-18 21:00:37 +00:00
ausfInfo :
$ref : '#/components/schemas/AusfInfo'
2021-03-08 12:25:09 +00:00
ausfInfoList :
type : object
additionalProperties :
2020-05-18 21:00:37 +00:00
$ref : '#/components/schemas/AusfInfo'
2021-03-08 12:25:09 +00:00
minProperties : 1
2020-05-18 21:00:37 +00:00
amfInfo :
$ref : '#/components/schemas/AmfInfo'
2021-03-08 12:25:09 +00:00
amfInfoList :
type : object
additionalProperties :
2020-05-18 21:00:37 +00:00
$ref : '#/components/schemas/AmfInfo'
2021-03-08 12:25:09 +00:00
minProperties : 1
2020-05-18 21:00:37 +00:00
smfInfo :
$ref : '#/components/schemas/SmfInfo'
2021-03-08 12:25:09 +00:00
smfInfoList :
type : object
additionalProperties :
2020-05-18 21:00:37 +00:00
$ref : '#/components/schemas/SmfInfo'
2021-03-08 12:25:09 +00:00
minProperties : 1
2020-05-18 21:00:37 +00:00
upfInfo :
$ref : '#/components/schemas/UpfInfo'
2021-03-08 12:25:09 +00:00
upfInfoList :
type : object
additionalProperties :
2020-05-18 21:00:37 +00:00
$ref : '#/components/schemas/UpfInfo'
2021-03-08 12:25:09 +00:00
minProperties : 1
2020-05-18 21:00:37 +00:00
pcfInfo :
$ref : '#/components/schemas/PcfInfo'
2021-03-08 12:25:09 +00:00
pcfInfoList :
type : object
additionalProperties :
2020-05-18 21:00:37 +00:00
$ref : '#/components/schemas/PcfInfo'
2021-03-08 12:25:09 +00:00
minProperties : 1
2020-05-18 21:00:37 +00:00
bsfInfo :
$ref : '#/components/schemas/BsfInfo'
2021-03-08 12:25:09 +00:00
bsfInfoList :
type : object
additionalProperties :
2020-05-18 21:00:37 +00:00
$ref : '#/components/schemas/BsfInfo'
2021-03-08 12:25:09 +00:00
minProperties : 1
2020-05-18 21:00:37 +00:00
chfInfo :
$ref : '#/components/schemas/ChfInfo'
2021-03-08 12:25:09 +00:00
chfInfoList :
type : object
additionalProperties :
2020-05-18 21:00:37 +00:00
$ref : '#/components/schemas/ChfInfo'
2021-03-08 12:25:09 +00:00
minProperties : 1
2020-06-04 18:12:05 +00:00
nefInfo :
$ref : '#/components/schemas/NefInfo'
2020-05-18 21:00:37 +00:00
nrfInfo :
$ref : '#/components/schemas/NrfInfo'
2020-06-04 18:12:05 +00:00
udsfInfo :
$ref : '#/components/schemas/UdsfInfo'
2021-03-08 12:25:09 +00:00
udsfInfoList :
type : object
additionalProperties :
2020-06-04 18:12:05 +00:00
$ref : '#/components/schemas/UdsfInfo'
2021-03-08 12:25:09 +00:00
minProperties : 1
2020-05-18 21:00:37 +00:00
nwdafInfo :
$ref : '#/components/schemas/NwdafInfo'
2021-03-08 12:25:09 +00:00
pcscfInfoList :
type : object
additionalProperties :
2020-06-04 18:12:05 +00:00
$ref : '#/components/schemas/PcscfInfo'
2021-03-08 12:25:09 +00:00
minProperties : 1
hssInfoList :
type : object
additionalProperties :
2020-06-04 18:12:05 +00:00
$ref : '#/components/schemas/HssInfo'
2021-03-08 12:25:09 +00:00
minProperties : 1
2020-05-18 21:00:37 +00:00
customInfo :
type : object
recoveryTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
nfServicePersistence :
type : boolean
default : false
nfServices :
2021-03-08 12:25:09 +00:00
deprecated : true
2020-05-18 21:00:37 +00:00
type : array
items :
$ref : '#/components/schemas/NFService'
minItems : 1
2021-03-08 12:25:09 +00:00
nfServiceList :
type : object
additionalProperties :
$ref : '#/components/schemas/NFService'
minProperties : 1
2020-05-18 21:00:37 +00:00
nfProfileChangesSupportInd :
type : boolean
default : false
writeOnly : true
nfProfileChangesInd :
type : boolean
default : false
readOnly : true
defaultNotificationSubscriptions :
type : array
items :
$ref : '#/components/schemas/DefaultNotificationSubscription'
2020-06-04 18:12:05 +00:00
lmfInfo :
$ref : '#/components/schemas/LmfInfo'
gmlcInfo :
$ref : '#/components/schemas/GmlcInfo'
nfSetIdList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
minItems : 1
servingScope :
type : array
items :
type : string
minItems : 1
lcHSupportInd :
type : boolean
default : false
olcHSupportInd :
type : boolean
default : false
2021-03-08 12:25:09 +00:00
nfSetRecoveryTimeList :
type : object
additionalProperties :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
minProperties : 1
serviceSetRecoveryTimeList :
type : object
additionalProperties :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
minProperties : 1
scpDomains :
type : array
items :
type : string
minItems : 1
scpInfo :
$ref : '#/components/schemas/ScpInfo'
2020-05-18 21:00:37 +00:00
NFService :
2020-06-04 18:12:05 +00:00
description : Information of a given NF Service Instance; it is part of the NFProfile of an NF Instance
2020-05-18 21:00:37 +00:00
type : object
required :
- serviceInstanceId
- serviceName
- versions
- scheme
- nfServiceStatus
properties :
serviceInstanceId :
type : string
serviceName :
$ref : '#/components/schemas/ServiceName'
versions :
type : array
items :
$ref : '#/components/schemas/NFServiceVersion'
minItems : 1
scheme :
$ref : 'TS29571_CommonData.yaml#/components/schemas/UriScheme'
nfServiceStatus :
$ref : '#/components/schemas/NFServiceStatus'
fqdn :
$ref : '#/components/schemas/Fqdn'
interPlmnFqdn :
$ref : '#/components/schemas/Fqdn'
ipEndPoints :
type : array
items :
$ref : '#/components/schemas/IpEndPoint'
minItems : 1
apiPrefix :
type : string
defaultNotificationSubscriptions :
type : array
items :
$ref : '#/components/schemas/DefaultNotificationSubscription'
minItems : 1
allowedPlmns :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
minItems : 1
2020-06-04 18:12:05 +00:00
allowedSnpns :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
minItems : 1
2020-05-18 21:00:37 +00:00
allowedNfTypes :
type : array
items :
$ref : '#/components/schemas/NFType'
minItems : 1
allowedNfDomains :
type : array
items :
type : string
minItems : 1
allowedNssais :
type : array
items :
2021-03-08 12:25:09 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai'
2020-05-18 21:00:37 +00:00
minItems : 1
2021-03-08 12:25:09 +00:00
allowedOperationsPerNfType :
type : object
additionalProperties :
type : array
items :
type : string
minItems : 1
2021-07-07 08:32:55 +00:00
minProperties : 1
2021-03-08 12:25:09 +00:00
allowedOperationsPerNfInstance :
type : object
additionalProperties :
type : array
items :
type : string
minItems : 1
2021-07-07 08:32:55 +00:00
minProperties : 1
2020-05-18 21:00:37 +00:00
priority :
type : integer
minimum : 0
maximum : 65535
capacity :
type : integer
minimum : 0
maximum : 65535
load :
type : integer
minimum : 0
maximum : 100
2020-06-04 18:12:05 +00:00
loadTimeStamp :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
2020-05-18 21:00:37 +00:00
recoveryTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
supportedFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
2020-06-04 18:12:05 +00:00
nfServiceSetIdList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId'
minItems : 1
sNssais :
type : array
items :
2021-03-08 12:25:09 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai'
2020-06-04 18:12:05 +00:00
minItems : 1
perPlmnSnssaiList :
type : array
items :
$ref : '#/components/schemas/PlmnSnssai'
minItems : 1
vendorId :
$ref : '#/components/schemas/VendorId'
supportedVendorSpecificFeatures :
type : object
additionalProperties :
type : array
items :
$ref : '#/components/schemas/VendorSpecificFeature'
2021-07-07 08:32:55 +00:00
minItems : 1
2020-06-04 18:12:05 +00:00
minProperties : 1
oauth2Required :
type : boolean
2020-05-18 21:00:37 +00:00
NFType :
2020-06-04 18:12:05 +00:00
# description: NF types known to NRF
2020-05-18 21:00:37 +00:00
# anyOf:
# - type: string
2021-07-07 08:32:55 +00:00
type : string
2020-05-18 21:00:37 +00:00
enum :
- NRF
- UDM
- AMF
- SMF
- AUSF
- NEF
- PCF
- SMSF
- NSSF
- UDR
- LMF
- GMLC
- 5G_EIR
- SEPP
- UPF
- N3IWF
- AF
- UDSF
- BSF
- CHF
- NWDAF
2020-06-04 18:12:05 +00:00
- PCSCF
- CBCF
- HSS
- UCMF
- SOR_AF
- SPAF
- MME
- SCSAS
- SCEF
- SCP
2021-03-08 12:25:09 +00:00
- NSSAAF
- ICSCF
- SCSCF
2021-07-07 08:32:55 +00:00
- DRA
# - type: string
2020-05-18 21:00:37 +00:00
Fqdn :
2020-06-04 18:12:05 +00:00
description : Fully Qualified Domain Name
type : string
NefId :
description : Identity of the NEF
2020-05-18 21:00:37 +00:00
type : string
IpEndPoint :
2020-06-04 18:12:05 +00:00
description : IP addressing information of a given NFService; it consists on, e.g. IP address, TCP port, transport protocol...
2020-05-18 21:00:37 +00:00
type : object
properties :
ipv4Address :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ipv6Address :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
transport :
$ref : '#/components/schemas/TransportProtocol'
port :
2020-06-04 18:12:05 +00:00
type : integer
2020-05-18 21:00:37 +00:00
minimum : 0
maximum : 65535
SubscriptionData :
2020-06-04 18:12:05 +00:00
description : Information of a subscription to notifications to NRF events, included in subscription requests and responses
2020-05-18 21:00:37 +00:00
type : object
required :
- nfStatusNotificationUri
# - subscriptionId
properties :
nfStatusNotificationUri :
type : string
reqNfInstanceId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
2020-12-24 20:41:31 +00:00
subscrCond :
type : object
properties :
nfInstanceId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
nfType :
$ref : '#/components/schemas/NFType'
serviceName :
$ref : '#/components/schemas/ServiceName'
amfSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AmfSetId'
amfRegionId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId'
guamiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Guami'
snssaiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
nsiList :
type : array
items :
type : string
nfGroupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
nfSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
nfServiceSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId'
smfServingArea :
type : array
items :
type : string
minItems : 1
taiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Tai'
minItems : 1
2020-05-18 21:00:37 +00:00
# oneOf:
# - $ref: '#/components/schemas/NfInstanceIdCond'
2021-03-08 12:25:09 +00:00
# - $ref: '#/components/schemas/NfInstanceIdListCond'
2020-05-18 21:00:37 +00:00
# - $ref: '#/components/schemas/NfTypeCond'
# - $ref: '#/components/schemas/ServiceNameCond'
# - $ref: '#/components/schemas/AmfCond'
# - $ref: '#/components/schemas/GuamiListCond'
# - $ref: '#/components/schemas/NetworkSliceCond'
# - $ref: '#/components/schemas/NfGroupCond'
2020-06-04 18:12:05 +00:00
# - $ref: '#/components/schemas/NfSetCond'
# - $ref: '#/components/schemas/NfServiceSetCond'
# - $ref: '#/components/schemas/UpfCond'
2021-03-08 12:25:09 +00:00
# - $ref: '#/components/schemas/ScpDomainCond'
# - $ref: '#/components/schemas/NwdafCond'
# - $ref: '#/components/schemas/NefCond'
2020-05-18 21:00:37 +00:00
subscriptionId :
type : string
pattern : '^([0-9]{5,6}-)?[^-]+$'
readOnly : true
validityTime :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
reqNotifEvents :
type : array
items :
$ref : '#/components/schemas/NotificationEventType'
minItems : 1
plmnId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
2020-06-04 18:12:05 +00:00
nid :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Nid'
2020-05-18 21:00:37 +00:00
notifCondition :
$ref : '#/components/schemas/NotifCondition'
reqNfType :
$ref : '#/components/schemas/NFType'
reqNfFqdn :
$ref : '#/components/schemas/Fqdn'
reqSnssais :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems : 1
2021-03-08 12:25:09 +00:00
reqPerPlmnSnssais :
type : array
items :
$ref : '#/components/schemas/PlmnSnssai'
minItems : 1
2020-06-04 18:12:05 +00:00
reqPlmnList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
minItems : 1
2021-03-08 12:25:09 +00:00
reqSnpnList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
minItems : 1
servingScope :
type : array
items :
type : string
minItems : 1
2022-08-26 15:12:22 +00:00
requesterFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
2021-03-08 12:25:09 +00:00
# writeOnly: true
# allOf:
# - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
2022-08-26 15:12:22 +00:00
nrfSupportedFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
2021-03-08 12:25:09 +00:00
# readOnly: true
# allOf:
# - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
2020-05-18 21:00:37 +00:00
NfInstanceIdCond :
2020-06-04 18:12:05 +00:00
description : Subscription to a given NF Instance Id
2020-05-18 21:00:37 +00:00
type : object
required :
- nfInstanceId
properties :
nfInstanceId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
2021-03-08 12:25:09 +00:00
NfInstanceIdListCond :
description : Subscription to a list of NF Instances
type : object
required :
- nfInstanceIdList
properties :
nfInstanceIdList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
minItems : 1
2020-05-18 21:00:37 +00:00
NfTypeCond :
2020-06-04 18:12:05 +00:00
description : Subscription to a set of NFs based on their NF Type
2020-05-18 21:00:37 +00:00
type : object
required :
- nfType
not :
required : [ nfGroupId ]
properties :
nfType :
$ref : '#/components/schemas/NFType'
ServiceNameCond :
2020-06-04 18:12:05 +00:00
description : Subscription to a set of NFs based on their support for a given Service Name
2020-05-18 21:00:37 +00:00
type : object
required :
- serviceName
properties :
serviceName :
$ref : '#/components/schemas/ServiceName'
AmfCond :
2020-06-04 18:12:05 +00:00
description : Subscription to a set of AMFs, based on AMF Set Id and/or AMF Region Id
2020-05-18 21:00:37 +00:00
type : object
2021-07-07 08:32:55 +00:00
# anyOf:
# - required: [ amfSetId ]
# - required: [ amfRegionId ]
2020-05-18 21:00:37 +00:00
properties :
amfSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AmfSetId'
amfRegionId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId'
GuamiListCond :
2020-06-04 18:12:05 +00:00
description : Subscription to a set of AMFs, based on their GUAMIs
2020-05-18 21:00:37 +00:00
type : object
required :
- guamiList
properties :
guamiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Guami'
NetworkSliceCond :
2020-06-04 18:12:05 +00:00
description : Subscription to a set of NFs, based on the slices (S-NSSAI and NSI) they support
2020-05-18 21:00:37 +00:00
type : object
required :
- snssaiList
properties :
snssaiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
nsiList :
type : array
items :
type : string
NfGroupCond :
2020-06-04 18:12:05 +00:00
description : Subscription to a set of NFs based on their Group Id
2020-05-18 21:00:37 +00:00
type : object
required :
- nfType
- nfGroupId
properties :
nfType :
type : string
enum :
- UDM
- AUSF
- UDR
- PCF
2020-06-04 18:12:05 +00:00
- CHF
2020-05-18 21:00:37 +00:00
nfGroupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
NotifCondition :
2020-06-04 18:12:05 +00:00
description : Condition (list of attributes in the NF Profile) to determine whether a notification must be sent by NRF
2020-05-18 21:00:37 +00:00
type : object
not :
required : [ monitoredAttributes, unmonitoredAttributes ]
properties :
monitoredAttributes :
type : array
items :
type : string
minItems : 1
unmonitoredAttributes :
type : array
items :
type : string
minItems : 1
UdrInfo :
2020-06-04 18:12:05 +00:00
description : Information of an UDR NF Instance
2020-05-18 21:00:37 +00:00
type : object
properties :
groupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
supiRanges :
type : array
items :
$ref : '#/components/schemas/SupiRange'
minItems : 1
gpsiRanges :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
externalGroupIdentifiersRanges :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
supportedDataSets :
type : array
items :
$ref : '#/components/schemas/DataSetId'
minItems : 1
SupiRange :
2021-03-08 12:25:09 +00:00
description : A range of SUPIs (subscriber identities), either based on a numeric range, or based on regular-expression matching
2020-05-18 21:00:37 +00:00
type : object
properties :
start :
type : string
pattern : '^[0-9]+$'
end :
type : string
pattern : '^[0-9]+$'
pattern :
type : string
IdentityRange :
2020-06-04 18:12:05 +00:00
description : A range of GPSIs (subscriber identities), either based on a numeric range, or based on regular-expression matching
2020-05-18 21:00:37 +00:00
type : object
properties :
start :
type : string
pattern : '^[0-9]+$'
end :
type : string
pattern : '^[0-9]+$'
pattern :
type : string
2020-06-04 18:12:05 +00:00
InternalGroupIdRange :
description : A range of Group IDs (internal group identities), either based on a numeric range, or based on regular-expression matching
type : object
properties :
start :
$ref : 'TS29571_CommonData.yaml#/components/schemas/GroupId'
end :
$ref : 'TS29571_CommonData.yaml#/components/schemas/GroupId'
pattern :
type : string
2020-05-18 21:00:37 +00:00
DataSetId :
2021-07-07 08:32:55 +00:00
# description: Types of data sets stored in UDR
# anyOf:
# - type: string
type : string
2020-05-18 21:00:37 +00:00
enum :
- SUBSCRIPTION
- POLICY
- EXPOSURE
- APPLICATION
2021-07-07 08:32:55 +00:00
# - type: string
2020-05-18 21:00:37 +00:00
UdmInfo :
2020-06-04 18:12:05 +00:00
description : Information of an UDM NF Instance
2020-05-18 21:00:37 +00:00
type : object
properties :
groupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
supiRanges :
type : array
items :
$ref : '#/components/schemas/SupiRange'
minItems : 1
gpsiRanges :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
externalGroupIdentifiersRanges :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
routingIndicators :
type : array
items :
type : string
pattern : '^[0-9]{1,4}$'
minItems : 1
2020-06-04 18:12:05 +00:00
internalGroupIdentifiersRanges :
type : array
items :
$ref : '#/components/schemas/InternalGroupIdRange'
minItems : 1
2020-05-18 21:00:37 +00:00
AusfInfo :
2020-06-04 18:12:05 +00:00
description : Information of an AUSF NF Instance
2020-05-18 21:00:37 +00:00
type : object
properties :
groupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
supiRanges :
type : array
items :
$ref : '#/components/schemas/SupiRange'
minItems : 1
routingIndicators :
type : array
items :
type : string
pattern : '^[0-9]{1,4}$'
minItems : 1
AmfInfo :
2020-06-04 18:12:05 +00:00
description : Information of an AMF NF Instance
2020-05-18 21:00:37 +00:00
type : object
required :
- amfSetId
- amfRegionId
- guamiList
properties :
amfSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AmfSetId'
amfRegionId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId'
guamiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Guami'
minItems : 1
taiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Tai'
minItems : 1
taiRangeList :
type : array
items :
$ref : '#/components/schemas/TaiRange'
minItems : 1
backupInfoAmfFailure :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Guami'
minItems : 1
backupInfoAmfRemoval :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Guami'
minItems : 1
n2InterfaceAmfInfo :
$ref : '#/components/schemas/N2InterfaceAmfInfo'
SmfInfo :
2020-06-04 18:12:05 +00:00
description : Information of an SMF NF Instance
2020-05-18 21:00:37 +00:00
type : object
required :
- sNssaiSmfInfoList
properties :
sNssaiSmfInfoList :
type : array
items :
$ref : '#/components/schemas/SnssaiSmfInfoItem'
minItems : 1
taiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Tai'
minItems : 1
taiRangeList :
type : array
items :
$ref : '#/components/schemas/TaiRange'
minItems : 1
pgwFqdn :
$ref : '#/components/schemas/Fqdn'
accessType :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
minItems : 1
2020-06-04 18:12:05 +00:00
priority :
type : integer
minimum : 0
maximum : 65535
2021-03-08 12:25:09 +00:00
vsmfSupportInd :
type : boolean
default : false
2020-05-18 21:00:37 +00:00
SnssaiSmfInfoItem :
2020-06-04 18:12:05 +00:00
description : Set of parameters supported by SMF for a given S-NSSAI
2020-05-18 21:00:37 +00:00
type : object
required :
- sNssai
- dnnSmfInfoList
properties :
sNssai :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
dnnSmfInfoList :
type : array
items :
$ref : '#/components/schemas/DnnSmfInfoItem'
minItems : 1
DnnSmfInfoItem :
2020-06-04 18:12:05 +00:00
description : Set of parameters supported by SMF for a given DNN
2020-05-18 21:00:37 +00:00
type : object
required :
- dnn
properties :
dnn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnn'
UpfInfo :
2020-06-04 18:12:05 +00:00
description : Information of an UPF NF Instance
2020-05-18 21:00:37 +00:00
type : object
required :
- sNssaiUpfInfoList
properties :
sNssaiUpfInfoList :
type : array
items :
$ref : '#/components/schemas/SnssaiUpfInfoItem'
minItems : 1
smfServingArea :
type : array
items :
type : string
minItems : 1
interfaceUpfInfoList :
type : array
items :
$ref : '#/components/schemas/InterfaceUpfInfoItem'
minItems : 1
iwkEpsInd :
type : boolean
default : false
pduSessionTypes :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PduSessionType'
minItems : 1
atsssCapability :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability'
ueIpAddrInd :
type : boolean
default : false
2020-06-04 18:12:05 +00:00
taiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Tai'
minItems : 1
wAgfInfo :
$ref : '#/components/schemas/WAgfInfo'
tngfInfo :
$ref : '#/components/schemas/TngfInfo'
twifInfo :
$ref : '#/components/schemas/TwifInfo'
priority :
type : integer
minimum : 0
maximum : 65535
redundantGtpu :
type : boolean
default : false
2021-03-08 12:25:09 +00:00
ipups :
type : boolean
default : false
dataForwarding :
type : boolean
default : false
2020-05-18 21:00:37 +00:00
SnssaiUpfInfoItem :
2020-06-04 18:12:05 +00:00
description : Set of parameters supported by UPF for a given S-NSSAI
2020-05-18 21:00:37 +00:00
type : object
required :
- sNssai
- dnnUpfInfoList
properties :
sNssai :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
dnnUpfInfoList :
type : array
items :
$ref : '#/components/schemas/DnnUpfInfoItem'
minItems : 1
2020-06-04 18:12:05 +00:00
redundantTransport :
type : boolean
default : false
2020-05-18 21:00:37 +00:00
DnnUpfInfoItem :
2020-06-04 18:12:05 +00:00
description : Set of parameters supported by UPF for a given DNN
2020-05-18 21:00:37 +00:00
type : object
required :
- dnn
properties :
dnn :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnn'
dnaiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems : 1
pduSessionTypes :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PduSessionType'
minItems : 1
2020-06-04 18:12:05 +00:00
ipv4AddressRanges :
type : array
items :
$ref : '#/components/schemas/Ipv4AddressRange'
minItems : 1
ipv6PrefixRanges :
type : array
items :
$ref : '#/components/schemas/Ipv6PrefixRange'
minItems : 1
2021-07-07 08:32:55 +00:00
dnaiNwInstanceList :
description : Map of network instance per DNAI for the DNN, where the key of the map is the DNAI. When present, the value of each entry of the map shall contain a N6 network instance that is configured for the DNAI indicated by the key.
type : object
additionalProperties :
type : string
minProperties : 1
2020-05-18 21:00:37 +00:00
InterfaceUpfInfoItem :
2020-06-04 18:12:05 +00:00
description : Information of a given IP interface of an UPF
2020-05-18 21:00:37 +00:00
type : object
required :
- interfaceType
properties :
interfaceType :
$ref : '#/components/schemas/UPInterfaceType'
ipv4EndpointAddresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
minItems : 1
ipv6EndpointAddresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
minItems : 1
endpointFqdn :
$ref : '#/components/schemas/Fqdn'
networkInstance :
type : string
UPInterfaceType :
2021-07-07 08:32:55 +00:00
# description: Types of User-Plane interfaces of the UPF
# anyOf:
# - type: string
type : string
2020-05-18 21:00:37 +00:00
enum :
- N3
- N6
- N9
2021-03-08 12:25:09 +00:00
- DATA_FORWARDING
2021-07-07 08:32:55 +00:00
# - type: string
2020-06-04 18:12:05 +00:00
WAgfInfo :
description : Information of the W-AGF end-points
type : object
properties :
ipv4EndpointAddresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
minItems : 1
ipv6EndpointAddresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
minItems : 1
endpointFqdn :
$ref : '#/components/schemas/Fqdn'
TngfInfo :
description : Infomation of the TNGF endpoints
type : object
properties :
ipv4EndpointAddresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
minItems : 1
ipv6EndpointAddresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
minItems : 1
endpointFqdn :
$ref : '#/components/schemas/Fqdn'
2020-05-18 21:00:37 +00:00
PcfInfo :
2020-06-04 18:12:05 +00:00
description : Information of a PCF NF Instance
2020-05-18 21:00:37 +00:00
type : object
properties :
groupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
dnnList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnn'
minItems : 1
supiRanges :
type : array
items :
$ref : '#/components/schemas/SupiRange'
minItems : 1
gpsiRanges :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
rxDiamHost :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity'
rxDiamRealm :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity'
2020-06-04 18:12:05 +00:00
v2xSupportInd :
type : boolean
default : false
2020-05-18 21:00:37 +00:00
BsfInfo :
2020-06-04 18:12:05 +00:00
description : Information of a BSF NF Instance
2020-05-18 21:00:37 +00:00
type : object
properties :
dnnList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnn'
minItems : 1
ipDomainList :
type : array
items :
type : string
minItems : 1
ipv4AddressRanges :
type : array
2020-06-04 18:12:05 +00:00
items :
2020-05-18 21:00:37 +00:00
$ref : '#/components/schemas/Ipv4AddressRange'
minItems : 1
ipv6PrefixRanges :
type : array
2020-06-04 18:12:05 +00:00
items :
2020-05-18 21:00:37 +00:00
$ref : '#/components/schemas/Ipv6PrefixRange'
minItems : 1
ChfInfo :
2020-06-04 18:12:05 +00:00
description : Information of a CHF NF Instance
2020-05-18 21:00:37 +00:00
type : object
2021-07-07 08:32:55 +00:00
not :
required : [ primaryChfInstance, secondaryChfInstance ]
2020-05-18 21:00:37 +00:00
properties :
supiRangeList :
type : array
items :
$ref : '#/components/schemas/SupiRange'
minItems : 1
gpsiRangeList :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
plmnRangeList :
type : array
items :
$ref : '#/components/schemas/PlmnRange'
minItems : 1
2020-06-04 18:12:05 +00:00
groupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
2021-07-07 08:32:55 +00:00
primaryChfInstance :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
secondaryChfInstance :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
2020-05-18 21:00:37 +00:00
Ipv4AddressRange :
2020-06-04 18:12:05 +00:00
description : Range of IPv4 addresses
2020-05-18 21:00:37 +00:00
type : object
properties :
start :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
end :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
Ipv6PrefixRange :
2020-06-04 18:12:05 +00:00
description : Range of IPv6 prefixes
2020-05-18 21:00:37 +00:00
type : object
properties :
start :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
end :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
DefaultNotificationSubscription :
2020-06-04 18:12:05 +00:00
description : Data structure for specifying the notifications the NF service subscribes by default along with callback URI
2020-05-18 21:00:37 +00:00
type : object
required :
- notificationType
- callbackUri
properties :
notificationType :
$ref : '#/components/schemas/NotificationType'
callbackUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
n1MessageClass :
$ref : 'TS29518_Namf_Communication.yaml#/components/schemas/N1MessageClass'
n2InformationClass :
$ref : 'TS29518_Namf_Communication.yaml#/components/schemas/N2InformationClass'
2020-06-04 18:12:05 +00:00
versions :
type : array
items :
type : string
minItems : 1
2021-03-08 12:25:09 +00:00
binding :
type : string
2020-06-04 18:12:05 +00:00
NfSetCond :
description : Subscription to a set of NFs based on their Set Id
type : object
required :
- nfSetId
properties :
nfSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
NfServiceSetCond :
description : Subscription to a set of NFs based on their Service Set Id
type : object
required :
- nfServiceSetId
properties :
nfServiceSetId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId'
UpfCond :
2021-03-08 12:25:09 +00:00
description : Subscription to a set of NF Instances (UPFs), able to serve a certain service area (i.e. SMF serving area or TAI list)
2020-06-04 18:12:05 +00:00
type : object
2021-07-07 08:32:55 +00:00
required :
- conditionType
2020-06-04 18:12:05 +00:00
properties :
2021-07-07 08:32:55 +00:00
conditionType :
type : string
enum : [ UPF_COND ]
2020-06-04 18:12:05 +00:00
smfServingArea :
type : array
items :
type : string
minItems : 1
taiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Tai'
minItems : 1
2021-03-08 12:25:09 +00:00
NwdafCond :
2021-07-07 08:32:55 +00:00
description : Subscription to a set of NF Instances (NWDAFs), identified by Analytics ID(s), S-NSSAI(s) or NWDAF Serving Area information, i.e. list of TAIs for which the NWDAF can provide analytics.
2021-03-08 12:25:09 +00:00
type : object
2021-07-07 08:32:55 +00:00
required :
- conditionType
2021-03-08 12:25:09 +00:00
properties :
2021-07-07 08:32:55 +00:00
conditionType :
type : string
enum : [ NWDAF_COND ]
2021-03-08 12:25:09 +00:00
analyticsIds :
type : array
items :
type : string
minItems : 1
2021-07-07 08:32:55 +00:00
snssaiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems : 1
taiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Tai'
minItems : 1
taiRangeList :
type : array
items :
$ref : '#/components/schemas/TaiRange'
minItems : 1
2021-03-08 12:25:09 +00:00
NefCond :
2021-07-07 08:32:55 +00:00
description : Subscription to a set of NF Instances (NEFs), identified by Event ID(s) provided by AF, S-NSSAI(s), AF Instance ID, Application Identifier, External Identifier, External Group Identifier, or domain name.
2021-03-08 12:25:09 +00:00
type : object
2021-07-07 08:32:55 +00:00
required :
- conditionType
2021-03-08 12:25:09 +00:00
properties :
2021-07-07 08:32:55 +00:00
conditionType :
type : string
enum : [ NEF_COND ]
afEvents :
2021-03-08 12:25:09 +00:00
type : array
items :
2021-07-07 08:32:55 +00:00
$ref : 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent'
minItems : 1
snssaiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems : 1
pfdData :
$ref : '#/components/schemas/PfdData'
gpsiRanges :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
externalGroupIdentifiersRanges :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
servedFqdnList :
type : array
items :
type : string
2021-03-08 12:25:09 +00:00
minItems : 1
2020-05-18 21:00:37 +00:00
NotificationType :
2020-06-04 18:12:05 +00:00
# description: Types of notifications used in Default Notification URIs in the NF Profile of an NF Instance
2020-05-18 21:00:37 +00:00
# anyOf:
# - type: string
2021-07-07 08:32:55 +00:00
type : string
2020-05-18 21:00:37 +00:00
enum :
- N1_MESSAGES
- N2_INFORMATION
- LOCATION_NOTIFICATION
- DATA_REMOVAL_NOTIFICATION
- DATA_CHANGE_NOTIFICATION
2020-06-04 18:12:05 +00:00
- LOCATION_UPDATE_NOTIFICATION
2021-03-08 12:25:09 +00:00
- NSSAA_REAUTH_NOTIFICATION
- NSSAA_REVOC_NOTIFICATION
2021-07-07 08:32:55 +00:00
# - type: string
2020-05-18 21:00:37 +00:00
TransportProtocol :
2021-03-08 12:25:09 +00:00
# description: Types of transport protocol used in a given IP endpoint of an NF Service Instance
# anyOf:
# - type: string
2021-07-07 08:32:55 +00:00
type : string
2020-05-18 21:00:37 +00:00
enum :
- TCP
2021-07-07 08:32:55 +00:00
# - type: string
2020-05-18 21:00:37 +00:00
NotificationEventType :
2020-06-04 18:12:05 +00:00
# description: Types of events sent in notifications from NRF to subscribed NF Instances
2020-05-18 21:00:37 +00:00
# anyOf:
# - type: string
2021-07-07 08:32:55 +00:00
type : string
2020-05-18 21:00:37 +00:00
enum :
- NF_REGISTERED
- NF_DEREGISTERED
- NF_PROFILE_CHANGED
2021-07-07 08:32:55 +00:00
# - type: string
2020-05-18 21:00:37 +00:00
NotificationData :
2020-06-04 18:12:05 +00:00
description : Data sent in notifications from NRF to subscribed NF Instances
2020-05-18 21:00:37 +00:00
type : object
required :
- event
- nfInstanceUri
allOf :
#
# Condition: If 'event' takes value 'NF_PROFILE_CHANGED',
# then either 'nfProfile' or 'profileChanges' (but not both) must be present
#
- anyOf :
- not :
properties :
event :
type : string
enum :
2020-06-04 18:12:05 +00:00
- NF_PROFILE_CHANGED
2020-05-18 21:00:37 +00:00
- oneOf :
- required : [ nfProfile ]
- required : [ profileChanges ]
#
# Condition: If 'event' takes value 'NF_REGISTERED',
# then 'nfProfile' must be present
#
- anyOf :
- not :
properties :
event :
type : string
enum :
2020-06-04 18:12:05 +00:00
- NF_REGISTERED
2020-05-18 21:00:37 +00:00
- required : [ nfProfile ]
properties :
event :
$ref : '#/components/schemas/NotificationEventType'
nfInstanceUri :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Uri'
nfProfile :
allOf :
- $ref : '#/components/schemas/NFProfile'
- not :
2020-06-04 18:12:05 +00:00
required : [ interPlmnFqdn ]
2020-05-18 21:00:37 +00:00
- not :
2020-06-04 18:12:05 +00:00
required : [ allowedPlmns ]
2021-03-08 12:25:09 +00:00
- not :
required : [ allowedSnpns ]
2020-05-18 21:00:37 +00:00
- not :
2020-06-04 18:12:05 +00:00
required : [ allowedNfTypes ]
2020-05-18 21:00:37 +00:00
- not :
2020-06-04 18:12:05 +00:00
required : [ allowedNfDomains ]
2020-05-18 21:00:37 +00:00
- not :
2020-06-04 18:12:05 +00:00
required : [ allowedNssais ]
2020-05-18 21:00:37 +00:00
- properties :
nfServices :
type : array
items :
allOf :
- $ref : '#/components/schemas/NFService'
- not :
required : [ interPlmnFqdn ]
- not :
required : [ allowedPlmns ]
2021-03-08 12:25:09 +00:00
- not :
required : [ allowedSnpns ]
2020-05-18 21:00:37 +00:00
- not :
required : [ allowedNfTypes ]
- not :
required : [ allowedNfDomains ]
- not :
required : [ allowedNssais ]
profileChanges :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/ChangeItem'
minItems : 1
2021-03-08 12:25:09 +00:00
conditionEvent :
$ref : '#/components/schemas/ConditionEventType'
2020-05-18 21:00:37 +00:00
NFStatus :
2020-06-04 18:12:05 +00:00
# description: Status of a given NF Instance stored in NRF
2020-05-18 21:00:37 +00:00
# anyOf:
# - type: string
2021-07-07 08:32:55 +00:00
type : string
2020-05-18 21:00:37 +00:00
enum :
- REGISTERED
- SUSPENDED
- UNDISCOVERABLE
2021-07-07 08:32:55 +00:00
# - type: string
2020-05-18 21:00:37 +00:00
NFServiceVersion :
2020-06-04 18:12:05 +00:00
description : Contains the version details of an NF service
2020-05-18 21:00:37 +00:00
type : object
required :
- apiVersionInUri
- apiFullVersion
properties :
apiVersionInUri :
type : string
apiFullVersion :
type : string
expiry :
$ref : 'TS29571_CommonData.yaml#/components/schemas/DateTime'
ServiceName :
2020-06-04 18:12:05 +00:00
# description: Service names known to NRF
2020-05-18 21:00:37 +00:00
# anyOf:
# - type: string
# enum:
# - nnrf-nfm
# - nnrf-disc
2020-06-04 18:12:05 +00:00
# - nnrf-oauth2
2020-05-18 21:00:37 +00:00
# - nudm-sdm
# - nudm-uecm
# - nudm-ueau
# - nudm-ee
# - nudm-pp
# - nudm-niddau
2020-06-04 18:12:05 +00:00
# - nudm-mt
2020-05-18 21:00:37 +00:00
# - namf-comm
# - namf-evts
# - namf-mt
# - namf-loc
# - nsmf-pdusession
# - nsmf-event-exposure
2021-03-08 12:25:09 +00:00
# - nsmf-nidd
2020-05-18 21:00:37 +00:00
# - nausf-auth
# - nausf-sorprotection
# - nausf-upuprotection
# - nnef-pfdmanagement
2020-06-04 18:12:05 +00:00
# - nnef-smcontext
# - nnef-eventexposure
2020-05-18 21:00:37 +00:00
# - npcf-am-policy-control
# - npcf-smpolicycontrol
# - npcf-policyauthorization
# - npcf-bdtpolicycontrol
# - npcf-eventexposure
# - npcf-ue-policy-control
# - nsmsf-sms
# - nnssf-nsselection
# - nnssf-nssaiavailability
# - nudr-dr
2020-06-04 18:12:05 +00:00
# - nudr-group-id-map
2020-05-18 21:00:37 +00:00
# - nlmf-loc
# - n5g-eir-eic
# - nbsf-management
# - nchf-spendinglimitcontrol
# - nchf-convergedcharging
2020-06-04 18:12:05 +00:00
# - nchf-offlineonlycharging
2020-05-18 21:00:37 +00:00
# - nnwdaf-eventssubscription
# - nnwdaf-analyticsinfo
2020-06-04 18:12:05 +00:00
# - ngmlc-loc
# - nucmf-provisioning
# - nucmf-uecapabilitymanagement
# - nhss-sdm
# - nhss-uecm
# - nhss-ueau
2021-03-08 12:25:09 +00:00
# - nhss-ee
2020-06-04 18:12:05 +00:00
# - nhss-ims-sdm
# - nhss-ims-uecm
# - nhss-ims-ueau
# - nsepp-telescopic
# - nsoraf-sor
# - nspaf-secured-packet
2021-03-08 12:25:09 +00:00
# - nudsf-dr
# - nnssaaf-nssaa
2021-07-07 08:32:55 +00:00
# - type: string
2020-05-18 21:00:37 +00:00
type : string
N2InterfaceAmfInfo :
2020-06-04 18:12:05 +00:00
description : AMF N2 interface information
2020-05-18 21:00:37 +00:00
type : object
properties :
ipv4EndpointAddress :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
minItems : 1
ipv6EndpointAddress :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
minItems : 1
amfName :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AmfName'
NFServiceStatus :
2020-06-04 18:12:05 +00:00
# description: Status of a given NF Service Instance of an NF Instance stored in NRF
2020-05-18 21:00:37 +00:00
# anyOf:
# - type: string
2021-07-07 08:32:55 +00:00
type : string
2020-05-18 21:00:37 +00:00
enum :
- REGISTERED
- SUSPENDED
- UNDISCOVERABLE
2021-07-07 08:32:55 +00:00
# - type: string
2020-05-18 21:00:37 +00:00
TaiRange :
2020-06-04 18:12:05 +00:00
description : Range of TAIs (Tracking Area Identities)
2020-05-18 21:00:37 +00:00
type : object
required :
- plmnId
- tacRangeList
properties :
plmnId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
tacRangeList :
type : array
items :
$ref : '#/components/schemas/TacRange'
minItems : 1
2020-06-04 18:12:05 +00:00
nid :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Nid'
2020-05-18 21:00:37 +00:00
TacRange :
2020-06-04 18:12:05 +00:00
description : Range of TACs (Tracking Area Codes)
2020-05-18 21:00:37 +00:00
type : object
properties :
start :
type : string
pattern : '^([A-Fa-f0-9]{4}|[A-Fa-f0-9]{6})$'
end :
type : string
pattern : '^([A-Fa-f0-9]{4}|[A-Fa-f0-9]{6})$'
pattern :
type : string
PlmnRange :
2020-06-04 18:12:05 +00:00
description : Range of PLMN IDs
2020-05-18 21:00:37 +00:00
type : object
properties :
start :
type : string
pattern : '^[0-9]{3}[0-9]{2,3}$'
end :
type : string
pattern : '^[0-9]{3}[0-9]{2,3}$'
pattern :
type : string
NrfInfo :
2020-06-04 18:12:05 +00:00
description : Information of an NRF NF Instance, used in hierarchical NRF deployments
2020-05-18 21:00:37 +00:00
type : object
properties :
servedUdrInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/UdrInfo'
minProperties : 1
2021-03-08 12:25:09 +00:00
servedUdrInfoList :
type : object
additionalProperties :
type : object
additionalProperties :
$ref : '#/components/schemas/UdrInfo'
minProperties : 1
minProperties : 1
2020-05-18 21:00:37 +00:00
servedUdmInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/UdmInfo'
minProperties : 1
2021-03-08 12:25:09 +00:00
servedUdmInfoList :
type : object
additionalProperties :
type : object
additionalProperties :
$ref : '#/components/schemas/UdmInfo'
minProperties : 1
minProperties : 1
2020-05-18 21:00:37 +00:00
servedAusfInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/AusfInfo'
minProperties : 1
2021-03-08 12:25:09 +00:00
servedAusfInfoList :
type : object
additionalProperties :
type : object
additionalProperties :
$ref : '#/components/schemas/AusfInfo'
minProperties : 1
minProperties : 1
2020-05-18 21:00:37 +00:00
servedAmfInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/AmfInfo'
minProperties : 1
2021-03-08 12:25:09 +00:00
servedAmfInfoList :
type : object
additionalProperties :
type : object
additionalProperties :
$ref : '#/components/schemas/AmfInfo'
minProperties : 1
minProperties : 1
2020-05-18 21:00:37 +00:00
servedSmfInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/SmfInfo'
minProperties : 1
2021-03-08 12:25:09 +00:00
servedSmfInfoList :
type : object
additionalProperties :
type : object
additionalProperties :
$ref : '#/components/schemas/SmfInfo'
minProperties : 1
minProperties : 1
2020-05-18 21:00:37 +00:00
servedUpfInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/UpfInfo'
minProperties : 1
2021-03-08 12:25:09 +00:00
servedUpfInfoList :
type : object
additionalProperties :
type : object
additionalProperties :
$ref : '#/components/schemas/UpfInfo'
minProperties : 1
minProperties : 1
2020-05-18 21:00:37 +00:00
servedPcfInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/PcfInfo'
minProperties : 1
2021-03-08 12:25:09 +00:00
servedPcfInfoList :
type : object
additionalProperties :
type : object
additionalProperties :
$ref : '#/components/schemas/PcfInfo'
minProperties : 1
minProperties : 1
2020-05-18 21:00:37 +00:00
servedBsfInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/BsfInfo'
minProperties : 1
2021-03-08 12:25:09 +00:00
servedBsfInfoList :
type : object
additionalProperties :
type : object
additionalProperties :
$ref : '#/components/schemas/BsfInfo'
minProperties : 1
minProperties : 1
2020-05-18 21:00:37 +00:00
servedChfInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/ChfInfo'
minProperties : 1
2021-03-08 12:25:09 +00:00
servedChfInfoList :
type : object
additionalProperties :
type : object
additionalProperties :
$ref : '#/components/schemas/ChfInfo'
minProperties : 1
minProperties : 1
2020-06-04 18:12:05 +00:00
servedNefInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/NefInfo'
minProperties : 1
2020-05-18 21:00:37 +00:00
servedNwdafInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/NwdafInfo'
minProperties : 1
2021-03-08 12:25:09 +00:00
servedPcscfInfoList :
2020-06-04 18:12:05 +00:00
type : object
additionalProperties :
2021-03-08 12:25:09 +00:00
type : object
additionalProperties :
$ref : '#/components/schemas/PcscfInfo'
minProperties : 1
2020-06-04 18:12:05 +00:00
minProperties : 1
servedGmlcInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/GmlcInfo'
minProperties : 1
servedLmfInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/LmfInfo'
minProperties : 1
servedNfInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/NfInfo'
minProperties : 1
2021-03-08 12:25:09 +00:00
servedHssInfoList :
2020-06-04 18:12:05 +00:00
type : object
additionalProperties :
2021-03-08 12:25:09 +00:00
type : object
additionalProperties :
$ref : '#/components/schemas/HssInfo'
minProperties : 1
minProperties : 1
servedUdsfInfo :
type : object
additionalProperties :
$ref : '#/components/schemas/UdsfInfo'
minProperties : 1
servedUdsfInfoList :
type : object
additionalProperties :
type : object
additionalProperties :
$ref : '#/components/schemas/UdsfInfo'
minProperties : 1
minProperties : 1
servedScpInfoList :
type : object
additionalProperties :
$ref : '#/components/schemas/ScpInfo'
2020-06-04 18:12:05 +00:00
minProperties : 1
2020-05-18 21:00:37 +00:00
PlmnSnssai :
2020-06-04 18:12:05 +00:00
description : List of network slices (S-NSSAIs) for a given PLMN ID
2020-05-18 21:00:37 +00:00
type : object
required :
- plmnId
- sNssaiList
properties :
plmnId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
sNssaiList :
type : array
items :
2021-03-08 12:25:09 +00:00
$ref : 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai'
2020-05-18 21:00:37 +00:00
minItems : 1
2020-06-04 18:12:05 +00:00
nid :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Nid'
NefInfo :
description : Information of an NEF NF Instance
type : object
properties :
nefId :
$ref : '#/components/schemas/NefId'
pfdData :
$ref : '#/components/schemas/PfdData'
afEeData :
$ref : '#/components/schemas/AfEventExposureData'
2021-03-08 12:25:09 +00:00
gpsiRanges :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
externalGroupIdentifiersRanges :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
servedFqdnList :
type : array
items :
type : string
minItems : 1
2020-06-04 18:12:05 +00:00
PfdData :
description : List of Application IDs and/or AF IDs managed by a given NEF Instance
type : object
properties :
appIds :
type : array
items :
type : string
minItems : 1
afIds :
type : array
items :
type : string
minItems : 1
2020-05-18 21:00:37 +00:00
NwdafInfo :
2020-06-04 18:12:05 +00:00
description : Information of a NWDAF NF Instance
2020-05-18 21:00:37 +00:00
type : object
properties :
eventIds :
type : array
items :
$ref : 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventId'
minItems : 1
nwdafEvents :
type : array
items :
$ref : 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent'
minItems : 1
taiList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Tai'
minItems : 1
taiRangeList :
type : array
items :
$ref : '#/components/schemas/TaiRange'
minItems : 1
2020-06-04 18:12:05 +00:00
LmfInfo :
2021-03-08 12:25:09 +00:00
description : Information of an LMF NF Instance
2020-06-04 18:12:05 +00:00
type : object
properties :
servingClientTypes :
type : array
items :
$ref : 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType'
minItems : 1
lmfId :
$ref : 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification'
servingAccessTypes :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
minItems : 1
servingAnNodeTypes :
type : array
items :
$ref : '#/components/schemas/AnNodeType'
minItems : 1
servingRatTypes :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/RatType'
minItems : 1
GmlcInfo :
2021-03-08 12:25:09 +00:00
description : Information of a GMLC NF Instance
2020-06-04 18:12:05 +00:00
type : object
properties :
servingClientTypes :
type : array
items :
$ref : 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType'
minItems : 1
AfEventExposureData :
description : AF Event Exposure data managed by a given NEF Instance
type : object
required :
- afEvents
properties :
afEvents :
type : array
items :
$ref : 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent'
minItems : 1
afIds :
type : array
items :
type : string
minItems : 1
appIds :
type : array
items :
type : string
minItems : 1
PcscfInfo :
description : Information of a P-CSCF NF Instance
type : object
properties :
accessType :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/AccessType'
minItems : 1
dnnList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Dnn'
minItems : 1
2021-03-08 12:25:09 +00:00
gmFqdn :
$ref : '#/components/schemas/Fqdn'
gmIpv4Addresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
minItems : 1
gmIpv6Addresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
minItems : 1
2021-07-07 08:32:55 +00:00
servedIpv4AddressRanges :
type : array
items :
$ref : '#/components/schemas/Ipv4AddressRange'
minItems : 1
servedIpv6PrefixRanges :
type : array
items :
$ref : '#/components/schemas/Ipv6PrefixRange'
minItems : 1
2020-06-04 18:12:05 +00:00
NfInfo :
description : Information of a generic NF Instance
type : object
properties :
nfType :
$ref : '#/components/schemas/NFType'
HssInfo :
description : Information of an HSS NF Instance
type : object
properties :
groupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
2021-03-08 12:25:09 +00:00
imsiRanges :
2020-06-04 18:12:05 +00:00
type : array
items :
$ref : '#/components/schemas/ImsiRange'
minItems : 1
2021-03-08 12:25:09 +00:00
imsPrivateIdentityRanges :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
imsPublicIdentityRanges :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
msisdnRanges :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
2020-06-04 18:12:05 +00:00
ImsiRange :
description : A range of IMSIs (subscriber identities), either based on a numeric range, or based on regular-expression matching
type : object
properties :
start :
type : string
pattern : '^[0-9]+$'
end :
type : string
pattern : '^[0-9]+$'
pattern :
type : string
TwifInfo :
2021-03-08 12:25:09 +00:00
description : Addressing information (IP addresses, FQDN) of the TWIF
2020-06-04 18:12:05 +00:00
type : object
properties :
ipv4EndpointAddresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
minItems : 1
ipv6EndpointAddresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
minItems : 1
endpointFqdn :
$ref : '#/components/schemas/Fqdn'
VendorId :
description : Vendor ID of the NF Service instance (Private Enterprise Number assigned by IANA)
type : string
pattern : '^[0-9]{6}$'
VendorSpecificFeature :
description : Information about a vendor-specific feature
type : object
required :
- featureName
- featureVersion
properties :
featureName :
type : string
featureVersion :
type : string
AnNodeType :
2021-03-08 12:25:09 +00:00
# description: Access Network Node Type (gNB, ng-eNB...)
# anyOf:
# - type: string
2021-07-07 08:32:55 +00:00
type : string
2020-06-04 18:12:05 +00:00
enum :
- GNB
- NG_ENB
2021-07-07 08:32:55 +00:00
# - type: string
2020-06-04 18:12:05 +00:00
UdsfInfo :
2021-03-08 12:25:09 +00:00
description : Information related to UDSF
2020-06-04 18:12:05 +00:00
type : object
properties :
groupId :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
supiRanges :
type : array
items :
$ref : '#/components/schemas/SupiRange'
minItems : 1
2021-03-08 12:25:09 +00:00
storageIdRanges :
description : A map (list of key-value pairs) where realmId serves as key and each value in the map is an array of IdentityRanges. Each IdentityRange is a range of storageIds.
type : object
additionalProperties :
type : array
items :
$ref : '#/components/schemas/IdentityRange'
minItems : 1
minProperties : 1
ScpInfo :
description : Information of an SCP Instance
type : object
properties :
scpDomainInfoList :
type : object
additionalProperties :
items :
$ref : '#/components/schemas/ScpDomainInfo'
minProperties : 1
scpPrefix :
type : string
scpPorts :
type : object
additionalProperties :
type : integer
minimum : 0
maximum : 65535
minProperties : 1
addressDomains :
type : array
items :
type : string
minItems : 1
ipv4Addresses :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
minItems : 1
ipv6Prefixes :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
minItems : 1
ipv4AddrRanges :
type : array
items :
$ref : '#/components/schemas/Ipv4AddressRange'
minItems : 1
ipv6PrefixRanges :
type : array
items :
$ref : '#/components/schemas/Ipv6PrefixRange'
minItems : 1
servedNfSetIdList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
minItems : 1
remotePlmnList :
type : array
items :
$ref : 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
minItems : 1
2021-07-07 08:32:55 +00:00
ipReachability :
$ref : '#/components/schemas/IpReachability'
2021-03-08 12:25:09 +00:00
ScpDomainInfo :
description : SCP Domain specific information
type : object
properties :
scpFqdn :
$ref : '#/components/schemas/Fqdn'
scpIpEndPoints :
type : array
items :
$ref : '#/components/schemas/IpEndPoint'
minItems : 1
scpPrefix :
type : string
scpPorts :
type : object
additionalProperties :
type : integer
minimum : 0
maximum : 65535
minProperties : 1
ScpDomainCond :
description : Subscription to a set of NF or SCP instances belonging to certain SCP domains
type : object
properties :
scpDomains :
type : array
items :
type : string
minItems : 1
OptionsResponse :
description : Communication options of the NRF sent in response payload of OPTIONS method
type : object
properties :
supportedFeatures :
$ref : 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
ConditionEventType :
# description: Indicates whether a notification is due to the NF Instance to start or stop being part of a condition for a subscription to a set of NFs
# anyOf:
# - type: string
2021-07-07 08:32:55 +00:00
type : string
2021-03-08 12:25:09 +00:00
enum :
- NF_ADDED
- NF_REMOVED
2021-07-07 08:32:55 +00:00
# - type: string
IpReachability :
# description: Indicates the type(s) of IP addresses reachable via an SCP
# anyOf:
# - type: string
2021-03-08 12:25:09 +00:00
type : string
2021-07-07 08:32:55 +00:00
enum :
- IPV4
- IPV6
- IPV4V6
# - type: string