SOL005NSDescriptorManagement_def.yaml 32.2 KB
Newer Older
1
2
definitions:
  NsdInfo:
3
    type: object
4
    required:
5
6
7
8
      - id
      - nsdOnboardingState
      - nsdOperationalState
      - nsdUsageState
9
      - _links
10
11
12
13
14
15
16
17
18
19
20
21
22
23
    properties:
      id:
        description: >
          Identifier of the on boarded individual NS descriptor
          resource. This identifier is allocated by the NFVO.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsdId:
        description: >
          This identifier, which is allocated by the NSD
          designer, identifies the NSD in a globally unique
          way. It is copied from the NSD content and shall be
          present after the NSD content is on-boarded.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsdName:
24
        type: string
25
        description: >
26
27
          Name of the on boarded NSD. This information is copied from the
          NSD content and shall be present after the NSD content is on-boarded.
28
29
30
31
32
33
34
      nsdVersion:
        description: >
          Version of the on-boarded NSD. This information is
          copied from the NSD content and shall be present
          after the NSD content is on-boarded.
        $ref: "SOL005_def.yaml#/definitions/Version"
      nsdDesigner:
35
        type: string
36
        description: >
37
38
          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.
39
40
41
42
43
44
45
46
47
48
49
50
51
52
      nsdInvariantId:
        description: >
          This identifier, which is allocated by the NSD
          designer, identifies an NSD in a version independent
          manner. This information is copied from the NSD
          content and shall be present after the NSD content is
          on-boarded.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfPkgIds:
        description: >
          Identifies the VNF package for the VNFD referenced
          by the on-boarded NS descriptor resource.
        type: array
        items:
53
          $ref: "SOL005_def.yaml#/definitions/Identifier"
54
55
56
57
58
59
60
      pnfdInfoIds:
        description: >
          Identifies the PnfdInfo element for the PNFD
          referenced by the on-boarded NS descriptor
          resource.
        type: array
        items:
61
          $ref: "SOL005_def.yaml#/definitions/Identifier"
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
      nestedNsdInfoIds:
        description: >
          Identifies the NsdInfo element for the nested NSD
          referenced by the on-boarded NS descriptor
          resource.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsdOnboardingState:
        description: >
          On boarding state of the individual NS descriptor resource.
        $ref: "#/definitions/NsdOnboardingStateType"
      onboardingFailureDetails:
        description: >
          Failure details of current on boarding procedure. See
          clause 4.3.5.3 for the details of "ProblemDetails"
          structure.
          It shall be present when the "nsdOnboardingState"
          attribute is CREATED and the uploading or
          processing fails in NFVO.
        $ref: "SOL005_def.yaml#/definitions/ProblemDetails"
      nsdOperationalState:
        description: >
          Operational state of the individual NS descriptor
          resource. This attribute can be modified with the
          PATCH method.
        $ref: "#/definitions/NsdOperationalStateType"
      nsdUsageState:
        description: >
          Usage state of the individual NS descriptor resource.
        $ref: "#/definitions/NsdUsageStateType"
      userDefinedData:
        description: >
          User defined data for the individual NS descriptor
          resource. This attribute can be modified with the
          PATCH method.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
      _links:
100
        type: object
101
        required:
102
103
          - self
          - nsd_content
104
        description: >
105
          Links to resources related to this resource.
106
107
108
        properties:
          self:
            description: >
109
              URI of this resource.
110
111
112
            $ref: "SOL005_def.yaml#/definitions/Link"
          nsd_content:
            description: >
113
              Link to the NSD content resource.
114
115
            $ref: "SOL005_def.yaml#/definitions/Link"
    description: >
116
      This type represents a response for the query NSD operation.
117
118

  NsdInfoModifications:
119
    type: object
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
    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.
    properties:
      nsdOperationalState:
        $ref: "#/definitions/NsdOperationalStateType"
      userDefinedData:
        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.
135
        type: array
136
137
138
        items:
          $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

139
  NsdOperationalState:
140
    description: >
141
      New value of the "nsdOperationalState" attribute in "NsdInfo"
142
      data type. See note.Permitted values:
