forked from jdegre/5GC_APIs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTS29510_Nnrf_NFDiscovery.yaml
1690 lines (1664 loc) · 60.3 KB
/
TS29510_Nnrf_NFDiscovery.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
version: '1.2.0-alpha.4'
title: 'NRF NFDiscovery Service'
description: |
NRF NFDiscovery Service.
© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.510 V17.3.0; 5G System; Network Function Repository Services; Stage 3
url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.510/'
servers:
- url: '{apiRoot}/nnrf-disc/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
- {}
- oAuth2ClientCredentials:
- nnrf-disc
paths:
/nf-instances:
get:
summary: Search a collection of NF Instances
operationId: SearchNFInstances
tags:
- NF Instances (Store)
parameters:
- name: Accept-Encoding
in: header
description: Accept-Encoding, described in IETF RFC 7231
schema:
type: string
- name: target-nf-type
in: query
description: Type of the target NF
required: true
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType'
- name: requester-nf-type
in: query
description: Type of the requester NF
required: true
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType'
- name: requester-nf-instance-id
in: query
description: NfInstanceId of the requester NF
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
- name: service-names
in: query
description: Names of the services offered by the NF
schema:
type: array
items:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName'
minItems: 1
uniqueItems: true
style: form
explode: false
- name: requester-nf-instance-fqdn
in: query
description: FQDN of the requester NF
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/Fqdn'
- name: target-plmn-list
in: query
description: Id of the PLMN of either the target NF, or in SNPN scenario the Credentials Holder in the PLMN
content:
application/json:
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
minItems: 1
- name: requester-plmn-list
in: query
description: Id of the PLMN where the NF issuing the Discovery request is located
content:
application/json:
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
minItems: 1
- name: target-nf-instance-id
in: query
description: Identity of the NF instance being discovered
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
- name: target-nf-fqdn
in: query
description: FQDN of the NF instance being discovered
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/Fqdn'
- name: hnrf-uri
in: query
description: Uri of the home NRF
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
- name: snssais
in: query
description: Slice info of the target NF
content:
application/json:
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 1
- name: requester-snssais
in: query
description: Slice info of the requester NF
content:
application/json:
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 1
- name: plmn-specific-snssai-list
in: query
description: PLMN specific Slice info of the target NF
content:
application/json:
schema:
type: array
items:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai'
minItems: 1
- name: requester-plmn-specific-snssai-list
in: query
description: PLMN-specific slice info of the NF issuing the Discovery request
content:
application/json:
schema:
type: array
items:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai'
minItems: 1
- name: dnn
in: query
description: Dnn supported by the BSF, SMF or UPF
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
- name: nsi-list
in: query
description: NSI IDs that are served by the services being discovered
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
- name: smf-serving-area
in: query
schema:
type: string
- name: tai
in: query
description: Tracking Area Identity
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Tai'
- name: amf-region-id
in: query
description: AMF Region Identity
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId'
- name: amf-set-id
in: query
description: AMF Set Identity
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId'
- name: guami
in: query
description: Guami used to search for an appropriate AMF
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Guami'
- name: supi
in: query
description: SUPI of the user
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
- name: ue-ipv4-address
in: query
description: IPv4 address of the UE
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
- name: ip-domain
in: query
description: IP domain of the UE, which supported by BSF
schema:
type: string
- name: ue-ipv6-prefix
in: query
description: IPv6 prefix of the UE
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
- name: pgw-ind
in: query
description: Combined PGW-C and SMF or a standalone SMF
schema:
type: boolean
- name: pgw
in: query
description: PGW FQDN of a combined PGW-C and SMF
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/Fqdn'
- name: pgw-ip
in: query
description: PGW IP Address of a combined PGW-C and SMF
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
- name: gpsi
in: query
description: GPSI of the user
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
- name: external-group-identity
in: query
description: external group identifier of the user
schema:
$ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId'
- name: internal-group-identity
in: query
description: internal group identifier of the user
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'
- name: pfd-data
in: query
description: PFD data
content:
application/json:
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PfdData'
- name: data-set
in: query
description: data set supported by the NF
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DataSetId'
- name: routing-indicator
in: query
description: routing indicator in SUCI
schema:
type: string
pattern: '^[0-9]{1,4}$'
- name: group-id-list
in: query
description: Group IDs of the NFs being discovered
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
minItems: 1
style: form
explode: false
- name: dnai-list
in: query
description: Data network access identifiers of the NFs being discovered
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems: 1
style: form
explode: false
- name: pdu-session-types
in: query
description: list of PDU Session Type required to be supported by the target NF
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType'
minItems: 1
style: form
explode: false
- name: event-id-list
in: query
description: Analytics event(s) requested to be supported by the Nnwdaf_AnalyticsInfo service
schema:
type: array
items:
$ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventId'
minItems: 1
style: form
explode: false
- name: nwdaf-event-list
in: query
description: Analytics event(s) requested to be supported by the Nnwdaf_EventsSubscription service.
schema:
type: array
items:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent'
minItems: 1
style: form
explode: false
- name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
- name: upf-iwk-eps-ind
in: query
description: UPF supporting interworking with EPS or not
schema:
type: boolean
- name: chf-supported-plmn
in: query
description: PLMN ID supported by a CHF
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
- name: preferred-locality
in: query
description: preferred target NF location
schema:
type: string
- name: access-type
in: query
description: AccessType supported by the target NF
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType'
- name: limit
in: query
description: Maximum number of NFProfiles to return in the response
required: false
schema:
type: integer
minimum: 1
- name: required-features
in: query
description: Features required to be supported by the target NF
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
minItems: 1
style: form
explode: false
- name: complex-query
in: query
description: the complex query condition expression
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ComplexQuery'
- name: max-payload-size
in: query
description: Maximum payload size of the response expressed in kilo octets
required: false
schema:
type: integer
maximum: 2000
default: 124
- name: max-payload-size-ext
in: query
description: Extended query for maximum payload size of the response expressed in kilo octets
required: false
schema:
type: integer
default: 124
- name: atsss-capability
in: query
description: ATSSS Capability
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability'
- name: upf-ue-ip-addr-ind
in: query
description: UPF supporting allocating UE IP addresses/prefixes
schema:
type: boolean
- name: client-type
in: query
description: Requested client type served by the NF
content:
application/json:
schema:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType'
- name: lmf-id
in: query
description: LMF identification to be discovered
content:
application/json:
schema:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification'
- name: an-node-type
in: query
description: Requested AN node type served by the NF
content:
application/json:
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AnNodeType'
- name: rat-type
in: query
description: Requested RAT type served by the NF
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
- name: preferred-tai
in: query
description: preferred Tracking Area Identity
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Tai'
- name: preferred-nf-instances
in: query
description: preferred NF Instances
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
minItems: 1
style: form
explode: false
- name: If-None-Match
in: header
description: Validator for conditional requests, as described in IETF RFC 7232, 3.2
schema:
type: string
- name: target-snpn
in: query
description: Target SNPN Identity, or the Credentials Holder in the SNPN
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
- name: requester-snpn-list
in: query
description: SNPN ID(s) of the NF instance issuing the Discovery request
content:
application/json:
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
minItems: 1
- name: af-ee-data
in: query
description: NEF exposured by the AF
content:
application/json:
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AfEventExposureData'
- name: w-agf-info
in: query
description: UPF collocated with W-AGF
content:
application/json:
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/WAgfInfo'
- name: tngf-info
in: query
description: UPF collocated with TNGF
content:
application/json:
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TngfInfo'
- name: twif-info
in: query
description: UPF collocated with TWIF
content:
application/json:
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TwifInfo'
- name: target-nf-set-id
in: query
description: Target NF Set ID
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
- name: target-nf-service-set-id
in: query
description: Target NF Service Set ID
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId'
- name: nef-id
in: query
description: NEF ID
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefId'
- name: notification-type
in: query
description: Notification Type
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NotificationType'
- name: n1-msg-class
in: query
description: N1 Message Class
schema:
$ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N1MessageClass'
- name: n2-info-class
in: query
description: N2 Information Class
schema:
$ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InformationClass'
- name: serving-scope
in: query
description: areas that can be served by the target NF
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
- name: imsi
in: query
description: IMSI of the requester UE to search for an appropriate NF (e.g. HSS)
schema:
type: string
pattern: '^[0-9]{5,15}$'
- name: ims-private-identity
in: query
description: IMPI of the requester UE to search for a target HSS
schema:
type: string
- name: ims-public-identity
in: query
description: IMS Public Identity of the requester UE to search for a target HSS
schema:
type: string
- name: msisdn
in: query
description: MSISDN of the requester UE to search for a target HSS
schema:
type: string
- name: preferred-api-versions
in: query
description: Preferred API version of the services to be discovered
content:
application/json:
schema:
description: A map (list of key-value pairs) where ServiceName serves as key
type: object
additionalProperties:
type: string
minProperties: 1
- name: v2x-support-ind
in: query
description: PCF supports V2X
schema:
type: boolean
- name: redundant-gtpu
in: query
description: UPF supports redundant gtp-u to be discovered
schema:
type: boolean
- name: redundant-transport
in: query
description: UPF supports redundant transport path to be discovered
schema:
type: boolean
- name: ipups
in: query
description: UPF which is configured for IPUPS functionality to be discovered
schema:
type: boolean
- name: scp-domain-list
in: query
description: SCP domains the target SCP or SEPP belongs to
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
- name: address-domain
in: query
description: Address domain reachable through the SCP
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/Fqdn'
- name: ipv4-addr
in: query
description: IPv4 address reachable through the SCP
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
- name: ipv6-prefix
in: query
description: IPv6 prefix reachable through the SCP
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
- name: served-nf-set-id
in: query
description: NF Set ID served by the SCP
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
- name: remote-plmn-id
in: query
description: Id of the PLMN reachable through the SCP or SEPP
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
- name: data-forwarding
in: query
description: UPF Instance(s) configured for data forwarding are requested
schema:
type: boolean
- name: preferred-full-plmn
in: query
description: NF Instance(s) serving the full PLMN are preferred
schema:
type: boolean
- name: requester-features
in: query
description: Features supported by the NF Service Consumer that is invoking the Nnrf_NFDiscovery service
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
- name: realm-id
in: query
description: realm-id to search for an appropriate UDSF
schema:
type: string
- name: storage-id
in: query
description: storage-id to search for an appropriate UDSF
schema:
type: string
- name: vsmf-support-ind
in: query
description: V-SMF capability supported by the target NF instance(s)
schema:
type: boolean
- name: nrf-disc-uri
in: query
description: Uri of the NRF holding the NF profile of a target NF Instance
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
- name: preferred-vendor-specific-features
in: query
description: Preferred vendor specific features of the services to be discovered
content:
application/json:
schema:
description: A map (list of key-value pairs) where ServiceName serves as key
type: object
additionalProperties:
description: A map (list of key-value pairs) where IANA-assigned SMI Network Management Private Enterprise Codes serves as key
type: object
additionalProperties:
type: array
items:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature'
minItems: 1
minProperties: 1
minProperties: 1
- name: preferred-vendor-specific-nf-features
in: query
description: Preferred vendor specific features of the network function to be discovered
content:
application/json:
schema:
description: A map (list of key-value pairs) where IANA-assigned SMI Network Management Private Enterprise Codes serves as key
type: object
additionalProperties:
type: array
items:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature'
minItems: 1
minProperties: 1
- name: required-pfcp-features
in: query
description: PFCP features required to be supported by the target UPF
schema:
type: string
- name: home-pub-key-id
in: query
description: Indicates the Home Network Public Key ID which shall be able to be served by the NF instance
schema:
type: integer
- name: prose-support-ind
in: query
description: PCF supports ProSe Capability
schema:
type: boolean
- name: analytics-aggregation-ind
in: query
description: analytics aggregation is supported by NWDAF or not
schema:
type: boolean
- name: serving-nf-set-id
in: query
description: NF Set Id served by target NF
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
- name: serving-nf-type
in: query
description: NF type served by the target NF
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType'
- name: ml-analytics-id-list
in: query
description: Analytics Id(s) of Nnwdaf_MLModelProvision service
content:
application/json:
schema:
type: array
items:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent'
minItems: 1
- name: analytics-metadata-prov-ind
in: query
description: analytics matadata provisioning is supported by NWDAF or not
schema:
type: boolean
- name: nsacf-serving-area
in: query
description: the serving area of the NSACF
schema:
type: string
- name: nsacf-capability
in: query
description: the service capability supported by the target NSACF
schema:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NsacfCapability'
- name: mbs-session-id-list
in: query
description: List of MBS Session ID(s)
content:
application/json:
schema:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId'
minItems: 1
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: '#/components/schemas/SearchResult'
links:
search:
operationId: RetrieveStoredSearch
parameters:
searchId: $response.body#/searchId
description: >
The 'searchId' parameter returned in the response can be used as the
'searchId' parameter in the GET request to '/searches/{searchId}'
completeSearch:
operationId: RetrieveCompleteSearch
parameters:
searchId: $response.body#/searchId
description: >
The 'searchId' parameter returned in the response can be used as the
'searchId' parameter in the GET request to '/searches/{searchId}/complete'
headers:
Cache-Control:
description: Cache-Control containing max-age, described in IETF RFC 7234, 5.2
schema:
type: string
ETag:
description: Entity Tag containing a strong validator, described in IETF RFC 7232, 2.3
schema:
type: string
Content-Encoding:
description: Content-Encoding, described in IETF RFC 7231
schema:
type: string
'307':
description: Temporary Redirect
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
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:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
headers:
Location:
description: 'The URI pointing to the resource located on the redirect target NRF'
required: true
schema:
type: string
'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'
/searches/{searchId}:
get:
operationId: RetrieveStoredSearch
tags:
- Stored Search (Document)
parameters:
- $ref: '#/components/parameters/searchId'
- name: Accept-Encoding
in: header
description: Accept-Encoding, described in IETF RFC 7231
schema:
type: string
responses:
'200':
$ref: '#/components/responses/200'
'307':
description: Temporary Redirect
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
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:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
headers:
Location:
description: 'The URI pointing to the resource located on the redirect target NRF'
required: true
schema:
type: string
/searches/{searchId}/complete:
get:
operationId: RetrieveCompleteSearch
tags:
- Complete Stored Search (Document)
parameters:
- $ref: '#/components/parameters/searchId'
- name: Accept-Encoding
in: header
description: Accept-Encoding, described in IETF RFC 7231
schema:
type: string
responses:
'200':
$ref: '#/components/responses/200'
'307':
description: Temporary Redirect
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
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:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
headers:
Location:
description: 'The URI pointing to the resource located on the redirect target NRF'
required: true
schema:
type: string
/scp-domain-routing-info:
get:
operationId: SCPDomainRoutingInfoGet
tags:
- SCP Domain Routing Information (Document)
parameters:
- name: local
in: query
description: Indication of local SCP Domain Routing Information
required: false
schema:
type: boolean
default: false
- name: Accept-Encoding
in: header
description: Accept-Encoding, described in IETF RFC 7231
schema:
type: string
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: '#/components/schemas/ScpDomainRoutingInformation'
headers:
Content-Encoding:
description: Content-Encoding, described in IETF RFC 7231
schema:
type: string
'307':
description: Temporary Redirect
headers:
Location:
description: 'The URI pointing to the resource located on the redirect target NRF'
required: true
schema:
type: string
'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'
/scp-domain-routing-info-subs:
post:
summary: Create a new subscription
operationId: ScpDomainRoutingInfoSubscribe
tags:
- SCP Domain Routing Information Subscriptions (Collection)
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
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScpDomainRoutingInfoSubscription'
required: true
responses:
'201':