3 title: Modeling etsicatalog API
4 description: "\n\nThe `swagger-ui` view can be found [here](/api/catalog/v1/swagger).\n\
5 The `ReDoc` view can be found [here](/api/catalog/v1/redoc).\nThe swagger YAML\
6 \ document can be found [here](/api/catalog/v1/swagger.yaml).\nThe swagger JSON\
7 \ document can be found [here](/api/catalog/v1/swagger.json)."
23 /api/catalog/v1/nspackages:
25 operationId: api_catalog_v1_nspackages_list
26 description: Query NS packages
34 $ref: '#/definitions/NsPackage'
38 $ref: '#/definitions/InternalErrorRequest'
42 operationId: api_catalog_v1_nspackages_create
43 description: On distribute NS package
49 $ref: '#/definitions/NsPackageDistributeRequest'
54 $ref: '#/definitions/NsPackageDistributeResponse'
58 $ref: '#/definitions/InternalErrorRequest'
62 /api/catalog/v1/nspackages/{csarId}:
64 operationId: api_catalog_v1_nspackages_read
65 description: Query one NS package
75 $ref: '#/definitions/NsPackage'
77 description: error message
83 operationId: api_catalog_v1_nspackages_delete
84 description: Delete one NS package
94 $ref: '#/definitions/NsPackageDistributeResponse'
96 description: error message
106 /api/catalog/v1/service_packages:
108 operationId: api_catalog_v1_service_packages_list
109 description: Query Service packages
117 $ref: '#/definitions/ServicePackage'
121 $ref: '#/definitions/InternalErrorRequest'
125 operationId: api_catalog_v1_service_packages_create
126 description: On distribute Service package
132 $ref: '#/definitions/ServicePackageDistributeRequest'
139 $ref: '#/definitions/InternalErrorRequest'
143 $ref: '#/definitions/InternalErrorRequest'
147 /api/catalog/v1/service_packages/{csarId}:
149 operationId: api_catalog_v1_service_packages_read
150 description: Query one Service package
160 $ref: '#/definitions/ServicePackage'
164 $ref: '#/definitions/InternalErrorRequest'
168 $ref: '#/definitions/InternalErrorRequest'
172 operationId: api_catalog_v1_service_packages_delete
173 description: Delete one Service package
185 $ref: '#/definitions/InternalErrorRequest'
189 $ref: '#/definitions/InternalErrorRequest'
197 /api/catalog/v1/vnfpackages:
199 operationId: api_catalog_v1_vnfpackages_list
200 description: Query Nf packages
208 $ref: '#/definitions/NfPackage'
212 $ref: '#/definitions/InternalErrorRequest'
216 operationId: api_catalog_v1_vnfpackages_create
217 description: On distribute Nf package
223 $ref: '#/definitions/NfPackageDistributeRequest'
228 $ref: '#/definitions/PostJobResponse'
232 $ref: '#/definitions/InternalErrorRequest'
236 /api/catalog/v1/vnfpackages/{csarId}:
238 operationId: api_catalog_v1_vnfpackages_read
239 description: Query one Nf package
249 $ref: '#/definitions/NfPackage'
251 description: error message
257 operationId: api_catalog_v1_vnfpackages_delete
258 description: Delete one Nf package
268 $ref: '#/definitions/PostJobResponse'
270 description: error message
280 /api/nsd/v1/health_check:
282 operationId: api_nsd_v1_health_check_list
289 - Health Check interface
291 /api/nsd/v1/ns_descriptors:
293 operationId: api_nsd_v1_ns_descriptors_list
294 description: Query multiple NSDs
302 $ref: '#/definitions/NsdInfo'
304 description: Internal error
306 - NSD Management interface
308 operationId: api_nsd_v1_ns_descriptors_create
309 description: Create a NSD
315 $ref: '#/definitions/CreateNsdInfoRequest'
320 $ref: '#/definitions/NsdInfo'
322 description: Internal error
324 - NSD Management interface
326 /api/nsd/v1/ns_descriptors/{nsdInfoId}:
328 operationId: api_nsd_v1_ns_descriptors_read
329 description: Query a NSD
335 $ref: '#/definitions/NsdInfo'
337 description: NSDs do not exist
339 description: Internal error
341 - NSD Management interface
343 operationId: api_nsd_v1_ns_descriptors_delete
344 description: Delete a NSD
348 description: No content
350 description: Internal error
352 - NSD Management interface
358 /api/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content:
360 operationId: api_nsd_v1_ns_descriptors_nsd_content_list
361 description: Download NSD content
365 description: No content
367 description: NSD does not exist.
369 description: Internal error
371 - NSD Management interface
373 operationId: api_nsd_v1_ns_descriptors_nsd_content_update
374 description: Upload NSD content
378 description: PNFD file
380 description: Internal error
382 - NSD Management interface
388 /api/nsd/v1/pnf_descriptors:
390 operationId: api_nsd_v1_pnf_descriptors_list
391 description: Query multiple PNFDs
399 $ref: '#/definitions/PnfdInfo'
403 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
405 - NSD Management interface
407 operationId: api_nsd_v1_pnf_descriptors_create
408 description: Create a PNFD
414 $ref: '#/definitions/CreatePnfdInfoRequest'
419 $ref: '#/definitions/PnfdInfo'
423 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
425 - NSD Management interface
427 /api/nsd/v1/pnf_descriptors/{pnfdInfoId}:
429 operationId: api_nsd_v1_pnf_descriptors_read
430 description: Query a PNFD
436 $ref: '#/definitions/PnfdInfo'
440 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
444 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
446 - NSD Management interface
448 operationId: api_nsd_v1_pnf_descriptors_delete
449 description: Delete a PNFD
453 description: No content
457 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
459 - NSD Management interface
465 /api/nsd/v1/pnf_descriptors/{pnfdInfoId}/pnfd_content:
467 operationId: Fetch PNFD content
468 description: Fetch PNFD content
472 description: PNFD file
479 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
483 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
485 - application/octet-stream
488 - NSD Management interface
490 operationId: api_nsd_v1_pnf_descriptors_pnfd_content_update
491 description: Upload PNFD content
495 description: No content
499 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
501 - NSD Management interface
507 /api/nsd/v1/subscriptions:
509 operationId: api_nsd_v1_subscriptions_list
510 description: Query subscriptions for Nsd Management
518 $ref: '#/definitions/NsdmSubscription'
522 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
526 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
530 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
532 - NSD Management interface
534 operationId: api_nsd_v1_subscriptions_create
535 description: Create Subscription for NSD Management
541 $ref: '#/definitions/NsdmSubscriptionRequest'
546 $ref: '#/definitions/NsdmSubscription'
550 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
554 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
558 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
560 - NSD Management interface
562 /api/nsd/v1/subscriptions/{subscriptionId}:
564 operationId: api_nsd_v1_subscriptions_read
565 description: Query subscriptions for Nsd Management
571 $ref: '#/definitions/NsdmSubscription'
575 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
579 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
583 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
585 - NSD Management interface
587 operationId: api_nsd_v1_subscriptions_delete
588 description: Delete subscription for Nsd Management
592 description: No_Content
596 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
600 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
604 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
606 - NSD Management interface
608 - name: subscriptionId
612 /api/vnfpkgm/v1/health_check:
614 operationId: api_vnfpkgm_v1_health_check_list
621 - Health Check interface
623 /api/vnfpkgm/v1/subscriptions:
625 operationId: api_vnfpkgm_v1_subscriptions_list
632 $ref: '#/definitions/PkgmSubscription'
636 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
640 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
642 - VNF Package Management interface
644 operationId: api_vnfpkgm_v1_subscriptions_create
651 $ref: '#/definitions/PkgmSubscriptionRequest'
656 $ref: '#/definitions/PkgmSubscription'
660 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
664 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
666 - VNF Package Management interface
668 /api/vnfpkgm/v1/subscriptions/{subscriptionId}:
670 operationId: api_vnfpkgm_v1_subscriptions_read
677 $ref: '#/definitions/PkgmSubscription'
681 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
685 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
687 - VNF Package Management interface
689 operationId: api_vnfpkgm_v1_subscriptions_delete
698 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
702 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
704 - VNF Package Management interface
706 - name: subscriptionId
710 /api/vnfpkgm/v1/vnf_packages:
712 operationId: api_vnfpkgm_v1_vnf_packages_list
713 description: Query multiple VNF package resource
721 $ref: '#/definitions/VnfPkgInfo'
723 description: Internal error
727 - VNF Package Management interface
729 operationId: api_vnfpkgm_v1_vnf_packages_create
730 description: Create an individual VNF package resource
736 $ref: '#/definitions/CreateVnfPkgInfoRequest'
741 $ref: '#/definitions/VnfPkgInfo'
743 description: Bad Request
747 description: Internal error
751 - VNF Package Management interface
753 /api/vnfpkgm/v1/vnf_packages/{vnfPkgId}:
755 operationId: api_vnfpkgm_v1_vnf_packages_read
756 description: Query an individual VNF package resource
762 $ref: '#/definitions/VnfPkgInfo'
764 description: VNF package does not exist
768 description: Internal error
772 - VNF Package Management interface
774 operationId: api_vnfpkgm_v1_vnf_packages_delete
775 description: Delete an individual VNF package resource
779 description: No content
781 description: Internal error
785 - VNF Package Management interface
791 /api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}:
793 operationId: api_vnfpkgm_v1_vnf_packages_artifacts_read
798 description: Return the artifact file
803 description: Artifact not found
807 description: Internal error
811 - application/octet-stream
814 - VNF Package Management interface
824 /api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content:
826 operationId: api_vnfpkgm_v1_vnf_packages_package_content_list
827 description: Fetch VNF package content
831 description: VNF package file
836 description: VNF package does not exist
840 description: Internal error
844 - application/octet-stream
847 - VNF Package Management interface
849 operationId: api_vnfpkgm_v1_vnf_packages_package_content_update
850 description: Upload VNF package content
854 description: Successfully
856 description: Internal error
860 - VNF Package Management interface
866 /api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content/upload_from_uri:
868 operationId: api_vnfpkgm_v1_vnf_packages_package_content_upload_from_uri_create
869 description: Upload VNF package content from uri
875 $ref: '#/definitions/UploadVnfPackageFromUriRequest'
878 description: Successfully
880 description: Bad Request
884 description: Internal error
888 - VNF Package Management interface
894 /api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd:
896 operationId: VNFD of an on-boarded VNF package
897 description: Read VNFD of an on-boarded VNF package
901 description: VNFD of an on-boarded VNF package
906 description: VNF package does not exist
910 description: Internal error
914 - application/octet-stream
917 - VNF Package Management interface
923 /api/parser/v1/health_check:
925 operationId: api_parser_v1_health_check_list
932 - Health Check interface
934 /api/parser/v1/parser:
936 operationId: api_parser_v1_parser_create
937 description: Parse model(NS, Service, VNF, PNF)
943 $ref: '#/definitions/ParseModelRequest'
948 $ref: '#/definitions/ParseModelResponse'
952 $ref: '#/definitions/InternalErrorRequest'
956 /api/parser/v1/parsernsd:
958 operationId: api_parser_v1_parsernsd_create
959 description: Parse NS model
965 $ref: '#/definitions/ParseModelRequest'
970 $ref: '#/definitions/ParseModelResponse'
974 $ref: '#/definitions/InternalErrorRequest'
978 /api/parser/v1/parserpnfd:
980 operationId: api_parser_v1_parserpnfd_create
981 description: Parse PNF model
987 $ref: '#/definitions/ParseModelRequest'
992 $ref: '#/definitions/ParseModelResponse'
996 $ref: '#/definitions/InternalErrorRequest'
1000 /api/parser/v1/parservnfd:
1002 operationId: api_parser_v1_parservnfd_create
1003 description: Parse NF model
1009 $ref: '#/definitions/ParseModelRequest'
1014 $ref: '#/definitions/ParseModelResponse'
1018 $ref: '#/definitions/InternalErrorRequest'
1022 /api/catalog/v1/callback_sample:
1024 operationId: api_catalog_v1_callback_sample_list
1025 description: Callback Sample.
1033 /api/catalog/v1/health_check:
1035 operationId: api_catalog_v1_health_check_list
1042 - Health Check interface
1044 /api/catalog/v1/jobs/{job_id}:
1046 operationId: api_catalog_v1_jobs_read
1047 description: Get job status
1055 description: response id
1061 $ref: '#/definitions/GetJobResponse'
1065 $ref: '#/definitions/PostJobResponseResult'
1069 operationId: api_catalog_v1_jobs_create
1070 description: Update job status
1076 $ref: '#/definitions/PostJobRequest'
1085 $ref: '#/definitions/PostJobResponseResult'
1089 $ref: '#/definitions/PostJobResponseResult'
1097 /api/catalog/v1/mandb/{modelName}:
1099 operationId: api_catalog_v1_mandb_read
1108 operationId: api_catalog_v1_mandb_delete
1123 operationId: samples_list
1124 description: List all samples.
1133 NOTIFICATION_LINKSERIALIZER:
1135 description: Link to the resource representing the VNF package to which the notified
1143 description: URI of the referenced resource.
1148 description: Links to resources related to this resource.
1152 $ref: '#/definitions/NOTIFICATION_LINKSERIALIZER'
1154 $ref: '#/definitions/NOTIFICATION_LINKSERIALIZER'
1155 PkgChangeNotification:
1169 description: Identifier of this notification.
1173 title: Notificationtype
1174 description: Discriminator for the different notification types.
1177 - VnfPackageChangeNotification
1180 description: Date-time of the generation of the notification.
1184 title: Subscriptionid
1185 description: Identifier of the subscription that this notification relates
1191 description: Identifier of the VNF package.
1196 description: The type of change of the VNF package.
1202 title: Operationalstate
1203 description: New operational state of the VNF package.
1210 description: This identifier, which is managed by the VNF provider, identifies
1211 the VNF package and the VNFD in a globally unique way.
1215 $ref: '#/definitions/PkgmLinks'
1216 PkgOnboardingNotification:
1229 description: Identifier of this notification.
1233 title: Notificationtype
1234 description: Discriminator for the different notification types.
1237 - VnfPackageOnboardingNotification
1239 title: Subscriptionid
1240 description: Identifier of the subscription that this notification relates
1246 description: Date-time of the generation of the notification.
1251 description: Identifier of the VNF package.
1256 description: This identifier, which is managed by the VNF provider, identifies
1257 the VNF package and the VNFD in a globally unique way.
1261 $ref: '#/definitions/PkgmLinks'
1262 JobResponseHistoryList:
1263 description: Response History List
1273 description: Job Progress
1277 title: Statusdescription
1278 description: Status Description
1283 description: Error Code
1289 description: Response Id
1292 JobResponseDescriptor:
1293 title: Responsedescriptor
1294 description: Job Response Descriptor
1304 description: Job Progress
1308 title: Statusdescription
1309 description: Status Description
1314 description: Error Code
1320 description: Response Id
1323 responseHistoryList:
1324 description: Response History List
1327 $ref: '#/definitions/JobResponseHistoryList'
1337 $ref: '#/definitions/JobResponseDescriptor'
1338 PostJobResponseResult:
1350 description: Message
1358 description: Job Progress
1363 description: Description
1368 description: Error Code
1373 description: NS Package Info
1384 description: NS Package ID
1389 description: NSD Provider
1394 description: NSD Version
1399 description: CSAR name
1404 description: NSD Model
1409 description: URL to download NSD Model
1419 description: CSAR ID
1424 $ref: '#/definitions/NsPackageInfo'
1425 InternalErrorRequest:
1437 description: Error Message
1440 NsPackageDistributeRequest:
1450 NsPackageDistributeResponse:
1463 title: Statusdescription
1464 description: statusDescription
1469 description: errorCode
1474 description: Service Package Info
1479 description: ServiceD ID
1484 title: Servicepackageid
1485 description: Service Package ID
1489 title: Servicedprovider
1490 description: ServiceD Provider
1494 title: Servicedversion
1495 description: ServiceD Version
1500 description: CSAR name
1504 title: Servicedmodel
1505 description: ServiceD Model
1510 description: URL to download ServiceD Model
1520 description: CSAR ID
1525 $ref: '#/definitions/ServicePackageInfo'
1526 ServicePackageDistributeRequest:
1538 description: VNF Package Info
1545 description: VNFD ID
1550 description: VNF Package ID
1555 description: VNFD Provider
1560 description: VNFD Version
1565 description: VNF Version
1570 description: CSAR Name
1575 description: VNFD Model
1580 description: URL to download VNFD Model
1584 description: Image Info
1597 description: Index of VNF Image
1602 description: Image file name
1607 description: Image ID
1617 description: User of VIM
1638 description: CSAR ID
1642 $ref: '#/definitions/NfPackageInfo'
1644 description: Image Info
1647 $ref: '#/definitions/NfImageInfo'
1649 NfPackageDistributeRequest:
1656 description: CSAR ID
1660 description: A string for vimIds
1667 description: A list of VIM IDs.
1680 title: Onboardingfailuredetails
1681 description: Failure details of current onboarding procedure.It shall be present
1682 when the nsdOnboardingState attribute is CREATED and the uploading or processing
1691 description: A URI reference according to IETF RFC 3986 [10] that identifies
1692 the problem type. It is encouraged that the URI provides human-readable
1693 documentation for the problem (e.g. using HTML) when dereferenced. When
1694 this member is not present, its value is assumed to be "about:blank".
1699 description: The HTTP status code for this occurrence of the problem.
1703 description: A human-readable explanation specific to this occurrence of the
1709 description: A URI reference that identifies the specific occurrence of the
1710 problem. It may yield further information if dereferenced.
1713 additional_attributes:
1714 title: Additional attributes
1715 description: Any number of additional attributes, as defined in a specification
1716 or by an implementation.
1718 additionalProperties:
1719 description: Additional attribute
1724 description: URI of this resource.
1731 description: URI of the referenced resource
1736 description: Links to resources related to this resource.
1743 $ref: '#/definitions/UriLink'
1745 $ref: '#/definitions/UriLink'
1749 - nsdOnboardingState
1750 - nsdOperationalState
1757 description: Identifier of the onboarded individual NS descriptor resource.This
1758 identifier is allocated by the NFVO.
1763 description: This identifier, which is allocated by the NSD designer,identifies
1764 the NSD in a globally unique way.It is copied from the NSD content and shall
1765 be present after the NSD content is on-boarded.
1770 description: Name of the onboarded NSD.This information is copied from the
1771 NSD content and shall be present after the NSD content is on-boarded.
1776 description: Version of the on-boarded NSD.This information is copied from
1777 the NSD content and shall be present after the NSD content is on-boarded.
1782 description: Designer of the on-boarded NSD.This information is copied from
1783 the NSD content and shall be present after the NSD content is on-boarded.
1787 title: Nsdinvariantid
1788 description: This identifier, which is allocated by the NSD designer,identifies
1789 an NSD in a version independent manner.This information is copied from the
1790 NSD content and shall be present after the NSD content is on-boarded.
1794 description: Identifies the VNF package for the VNFD referenced by the on-boarded
1795 NS descriptor resource.
1798 description: Identifier of the VNF package
1802 description: Identifies the PnfdInfo element for the PNFD referenced by the
1803 on-boarded NS descriptor resource.
1806 description: Identifier of the PnfdInfo element
1810 description: Identifies the NsdInfo element for the nested NSD referenced
1811 by the on-boarded NS descriptor resource.
1814 description: Identifier of the NsdInfo element
1818 title: Nsdonboardingstate
1819 description: Onboarding state of the individual NS descriptor resource.
1826 onboardingFailureDetails:
1827 $ref: '#/definitions/ProblemDetails'
1828 nsdOperationalState:
1829 title: Nsdoperationalstate
1830 description: Operational state of the individual NS descriptor resource.This
1831 attribute can be modified with the PATCH method.
1837 title: Nsdusagestate
1838 description: Usage state of the individual NS descriptor resource.
1844 title: Userdefineddata
1845 description: User defined data for the individual NS descriptor resource.This
1846 attribute can be modified with the PATCH method.
1848 additionalProperties:
1849 description: Key Value Pairs
1853 $ref: '#/definitions/NSD_LinkSerializer'
1854 CreateNsdInfoRequest:
1858 title: Userdefineddata
1859 description: User-defined data for the NS descriptor resource to be created.It
1860 shall be present when the user defined data is set for the individual NS
1861 descriptor resource to be created.
1863 additionalProperties:
1864 description: Key Value Pairs
1867 PNFD_LinkSerializer:
1869 description: Links to resources related to this resource.
1876 $ref: '#/definitions/UriLink'
1878 $ref: '#/definitions/UriLink'
1882 - pnfdOnboardingState
1889 description: Identifier of the onboarded individual PNF descriptor resource. This
1890 identifier is allocated by the NFVO.
1895 description: This identifier, which is allocated by the PNFD designer, identifies
1896 the PNFD in a globally unique way. It is copied from the PNFD content
1897 and shall be present after the PNFD content is on-boarded.
1902 description: Name of the onboarded PNFD. This information is copied
1903 from the PNFD content and shall be present after the PNFD content is on-boarded.
1908 description: Version of the on-boarded PNFD. This information is copied
1909 from the PNFD content and shall be present after the PNFD content is on-boarded.
1914 description: Provider of the on-boarded PNFD. This information is
1915 copied from the PNFD content and shall be present after the PNFD content
1920 title: Pnfdinvariantid
1921 description: Identifies a PNFD in a version independent manner. This
1922 attribute is invariant across versions of PNFD.
1925 pnfdOnboardingState:
1926 title: Pnfdonboardingstate
1927 description: Onboarding state of the individual PNF descriptor resource.
1934 onboardingFailureDetails:
1935 $ref: '#/definitions/ProblemDetails'
1937 title: Pnfdusagestate
1938 description: Usage state of the individual PNF descriptor resource.
1944 title: Userdefineddata
1945 description: User defined data for the individual PNF descriptor resource. This
1946 attribute can be modified with the PATCH method.
1948 additionalProperties:
1949 description: Key Value Pairs
1953 $ref: '#/definitions/PNFD_LinkSerializer'
1954 SUBSCRIPTION_ProblemDetailsSerializer:
1983 description: Instance
1988 description: Any number of additional attributes, as defined in a specification
1989 or by an implementation.
1994 CreatePnfdInfoRequest:
1998 title: Userdefineddata
1999 description: User-defined data for the PNF descriptor resource to be created.It
2000 shall be present when the user defined data is set for the individual PNF
2001 descriptor resource to be created.
2003 additionalProperties:
2004 description: Key Value Pairs
2007 NsdmNotificationsFilter:
2009 description: Filter settings for this subscription, to define the of all notifications
2010 this subscription relates to.
2014 description: Match particular notification types
2019 - NsdOnBoardingNotification
2020 - NsdOnboardingFailureNotification
2021 - NsdChangeNotification
2022 - NsdDeletionNotification
2023 - PnfdOnBoardingNotification
2024 - PnfdOnBoardingFailureNotification
2025 - PnfdDeletionNotification
2027 description: Match NS packages with particular nsdInfoIds
2033 description: Match NS Packages with particular nsdIds
2039 description: Match NS Packages with particular nsdNames
2046 description: match NS packages that belong to certain nsdversion
2053 description: Match NS Packages with particular nsdInvariantIds
2059 description: Match NS Packages that has VNF PackageIds
2065 description: Match NS Packages with particular nsdInvariantIds
2071 description: Match NS Packages with particular NS Onboarding State
2080 nsdOperationalState:
2081 description: Match NS Packages with particular NS Operational State
2089 description: Match NS Packages with particular NS Usage State
2097 description: Match PF packages with particular pnfdInfoIds
2103 description: Match PF packages with particular pnfdInfoIds
2109 description: Match PF Packages with particular pnfdNames
2116 description: match PF packages that belong to certain pnfd version
2123 description: Match PF Packages with particular pnfdProvider
2130 description: Match PF Packages with particular pnfdInvariantIds
2135 pnfdOnboardingState:
2136 description: 'Match PF Packages with particular PNF Onboarding State '
2146 description: Match PF Packages with particular PNF usage State
2153 NSDM_SUB_LinkSerializer:
2155 description: Links to resources related to this resource.
2161 $ref: '#/definitions/UriLink'
2171 description: Identifier of this subscription resource.
2177 description: The URI of the endpoint to send the notification to.
2182 $ref: '#/definitions/NsdmNotificationsFilter'
2184 $ref: '#/definitions/NSDM_SUB_LinkSerializer'
2187 description: Parameters for authentication/authorization using BASIC.
2192 description: Username to be used in HTTP Basic authentication.
2198 description: Password to be used in HTTP Basic authentication.
2203 title: Paramsoauth2clientcredentials
2204 description: Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.
2209 description: Client identifier to be used in the access token request of the
2210 OAuth 2.0 client credentials grant type.
2215 title: Clientpassword
2216 description: Client password to be used in the access token request of the
2217 OAuth 2.0 client credentials grant type.
2222 title: Tokenendpoint
2223 description: The token endpoint from which the access token can be obtained.
2227 SubscriptionAuthentication:
2228 title: Authentication
2229 description: Authentication parameters to configure the use of Authorization when
2230 sending notifications corresponding to this subscription.
2236 description: Defines the types of Authentication / Authorization which the
2237 API consumer is willing to accept when receiving a notification.
2243 - OAUTH2_CLIENT_CREDENTIALS
2246 $ref: '#/definitions/BasicAuth'
2247 paramsOauth2ClientCredentials:
2248 $ref: '#/definitions/OAuthCredentials'
2249 NsdmSubscriptionRequest:
2256 description: The URI of the endpoint to send the notification to.
2260 $ref: '#/definitions/NsdmNotificationsFilter'
2262 $ref: '#/definitions/SubscriptionAuthentication'
2270 description: CSAR ID
2275 description: 'Package type: VNF, PNF, NS, Service'
2291 VNF_SUBSCRIPTION_LINKSERIALIZER:
2293 description: URI of this resource.
2300 description: URI of the referenced resource.
2305 description: Links to resources related to this resource.
2311 $ref: '#/definitions/VNF_SUBSCRIPTION_LINKSERIALIZER'
2314 description: match VNF packages that contain VNF products with certain versions
2316 - vnfSoftwareVersion
2320 title: Vnfsoftwareversion
2321 description: VNF software version to match.
2326 description: Match VNF packages that contain VNF products with certain VNFD
2334 description: match VNF packages that contain VNF products with certain product
2335 names, from one particular provider
2341 title: Vnfproductname
2342 description: Name of the VNF product to match.
2347 $ref: '#/definitions/Version'
2348 vnfProductsProviders:
2355 description: Name of the VNFprovider to match.
2360 $ref: '#/definitions/vnfProducts'
2361 PkgmNotificationsFilter:
2363 description: Filter settings for this subscription, to define the subset of all
2364 notifications this subscription relates to
2368 description: Match particular notification types
2373 - VnfPackageOnboardingNotification
2374 - VnfPackageChangeNotification
2375 vnfProductsFromProviders:
2376 description: Match VNF packages that contain VNF products from certain providers.
2379 $ref: '#/definitions/vnfProductsProviders'
2381 description: Match VNF packages with a VNFD identifierlisted in the attribute
2387 description: Match VNF packages with a VNFD identifierlisted in the attribute
2393 description: Operational state of the VNF package.
2401 description: Operational state of the VNF package.
2417 description: Identifier of this subscription resource.
2422 description: The URI of the endpoint to send the notification to.
2427 $ref: '#/definitions/LinkSelf'
2429 $ref: '#/definitions/PkgmNotificationsFilter'
2430 PkgmSubscriptionRequest:
2436 $ref: '#/definitions/PkgmNotificationsFilter'
2439 description: Callback URI to sendthe notification
2444 $ref: '#/definitions/SubscriptionAuthentication'
2447 description: Checksum of the on-boarded VNF package.
2455 description: Name of the algorithm used to generate the checksum.
2460 description: The hexadecimal value of the checksum.
2463 VnfPackageSoftwareImageInfo:
2464 description: Information about VNF package artifacts that are software images.
2482 description: Identifier of the software image.
2487 description: Name of the software image.
2492 description: Provider of the software image.
2497 description: Version of the software image.
2501 $ref: '#/definitions/Checksum'
2503 title: Containerformat
2504 description: 'terminationType: Indicates whether forceful or graceful termination
2517 description: Disk format of a software image is the format of the underlying
2533 description: Time when this software image was created.
2538 description: The minimal disk for this software image in bytes.
2542 description: The minimal RAM for this software image in bytes.
2546 description: Size of this software image in bytes.
2550 description: User-defined data.
2552 additionalProperties:
2553 description: KeyValue Pairs
2558 description: Path in the VNF package.
2561 VnfPackageArtifactInfo:
2562 description: Information about VNF package artifacts contained in the VNF package
2563 that are not software images.
2571 description: Path in the VNF package.
2575 $ref: '#/definitions/Checksum'
2578 description: The metadata of the artifact that are available in the VNF package
2580 additionalProperties:
2581 description: KeyValue Pairs
2584 VNF_PKGM_Link_Serializer:
2586 description: Links to resources related to this resource.
2593 $ref: '#/definitions/UriLink'
2595 $ref: '#/definitions/UriLink'
2597 $ref: '#/definitions/UriLink'
2609 description: Identifier of the on-boarded VNF package.
2614 description: This identifier, which is managed by the VNF provider, identifies
2615 the VNF package and the VNFD in a globally unique way.
2620 description: Provider of the VNF package and the VNFD.
2624 title: Vnfproductname
2625 description: Name to identify the VNF product.
2629 title: Vnfsoftwareversion
2630 description: Software version of the VNF.
2635 description: The version of the VNvFD.
2639 $ref: '#/definitions/Checksum'
2641 description: Information about VNF package artifacts that are software images.
2644 $ref: '#/definitions/VnfPackageSoftwareImageInfo'
2646 additionalArtifacts:
2647 description: Information about VNF package artifacts contained in the VNF
2648 package that are not software images.
2651 $ref: '#/definitions/VnfPackageArtifactInfo'
2654 title: Onboardingstate
2655 description: On-boarding state of the VNF package.
2663 title: Operationalstate
2664 description: Operational state of the VNF package.
2671 description: Usage state of the VNF package.
2677 title: Userdefineddata
2678 description: User defined data for the VNF package.
2680 additionalProperties:
2681 description: KeyValue Pairs
2685 $ref: '#/definitions/VNF_PKGM_Link_Serializer'
2686 CreateVnfPkgInfoRequest:
2690 title: Userdefineddata
2691 description: User defined data for the VNF package.
2693 additionalProperties:
2694 description: KeyValue Pairs
2697 UploadVnfPackageFromUriRequest:
2699 - addressInformation
2703 title: Addressinformation
2704 description: Address information of the VNF package content.
2709 description: User name to be used for authentication.
2714 description: Password to be used for authentication.