143
144
      ENABLED, DISABLED.
    type: array
145
146
147
148
    items:
      $ref: "#/definitions/NsdInfoModifications"

  NsdmSubscription:
149
    type: object
150
    required:
151
152
153
      - id
      - callbackUri
      - _links
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
    properties:
      id:
        description: >
          Identifier of this subscription resource.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      filter:
        description: >
          Filter settings for this subscription, to define the subset
          of all notifications this subscription relates to.
          A particular notification is sent to the subscriber if the filter
          matches, or if there is no filter.
        $ref: "#/definitions/NsdmNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        $ref: "SOL005_def.yaml#/definitions/Uri"
      _links:
171
        type: object
172
173
174
175
176
177
178
179
180
        description: >
          Links to resources related to this resource.
        properties:
          self:
            $ref: "SOL005_def.yaml#/definitions/Link"
    description: >
      This type represents a subscription related to notifications about NSD management.

  NsdmSubscriptionRequest:
181
    type: object
182
    required:
183
      - callbackUri
184
185
186
187
    properties:
      filter:
        $ref: "#/definitions/NsdmNotificationsFilter"
      callbackUri:
188
        type: string
189
190
191
192
193
194
195
        description: >
          The URI of the endpoint to send the notification to.
      authentication:
        $ref: "#/definitions/SubscriptionAuthentication"
    description: >
      This type represents a subscription request related to notifications
      about NSD management.
196

197
  NsdmNotificationsFilter:
198
    type: object
199
    description: >
200
      This type represents a subscription filter related to notifications
201
202
203
204
205
      about NSD management. It shall comply with the provisions defined in Table
      5.5.3.2-1 of GS NFV-SOL 005. At a particular nesting level in the filter structure,
      the following applies: All attributes shall match in order for the filter
      to match (logical "and" between different filter attributes). If an attribute
      is an array, the attribute shall match if at least one of the values in the
206
      array matches (logical "or" between the values of one filter attribute).
207
208
209
    properties:
      notificationTypes:
        description: >
210
          Match particular notification types. Permitted values: NsdOnBoardingNotification,
211
212
213
214
          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
215
          code generation systems.
216
217
218
219
        type: array
        items:
          type: string
          enum:
220
221
222
223
224
225
226
            - NsdOnBoardingNotification
            - NsdOnboardingFailureNotification
            - NsdChangeNotification
            - NsdDeletionNotification
            - PnfdOnBoardingNotification
            - PnfdOnBoardingFailureNotification
            - PnfdDeletionNotification
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
      nsdInfoId:
        description: >
          Match the NsdInfo identifier which is allocated by the NFVO.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsdId:
        description: >
          Match the NSD identifier, which is allocated by the NSD designer.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsdName:
        description: >
          Match the name of the on boarded NSD.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/String"
      nsdVersion:
        description: >
          Match the NSD version listed as part of this attribute.
        type: array
        items:
250
          $ref: "SOL005_def.yaml#/definitions/Version"
251
252
      nsdDesigner:
        description: >
253
          Match the NSD designer of the on-boarded NSD.
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
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/String"
      nsdInvariantId:
        description: >
          Match the NSD invariant identifier which is allocated
          by the NSD designer and identifies an NSD in a
          version independent manner.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfPkgIds:
        description: >
          Match VNF packages with a package identifier listed
          in the attribute.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdInfoIds:
        description: >
          Match the PnfdInfo identifier for the PNFD
          referenced by the on-boarded NSD.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      nestedNsdInfoIds:
        description: >
          Match the NsdInfo identifier for the nested NSD
          referenced by the on-boarded NSD.
        type: array
        items:
285
          $ref: "SOL005_def.yaml#/definitions/Identifier"
286
287
288
289
290
      nsdOnboardingState:
        description: >
          Match particular on-boarding state of the NSD.
        type: array
        items:
291
          $ref: "#/definitions/NsdOnboardingStateType"
292
293
294
295
296
      nsdOperationalState:
        description: >
          Match particular operational state of the on-boarded NSD.
        type: array
        items:
297
          $ref: "#/definitions/NsdOperationalStateType"
