Newer
Older
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
swagger: '2.0'
info:
description: >
DRAFT - SOL005 - NSD Management Interface IMPORTANT: Please note that this
file might be not aligned to the current version of the ETSI Group
Specification it refers to and has not been approved by the ETSI NFV ISG. In
case of discrepancies the published ETSI Group Specification takes
precedence. Please report bugs to
https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
version: 2.4.1
title: DRAFT - SOL005 - NSD Management Interface
contact:
name: NFV-SOL WG
license:
name: ETSI Forge copyright notice
url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
consumes:
- application/json
produces:
- application/json
paths:
/ns_descriptors:
get:
summary: Query NSD Info
description: >-
The GET method queries information about multiple NS descriptor
resources. This method shall follow the provisions specified in the
Tables 5.4.2.3.2-1 and 5.4.2.3.2-2 of GS NFV-SOL 005 for URI query
parameters, request and response data structures, and response codes.
parameters: []
responses:
'200':
description: >-
Information about zero or more NS descriptors.
The response body shall contain a representation of zero or more NS
descriptors, as defined in clause 5.5.2.2 of GS NFV-SOL 005.
schema:
type: object
required:
- _links
- id
- nsdOnboardingState
- nsdOperationalState
- nsdUsageState
properties:
id:
type: object
nsdId:
type: object
nsdName:
type: string
description: >-
Name of the onboarded NSD. This information is copied from the
NSD content and shall be present after the NSD content is
on-boarded.
nsdVersion:
type: object
nsdDesigner:
type: string
description: >-
Designer of the on-boarded NSD. This information
is copied from the NSD content and shall be present after the
NSD content is on-boarded.
nsdInvariantId:
type: object
vnfPkgIds:
type: object
pnfdInfoIds:
type: object
nestedNsdInfoIds:
type: object
nsdOnboardingState:
type: string
description: >-
The enumeration NsdOnboardingStateType shall comply with the
provisions defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It
indicates the onboarding state of the NSD.
CREATED = The NSD information object is created. UPLOADING =
The associated NSD content is being uploaded. PROCESSING = The
associated NSD content is being processed, e.g. validation.
ONBOARDED = The associated NSD content is on-boarded.
enum:
- CREATED
- UPLOADING
- PROCESSING
- ONBOARDED
onboardingFailureDetails:
type: object
nsdOperationalState:
type: string
description: >-
The enumeration NsdOperationalStateType shall comply with the
provisions defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It
indicates the operational state of the resource.
ENABLED = The operational state of the resource is enabled.
DISABLED = The operational state of the resource is disabled.
enum:
- ENABLED
- DISABLED
nsdUsageState:
type: string
description: >-
The enumeration NsdUsageStateType shall comply with the
provisions defined in Table 5.5.4.4-1 of GS NFV-SOL 005. It
indicates the usage state of the resource.
IN_USE = The resource is in use.
NOT_IN_USE = The resource is not-in-use.
enum:
- IN_USE
- NOT_IN_USE
userDefinedData:
type: object
_links:
type: object
description: Links to resources related to this resource.
properties:
self:
type: object
nsd_content:
type: object
description: This type represents a response for the query NSD operation.
'400':
description: >-
There are two possible scenarios listed below.
Error: Invalid attribute-based filtering parameters.
The response body shall contain a ProblemDetails structure, in which
the "detail" attribute should convey more information about the
error.
Error: Invalid attribute selector. The response body shall contain a
ProblemDetails structure, in which the "detail" attribute should
convey more information about the error.
post:
summary: Create NSD Info
description: >-
The POST method is used to create a new NS descriptor resource. This
method shall follow the provisions specified in the Tables 5.4.2.3.1-1
and 5.4.2.3.1-2 of GS NFV-SOL 005 for URI query parameters, request and
response data structures, and response codes.
consumes: []
parameters:
- name: body
in: body
required: true
schema:
type: object
required:
- CreateNsdInfoRequest
properties:
CreateNsdInfoRequest:
type: object
properties:
userDefinedData:
type: object
description: This type creates a completely new NS descriptor resource.
description: >-
The CreateNsdInfoRequest contains parameters for creating an NS
descriptor resource, as defined in
clause 5.5.2.4 of GS NFV-SOL 005.
responses:
'201':
description: Status 201
schema:
type: object
description: >-
An NS descriptor resource was created successfully, as a new NS
descriptor resource. The response body shall contain a
representation of the new NS descriptor resource, as defined in
clause 5.5.2.2 of GS NFV-SOL 005.
properties:
NsdInfo:
type: object
required:
- _links
- id
- nsdOnboardingState
- nsdOperationalState
- nsdUsageState
properties:
id:
type: object
nsdId:
type: object
nsdName:
type: string
description: >-
Name of the onboarded NSD. This information is copied from
the NSD content and shall be present after the NSD content
is on-boarded.
nsdVersion:
type: object
nsdDesigner:
type: string
description: >-
Designer of the on-boarded NSD. This information
is copied from the NSD content and shall be present after
the NSD content is on-boarded.
nsdInvariantId:
type: object
vnfPkgIds:
type: object
pnfdInfoIds:
type: object
nestedNsdInfoIds:
type: object
nsdOnboardingState:
type: string
description: >-
The enumeration NsdOnboardingStateType shall comply with
the provisions defined in Table 5.5.4.5-1 of GS NFV-SOL
005. It indicates the onboarding state of the NSD.
CREATED = The NSD information object is created. UPLOADING
= The associated NSD content is being uploaded. PROCESSING
= The associated NSD content is being processed, e.g.
validation. ONBOARDED = The associated NSD content is
on-boarded.
enum:
- CREATED
- UPLOADING
- PROCESSING
- ONBOARDED
onboardingFailureDetails:
type: object
nsdOperationalState:
type: string
description: >-
The enumeration NsdOperationalStateType shall comply with
the provisions defined in Table 5.5.4.3-1 of GS NFV_SOL
005. It indicates the operational state of the resource.
ENABLED = The operational state of the resource is
enabled. DISABLED = The operational state of the resource
is disabled.
enum:
- ENABLED
- DISABLED
nsdUsageState:
type: string
description: >-
The enumeration NsdUsageStateType shall comply with the
provisions defined in Table 5.5.4.4-1 of GS NFV-SOL 005.
It indicates the usage state of the resource.
IN_USE = The resource is in use.
NOT_IN_USE = The resource is not-in-use.
enum:
- IN_USE
- NOT_IN_USE
userDefinedData:
type: object
_links:
type: object
description: Links to resources related to this resource.
properties:
self:
type: object
nsd_content:
type: object
description: This type represents a response for the query NSD operation.
headers:
Location:
type: string
description: >-
The HTTP response shall include a "Location" HTTP header that
contains the resource URI of the new NS descriptor resource.
'/ns_descriptors/{nsdInfoId}':
get:
summary: Query NSD Info
description: >-
The GET method reads information about an individual NS descriptor. This
method shall follow the provisions specified in GS NFV-SOL 005 Tables
5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters,
request and response data structures, and response codes.
parameters: []
responses:
'200':
description: >-
Information about the individual NS descriptor. The response body
shall contain a representation of the individual NS descriptor, as
defined in clause 5.5.2.2 of GS NFV-SOL 005.
schema:
type: object
required:
- _links
- id
- nsdOnboardingState
- nsdOperationalState
- nsdUsageState
properties:
id:
type: object
nsdId:
type: object
nsdName:
type: string
description: >-
Name of the onboarded NSD. This information is copied from the
NSD content and shall be present after the NSD content is
on-boarded.
nsdVersion:
type: object
nsdDesigner:
type: string
description: >-
Designer of the on-boarded NSD. This information
is copied from the NSD content and shall be present after the
NSD content is on-boarded.
nsdInvariantId:
type: object
vnfPkgIds:
type: object
pnfdInfoIds:
type: object
nestedNsdInfoIds:
type: object
nsdOnboardingState:
type: string
description: >-
The enumeration NsdOnboardingStateType shall comply with the
provisions defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It
indicates the onboarding state of the NSD.
CREATED = The NSD information object is created. UPLOADING =
The associated NSD content is being uploaded. PROCESSING = The
associated NSD content is being processed, e.g. validation.
ONBOARDED = The associated NSD content is on-boarded.
enum:
- CREATED
- UPLOADING
- PROCESSING
- ONBOARDED
onboardingFailureDetails:
type: object
nsdOperationalState:
type: string
description: >-
The enumeration NsdOperationalStateType shall comply with the
provisions defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It
indicates the operational state of the resource.
ENABLED = The operational state of the resource is enabled.
DISABLED = The operational state of the resource is disabled.
enum:
- ENABLED
- DISABLED
nsdUsageState:
type: string
description: >-
The enumeration NsdUsageStateType shall comply with the
provisions defined in Table 5.5.4.4-1 of GS NFV-SOL 005. It
indicates the usage state of the resource.
IN_USE = The resource is in use.
NOT_IN_USE = The resource is not-in-use.
enum:
- IN_USE
- NOT_IN_USE
userDefinedData:
type: object
_links:
type: object
description: Links to resources related to this resource.
properties:
self:
type: object
nsd_content:
type: object
description: This type represents a response for the query NSD operation.
delete:
summary: Delete NSD
description: >-
The DELETE method deletes an individual NS descriptor resource. An
individual NS descriptor resource can only be deleted when there is no
NS instance using it (i.e. usageState = NOT_IN_USE) and has been
disabled already (i.e. operationalState = DISABLED). Otherwise, the
DELETE method shall fail. This method shall follow the provisions
specified in the Tables 5.4.3.3.5-1 and 5.4.3.3.5-2 of GS NFV-SOL 005
for URI query parameters, request and response data structures, and
response codes.
parameters: []
responses:
'204':
description: >-
The operation has completed successfully. The response body shall be
empty.
schema:
type: object
description: >-
The operation has completed successfully. The response body shall
be empty.
'409':
description: Status 409
schema:
required:
- ProblemDetails
type: object
description: >-
Error: The operation cannot be executed currently, due to a
conflict with the state of the resource. Typically, this is due to
the fact the NS descriptor resource is in the enabled operational
state (i.e. operationalState = ENABLED) or there are running NS
instances using the concerned individual NS descriptor resource
(i.e. usageState = IN_USE). The response body shall contain a
ProblemDetails structure, in which the "detail" attribute shall
convey more information about the error.
properties:
ProblemDetails:
type: object
patch:
summary: Update NSD Info
description: >-
The PATCH method modifies the operational state and/or user defined data
of an individual NS descriptor resource. This method can be used to:
1) Enable a previously disabled individual NS descriptor resource,
allowing again its use for instantiation of new
network service with this descriptor. The usage state (i.e.
"IN_USE/NOT_IN_USE") shall not change as a
result.
2) Disable a previously enabled individual NS descriptor resource,
preventing any further use for instantiation of
new network service(s) with this descriptor. The usage state (i.e.
"IN_USE/NOT_IN_USE") shall not change
as a result.
3) Modify the user defined data of an individual NS descriptor resource.
This method shall follow the provisions specified in the Tables
5.4.3.3.4-1 and 5.4.3.3.4-2 for URI query parameters,
request and response data structures, and response codes.
consumes: []
parameters:
- name: body
in: body
required: true
schema:
type: object
required:
- NsdInfoModifications
properties:
NsdInfoModifications:
type: object
properties:
nsdOperationalState:
type: string
description: >-
The enumeration NsdOperationalStateType shall comply with
the provisions defined in Table 5.5.4.3-1 of GS NFV_SOL
005. It indicates the operational state of the resource.
ENABLED = The operational state of the resource is
enabled. DISABLED = The operational state of the resource
is disabled.
enum:
- ENABLED
- DISABLED
userDefinedData:
type: object
description: >-
Modifications of the "userDefinedData" attribute in
"NsdInfo" data type. See note. If present, these
modifications shall be applied according to the rules of
JSON Merge PATCH (see IETF RFC 7396 [25]).
NOTE: At least one of the attributes - nsdOperationalState
and userDefinedData - shall be present.
description: >-
This type represents attribute modifications for an individual
NS descriptor resource based on the "NsdInfo" data type. The
attributes of "NsdInfo" that can be modified are included in
the "NsdInfoModifications" data type.
NOTE: At least one of the attributes - nsdOperationalState and
userDefinedData - shall be present.
description: >-
The operation was completed successfully. The response body shall
contain attribute modifications for an 'Individual NS Descriptor'
resource (see clause 5.5.2.6 of GS NFV SOL-005).
responses:
'200':
description: Status 200
schema:
type: object
properties:
nsdOperationalState:
type: string
description: >-
The enumeration NsdOperationalStateType shall comply with the
provisions defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It
indicates the operational state of the resource.
ENABLED = The operational state of the resource is enabled.
DISABLED = The operational state of the resource is disabled.
enum:
- ENABLED
- DISABLED
userDefinedData:
type: object
description: >-
Modifications of the "userDefinedData" attribute in "NsdInfo"
data type. See note. If present, these modifications shall be
applied according to the rules of JSON Merge PATCH (see IETF
RFC 7396 [25]).
NOTE: At least one of the attributes - nsdOperationalState and
userDefinedData - shall be present.
description: >-
This type represents attribute modifications for an individual NS
descriptor resource based on the "NsdInfo" data type. The
attributes of "NsdInfo" that can be modified are included in the
"NsdInfoModifications" data type.
NOTE: At least one of the attributes - nsdOperationalState and
userDefinedData - shall be present.
'409':
description: Status 409
schema:
type: object
'412':
description: Status 412
schema:
type: object
parameters:
- name: nsdInfoId
in: path
required: true
type: string
'/ns_descriptors/{nsdInfoId}/nsd_content':
get:
summary: Get NSD Content
description: >-
The GET method fetches the content of the NSD.
The NSD can be implemented as a single file or as a collection of
multiple files. If the NSD is implemented in the form of multiple files,
a ZIP file embedding these files shall be returned. If the NSD is
implemented as a single file, either that file or a ZIP file embedding
that file shall be returned.
The selection of the format is controlled by the "Accept" HTTP header
passed in the GET request:
• If the "Accept" header contains only "text/plain" and the NSD is
implemented as a single file, the file shall be returned; otherwise, an
error message shall be returned.
• If the "Accept" header contains only "application/zip", the single
file or the multiple files that make up the NSD shall be returned
embedded in a ZIP file.
• If the "Accept" header contains both "text/plain" and
"application/zip", it is up to the NFVO to choose the format to return
for a single-file NSD; for a multi-file NSD, a ZIP file shall be
returned.
NOTE: The structure of the NSD zip file is outside the scope of the
present document.
parameters:
- name: Accept
in: header
required: true
type: string
description: >-
The request shall contain the appropriate entries in the "Accept"
HTTP header as defined above.
- name: Range
in: header
required: false
type: string
description: >-
The request may contain a "Range" HTTP header to obtain single range
of bytes from the NSD file. This can be used to continue an aborted
transmission.
If the NFVO does not support range requests, the NFVO shall ignore
the 'Range" header, process the GET request, and return the whole
NSD file with a 200 OK response (rather than returning a 4xx error
status code).
responses:
'200':
description: >-
On success, the content of the NSD is returned. The payload body
shall contain a copy of the file representing the NSD or a ZIP file
that contains the file or multiple files representing the NSD, as
specified above. The "Content-Type" HTTP header shall be set
according to the format of the returned file, i.e. to "text/plain"
for a YAML file or to "application/zip" for a ZIP file.
schema:
type: object
headers:
Content-Type:
type: string
'206':
description: >-
On success, if the NFVO supports range requests, a single
consecutive byte range from the content of the NSD file is returned.
The response body shall contain the requested part of the NSD file.
The "Content-Range" HTTP header shall be provided according to IETF
RFC 7233 [23].
The "Content-Type" HTTP header shall be set as defined above for the
"200 OK" response.
headers:
Content-Range:
type: string
Content-Type:
type: string
'406':
description: Status 406
schema:
type: object
description: >-
If the "Accept" header does not contain at least one name of a
content type for which the NFVO can provide a representation of
the NSD, the NFVO shall respond with this response code. The
"ProblemDetails" structure may be included with the "detail"
attribute providing more information about the error.
'409':
description: Status 409
schema:
type: object
description: >-
Error: The operation cannot be executed currently, due to a
conflict with the state of the resource. Typically, this is due to
the fact "nsdOnboardingState" has a value different from
ONBOARDED. The response body shall contain a ProblemDetails
structure, in which the "detail" attribute shall convey more
information about the error.
'416':
description: Status 416
schema:
type: object
description: >-
The byte range passed in the "Range" header did not match any
available byte range in the NSD file (e.g.
"access after end of file"). The response body may contain a
ProblemDetails structure.
put:
summary: Upload NSD
description: >-
The PUT method is used to upload the content of a NSD. The NSD to be
uploaded can be implemented as a single file or as a collection of
multiple files, as defined in clause 5.4.4.3.2 of GS NFV-SOL 005. If the
NSD is implemented in the form of multiple files, a ZIP file embedding
these files shall be uploaded. If the NSD is implemented as a single
file, either that file or a ZIP file embedding that file shall be
uploaded. The "Content-Type" HTTP header in the PUT request shall be set
accordingly based on the format selection of the NSD. If the NSD to be
uploaded is a text file, the "Content-Type" header is set to
"text/plain". If the NSD to be uploaded is a zip file, the
"Content-Type" header is set to "application/zip". This method shall
follow the provisions specified in the Tables 5.4.4.3.3-1 and
5.4.4.3.3-2 of GS-NFV-SOL 005 for URI query parameters, request and
response data structures, and response codes.
consumes: []
parameters:
- name: Content-Type
in: header
required: false
type: string
description: >-
The payload body contains a copy of the file representing the NSD or
a ZIP file that contains the file or multiple files representing the
NSD, as specified above. The request shall set the "Content-Type"
HTTP header as defined
above.
- name: body
in: body
required: true
schema:
type: object
responses:
'202':
description: Status 202
schema:
type: object
description: >-
The NSD content was accepted for uploading, but the processing has
not been completed. It is expected to take some time for
processing (asynchronous mode). The response body shall be empty.
See note.
'204':
description: >-
The NSD content was successfully uploaded and validated (synchronous
mode). The response body shall be empty.
'409':
description: >-
Error: The operation cannot be executed currently, due to a conflict
with the state of the resource. Typically, this is due to the fact
that the NsdOnboardingState has a value other than CREATED. The
response body shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about the error.
schema:
type: object
parameters:
- name: nsdInfoId
in: path
required: true
type: string
/pnf_descriptors:
get:
summary: Query PFND Info
description: >-
The GET method queries information about multiple PNF descriptor
resources.
parameters:
- name: exclude_default
in: query
required: false
type: string
description: >-
Indicates to exclude the following
complex attributes from the response.
See clause 4.3.3 for details.
The NFVO shall support this parameter.
The following attributes shall be excluded from the PnfdInfo
structure in the response body if this parameter is provided, or
none of the parameters "all_fields," "fields", "exclude_fields",
"exclude_default" are provided: userDefinedData.
- name: all_fields
in: query
required: false
type: string
description: >-
Include all complex attributes in the response. See clause 4.3.3 for
details. The NFVO shall support this parameter.
responses:
'200':
description: Status 200
schema:
type: object
description: >-
Information about zero or more PNF descriptors. The response body
shall contain a representation of zero or more PNF descriptors, as
defined in clause 5.5.2.2.
post:
summary: Create PNFD Info
description: The POST method is used to create a new PNF descriptor resource.
consumes: []
parameters:
- name: body
in: body
required: true
schema:
type: object
description: |-
Parameters of creating a PNF descriptor resource, as defined in
clause 5.5.2.6 of GS NFV-SOL 005.
responses:
'201':
description: Status 201
schema:
type: object
description: >-
A PNF descriptor resource was created successfully, as a new PNF
descriptor resource. The response body shall contain a
representation of the new PNF descriptor resource, as defined in
clause 5.5.2.5. The HTTP response shall include a "Location" HTTP
header that contains the resource URI of the new PNF descriptor
resource.
'/pnf_descriptors/{pnfdInfoId}':
get:
summary: Query PNFD Info
description: >-
The GET method reads information about an individual PNF descriptor.
This method shall follow the provisions specified in the Tables
5.4.6.3.2-1 and 5.4.6.3.2-2 of GS NFV-SOL 005 for URI query parameters,
request and response data structures, and response codes.
parameters: []
responses:
'200':
description: >-
Information about the individual PNFD descriptor. The response body
shall contain a representation of the individual PNF descriptor, as
defined in clause 5.5.2.5 of GS NFV-SOL 005.
delete:
summary: Delete PNFD
description: >-
The DELETE method deletes an individual PNF descriptor resource. An
individual PNF descriptor resource can only be deleted when there is no
NS instance using it or there is NSD referencing it. To delete all PNFD
versions identified by a particular value of the "pnfdInvariantId"
attribute, the procedure is to first use the GET method with filter
"pnfdInvariantId" towards the PNF descriptors resource to find all
versions of the PNFD. Then, the client uses the DELETE method described
in this clause to delete each PNFD version individually. This method
shall follow the provisions specified in the Tables 5.4.6.3.5-1 and
5.4.6.3.5-2 of GS NFV-SOL 005 for URI query parameters, request and
response data structures, and response codes.
parameters: []
responses:
'204':
description: >-
The operation has completed successfully. The response body shall be
empty.
patch:
summary: Update PNFD Info
description: >-
The PATCH method modifies the user defined data of an individual PNF
descriptor resource. This method shall follow the provisions specified
in the Tables 5.4.6.3.4-1 and 5.4.6.3.4-2 for URI query parameters,
request and response data structures, and response codes.
consumes: []
parameters:
- name: body
in: body
required: true
schema:
type: object
required:
- userDefinedData
properties:
userDefinedData:
type: object
description: >-
This type represents attribute modifications for an individual PNF
descriptor resource based on the "PnfdInfo" data type. The
attributes of "PnfdInfo" that can be modified are included in the
"PnfdInfoModifications" data type.
responses:
'200':
description: Status 200
schema:
type: object
required:
- userDefinedData
properties:
userDefinedData:
type: object
description: >-
This type represents attribute modifications for an individual PNF
descriptor resource based on the "PnfdInfo" data type. The
attributes of "PnfdInfo" that can be modified are included in the
"PnfdInfoModifications" data type.
'412':
description: Status 412
schema:
type: object
parameters:
- name: pnfdInfoId
in: path
required: true
type: string
'/pnf_descriptors/{pnfdInfoId}/pnfd_content':
get:
summary: Get PNFD Content
description: The GET method fetches the content of the PNFD.
parameters: []
responses:
'200':
description: >-
On success, the content of the PNFD is returned. The payload body
shall contain a copy of the file representing the PNFD. The
"Content-Type" HTTP header shall be set to "text/plain".
put:
summary: Upload PNFD
description: >-
The PUT method is used to upload the content of a PNFD. This method
shall follow the provisions specified in the Tables 5.4.7.3.3-1 and
5.4.7.3.3-2 of GS NFV-SOL 005for URI query parameters, request and
response data structures, and response codes.
consumes: []
parameters:
- name: Content-Type
in: header
required: false
type: string
description: >-
The request shall set the "Content-Type" HTTP header to
"text/plain".
- name: body
in: body
required: true
schema:
type: object
description: >-
The payload body contains a copy of the file representing the
PNFD.
responses:
'204':
description: >-
The PNFD content was successfully uploaded and validated. The
response body shall be empty.
'409':
description: Status 409
schema:
type: object
parameters:
- name: pnfdInfoId
in: path
required: true
type: string
/subscriptions:
get:
summary: Query Subscription Information
description: >-
The GET method queries the list of active subscriptions of the
functional block that invokes the method. It can be used e.g. for
resynchronization after error situations. This method shall support the
URI query parameters, request and response data structures, and response
codes, as specified in the Tables 5.4.8.3.2-1 and 5.4.8.3.2-2 of GS
NFV-SOL 005.
parameters: []
responses:
'200':
description: Status 200
schema:
type: array
description: >-
The list of subscriptions was queried successfully. The response
body shall contain the representations of all active subscriptions
of the functional block that invokes the method.
items:
type: object
required:
- _links
- callbackUri
- id
properties:
id:
type: object
filter:
type: object
properties:
notificationTypes:
type: string
description: >-
Match particular notification types. Permitted values:
NsdOnBoardingNotification,
NsdOnboardingFailureNotification, NsdChangeNotification,
NsdDeletionNotification
PnfdOnBoardingNotification,
PnfdOnBoardingFailureNotification,
PnfdDeletionNotification.
The permitted values of the "notificationTypes" ]
attribute are spelled exactly as the names of the
notification types to facilitate automated code
generation systems.
enum:
- NsdOnBoardingNotification
- NsdOnboardingFailureNotification