298
299
300
301
302
      nsdUsageState:
        description: >
          Match particular usage state of the on-boarded NSD.
        type: array
        items:
303
          $ref: "#/definitions/NsdUsageStateType"
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
      pnfdId:
        description: >
          Match the PNFD identifier which is copied from the PNFD content.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdName:
        description: >
          Match the name of the on-boarded PNFD.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/String"
      pnfdVersion:
        description: >
          Match the PNFD designer of the on-boarded PNFD.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Version"
      pnfdProvider:
        description: >
          Match the provider of the on-boarded PNFD.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/String"
      pnfdInvariantId:
        description: >
          Match the PNFD in a version independent manner.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdOnboardingState:
        description: >
          Match particular on-boarding state of the PNFD.
        type: array
        items:
          $ref: "#/definitions/PnfdOnboardingStateType"
      pnfdUsageState:
        description: >
          Match the usage state of the individual PNF descriptor resource.
        type: array
        items:
          $ref: "#/definitions/PnfdUsageStateType"
346

347
348
349
350
351
352
353
354
355
356
  SubscriptionAuthentication:
    description: >
      The procedure defined in clause 4.5.2 allows an API consumer to
      obtain authorization to perform API requests towards
      the API producer, including subscription requests.
      For sending the actual notifications matching a subscription, the API
      producer needs to obtain separate authorization to actually send the notification to the API consumer.
      If an API consumer requires the API producer to authorize for sending notifications to that API consumer, it shall
      include in the subscription request a data structure that defines the authorization requirements, as defined in
      Table 4.5.3.4-1.
357
    type: object
358
    required:
359
      - authType
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
    properties:
      authType:
        description: >
          Defines the types of Authentication
          Authorization the API consumer is willing to
          accept when receiving a notification.

          Permitted values:

          BASIC: In every HTTP request to the
          notification endpoint, use HTTP Basic
          authentication with the client credentials.

          OAUTH2_CLIENT_CREDENTIALS: In every
          HTTP request to the notification endpoint, use
          an OAuth 2.0 Bearer token, obtained using the
          client credentials grant type.
377

378
379
380
381
382
383
384
385
386
387
388
389
          TLS_CERT: Every HTTP request to the
          notification endpoint is sent over a mutually
          authenticated TLS session. i.e. not only server
          is authenticated, but also the client is
          authenticated during the TLS tunnel setup

        type: string
        enum:
          - BASIC
          - OAUTH2_CLIENT_CREDENTIALS
          - TLS_CERT
      paramsBasic:
390
        type: object
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
        description: >
          Parameters for authentication/authorization using BASIC.
          Shall be present if authType is "BASIC" and
          the contained information has not been
          provisioned out of band. Shall be absent otherwise.
        properties:
          userName:
            description: >
              Username to be used in HTTP Basic authentication.
              Shall be present if it has not been provisioned out of band.
            type: string
          password:
            description: >
              Password to be used in HTTP Basic authentication.
              Shall be present if it has not been provisioned out of band.
            type: string
      paramsOauth2ClientCredentials:
408
        type: object
409
410
411
412
        description: >
          Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.
          Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the
          contained information has not been provisioned out of band.
413
          Shall be absent otherwise.
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
        properties:
          clientId:
            description: >
              Client identifier to be used in the access token
              request of the OAuth 2.0 client credentials
              grant type. Shall be present if it has not been
              provisioned out of band.
            type: string
          clientPassword:
            description: >
              Client password to be used in the access
              token request of the OAuth 2.0 client
              credentials grant type. Shall be present if it
              has not been provisioned out of band.
            type: string
          tokenEndpoint:
            description: >
              The token endpoint from which the access
              token can be obtained. Shall be present if it
              has not been provisioned out of band.
            $ref: "SOL005_def.yaml#/definitions/Uri"

  NsdOperationalStateType:
437
    type: string
438
    description: >
439
      The enumeration NsdOperationalStateType shall comply with the provisions
440
441
442
      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.
443
      DISABLED = The operational state of the resource is disabled.
444
    enum:
445
446
447
      - ENABLED
      - DISABLED

448
  NsdOnboardingStateType:
449
    type: string
450
    description: >
451
      The enumeration NsdOnboardingStateType shall comply with the provisions
452
453
454
455
456
      defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding
      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.
457
      ONBOARDED = The associated NSD content is on-boarded.
458
    enum:
459
460
461
462
463
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDED

464
  NsdUsageStateType:
465
    type: string
466
    description: >
467
      The enumeration NsdUsageStateType shall comply with the provisions
468
469
      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
470
      is not-in-use.
471
    enum:
472
473
474
      - IN_USE
      - NOT_IN_USE

475
  CreateNsdInfoRequest:
476
    type: object
477
478
479
480
    properties:
      userDefinedData:
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
    description: >
481
482
      This type creates a completely new NS descriptor resource.

483
  PnfdInfoModifications:
484
    type: object
485
    required:
486
      - userDefinedData
487
488
489
490
    properties:
      userDefinedData:
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
    description: >
491
      This type represents attribute modifications for an individual PNF
492
493
      descriptor resource based on the "PnfdInfo" data type. The attributes of
      "PnfdInfo" that can be modified are included in the "PnfdInfoModifications"
494
      data type.
495

496
  PnfdInfo:
497
    type: object
498
    required:
499
500
501
502
      - id
      - pnfdOnboardingState
      - pnfdUsageState
      - _links
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
    properties:
      id:
        description: >
          Identifier of the on-boarded individual PNF
          descriptor resource. This identifier is allocated by
          the NFVO.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdId:
        description: >
          This identifier, which is managed by the PNFD
          designer, identifies the PNFD in a globally unique way.
          It is copied from the PNFD content and shall
          be present after the PNFD content is on-boarded.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdName:
        description: >
          Name of the on-boarded PNFD. This information
          is copied from the PNFD content and shall be
          present after the PNFD content is on-boarded.
522
        type: string
523
524
525
526
      pnfdersion:
        $ref: "SOL005_def.yaml#/definitions/Version"
      pnfdProvider:
        description: >
527
528
          Provider of the on-boarded PNFD. This information is copied from
          the PNFD content and shall be present after the PNFD content is on-boarded.
529
        type: string
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
      pnfdInvariantId:
        description: >
          Identifies a PNFD in a version independent
          manner. This attribute is invariant across versions
          of PNFD.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdOnboardingState:
        description: >
          On-boarding state of the individual PNF descriptor resource.
        $ref: "#/definitions/PnfdOnboardingStateType"
      onboardingFailureDetails:
        description: >
          Failure details of current on-boarding procedure.
          It shall be present when the
          pnfdOnboardingState attribute is CREATED
          and the uploading or processing fails in the NFVO.
        $ref: "SOL005_def.yaml#/definitions/ProblemDetails"
      pnfdUsageState:
        description: >
          Usage state of the individual PNF descriptor resource.
        $ref: "#/definitions/PnfdUsageStateType"
      userDefinedData:
        description: >
          User defined data for the individual PNF descriptor resource.
          This attribute can be modified with the PATCH method.
555
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
556
557
      _links:
        required:
558
559
560
          - pnfd_content
          - self
        type: object
561
        description: >
562
          Links to resources related to this resource.
563
564
565
566
567
568
        properties:
          self:
            $ref: "SOL005_def.yaml#/definitions/Link"
          pnfd_content:
            $ref: "SOL005_def.yaml#/definitions/Link"
    description: >
569
      This type represents a response for the query PNFD operation.
570

571
  PnfdOnboardingStateType:
572
    type: string
573
574
575
576
577
578
579
580
581
    description: >
      The enumeration PnfdOnboardingStateType shall comply with the provisions
      defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the on-boarding state
      of the individual PNF descriptor resource.
      CREATED = The PNF descriptor resource is created.
      UPLOADING = The associated PNFD content is being uploaded.
      PROCESSING = The associated PNFD content is being processed, e.g. validation.
      ONBOARDED = The associated PNFD content is on-boarded.
    enum:
582
583
584
585
586
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDING

587
  PnfdUsageStateType:
588
    type: string
589
    description: >
590
      The enumeration PnfdUsageStateType shall comply with the provisions
591
592
      defined in Table 5.5.4.7-1 of GS NFV-SOL005. It indicates the usage state
      of the resource.IN-USE = The resource is in use.NOT_IN_USE = The resource
593
      is not-in-use.
594
    enum:
595
596
597
      - IN_USE
      - NOT_IN_USE
      -
598
  CreatePnfdInfoRequest:
599
    type: object
600
601
602
603
604
605
606
    properties:
      userDefinedData:
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
    description: >
      User-defined data for the PNF descriptor resource to be created.
      It shall be present when the user defined data is set for
      the individual PNF descriptor resource to be created.
607

608
  NsdmLinks:
609
    type: object
610
    required:
611
612
      - nsdInfo
      - subscription
613
614
    properties:
      nsdInfo:
615
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
616
      subscription:
617
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
618
    description: >
619
620
621
      This type represents the links to resources that an NSD management
      notification can contain.

622
  PnfdmLinks:
623
    type: object
624
    required:
625
626
      - pnfdInfo
      - subscription
627
628
    properties:
      pnfdInfo:
629
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
630
      subscription:
631
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
632
    description: >
633
634
635
      This type represents the links to resources that a PNFD management
      notification can contain.

636
  NsdOnBoardingNotification:
637
    type: object
638
    required:
639
640
641
642
643
644
645
      - _links
      - id
      - notificationType
      - subscriptionId
      - nsdId
      - nsdInfoId
      - timeStamp
646
647
648
649
    properties:
      id:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      notificationType:
650
        type: string
651
        description: >
652
653
          Discriminator for the different notification types. Shall be
          set to "NsdOnboardingNotification" for this notification type.
654
655
656
657
658
659
660
661
662
663
664
665
666
      subscriptionId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      nsdInfoId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsdId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: >
667
      This type represents an NSD management notification, which informs
668
669
670
      the receiver of the successful on-boarding of an NSD. It shall comply with
      the provisions defined in Table 5.5.2.9-1. The support of this notification
      is mandatory. The notification shall be triggered by the NFVO when the "
671
672
      nsdOnboardingState" attribute of a new NSD has changed to "ONBOARDED".

673
  NsdOnBoardingFailureNotification:
674
    type: object
675
    required:
676
677
678
679
680
681
682
      - _links
      - id
      - notificationType
      - subscriptionId
      - nsdInfoId
      - onboardingFailureDetails
      - timeStamp
683
684
685
686
    properties:
      id:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      notificationType:
687
        type: string
688
        description: >
689
690
          Discriminator for the different notification types. Shall be
          set to "NsdOnboardingFailureNotification" for this notification type.
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
      subscriptionId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      nsdInfoId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsdId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      onboardingFailureDetails:
        $ref: "SOL005_def.yaml#/definitions/ProblemDetails"
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: >
706
      This type represents an NSD management notification, which informs
707
708
709
      the receiver of the failure of on-boarding an NSD. It shall comply with the
      provisions defined in Table 5.5.2.10-1. The support of this notification is
      mandatory. The notification shall be triggered by the NFVO when the on-boarding
710
711
      of an NSD has failed.

712
  NsdChangeNotification:
713
    type: object
714
    required:
715
716
717
718
719
720
721
722
      - _links
      - id
      - notificationType
      - subscriptionId
      - nsdId
      - nsdInfoId
      - nsdOperationalState
      - timeStamp
723
724
725
726
    properties:
      id:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      notificationType:
727
        type: string
728
        description: >
729
730
          Discriminator for the different notification types. Shall be
          set to "NsdChangeNotification" for this notification type.
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
      subscriptionId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      nsdInfoId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsdId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsdOperationalState:
        $ref: "#/definitions/NsdOperationalStateType"
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: >
746
      This type represents an NSD management notification, which informs
747
748
749
750
751
752
      the receiver of a change of the "nsdOperationalState" attribute of an on-boarded
      NSD. Changes in the value of the "nsdUsageState" and "nsdOnboardingState"
      attributes are not reported. The notification shall comply with the provisions
      defined in Table 5.5.2.11-1. The support of this notification is mandatory.
      The notification shall be triggered by the NFVO when the value of the "nsdOperationalState"
      attribute has changed, and the "nsdOperationalState" attribute has the value
753
754
      "ONBOARDED".

755
  NsdDeletionNotification:
756
    type: object
757
    required:
758
759
760
761
762
763
764
      - _links
      - id
      - notificationType
      - subscriptionId
      - nsdId
      - nsdInfoId
      - timeStamp
765
766
767
768
    properties:
      id:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      notificationType:
769
        type: string
770
        description: >
771
772
          Discriminator for the different notification types. Shall be
          set to "NsdDeletionNotification " for this notification type.
773
774
775
776
777
778
779
780
781
782
783
784
785
      subscriptionId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      nsdInfoId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsdId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: >
786
      This type represents an NSD management notification, which informs
787
788
789
      the receiver of the deletion of an on-boarded NSD. The notification shall
      comply with the provisions defined in Table 5.5.2.12-1. The support of this
      notification is mandatory. The notification shall be triggered by the NFVO
790
791
      when it has deleted an on-boarded NSD.

792
  PnfdOnBoardingNotification:
793
    type: object
794
    required:
795
796
797
798
799
800
801
      - _links
      - id
      - notificationType
      - subscriptionId
      - pnfdId
      - pnfdInfoId
      - timeStamp
802
803
804
805
    properties:
      id:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      notificationType:
806
        type: string
807
        description: >
808
809
          Discriminator for the different notification types. Shall be
          set to "PnfdOnboardingNotification" for this notification type.
810
811
812
813
814
815
816
817
818
819
820
821
822
      subscriptionId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      pnfdInfoId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      _links:
        $ref: "#/definitions/PnfdmLinks"
    description: >
823
      This type represents a PNFD management notification, which informs
824
825
      the receiver of the successful on-boarding of aPNFD. It shall comply with
      the provisions defined in Table 5.5.2.13-1. The support of this notification
826
827
      is mandatory. The notification is triggered when a new PNFD is on-boarded.

828
  PnfdOnBoardingFailureNotification:
829
    type: object
830
    required:
831
832
833
834
835
836
837
      - _links
      - id
      - notificationType
      - subscriptionId
      - onboardingFailureDetails
      - pnfdInfoId
      - timeStamp
838
839
840
841
    properties:
      id:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      notificationType:
842
        type: string
843
        description: >
844
845
          Discriminator for the different notification types. Shall be
          set to "PnfdOnboardingFailureNotification" for this notification type.
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
      subscriptionId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      pnfdInfoId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      onboardingFailureDetails:
        $ref: "SOL005_def.yaml#/definitions/ProblemDetails"
      _links:
        $ref: "#/definitions/PnfdmLinks"
    description: >
861
      This type represents a PNFD management notification, which informs
862
863
864
      the receiver of the failure of on-boarding a PNFD. It shall comply with
      the provisions defined in Table 5.5.2.14-1. The support of this notification
      is mandatory. The notification is triggered when the on-boarding of a PNFD
865
866
      fails.

867
  PnfdDeletionNotification:
868
    type: object
869
    required:
870
871
872
873
874
875
876
      - _links
      - id
      - notificationType
      - subscriptionId
      - pnfdId
      - pnfdInfoId
      - timeStamp
877
878
    properties:
      id:
879
        type: string
880
        description: >
881
          Identifier of this notification. If a notification is sent multiple
882
          times due to multiple subscriptions, the "id" attribute of all these
883
          notifications shall have the same value.
884
      notificationType:
885
        type: string
886
        description: >
887
888
          Discriminator for the different notification types. Shall be
          set to "PnfdDeletionNotification " for this notification type.
889
890
891
892
893
894
895
896
897
898
899
900
901
      subscriptionId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      pnfdInfoId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdId:
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      _links:
        $ref: "#/definitions/PnfdmLinks"
    description: >
902
      This type represents a PNFD management notification, which informs
903
904
905
      the receiver of the deletion of an on-boarded PNFD. The notification shall
      comply with the provisions defined in Table 5.5.2.15-1. The support of this
      notification is mandatory. The notification is triggered when an on-boarded
906
      PNFD is deleted.