3 title: Parser as Microservice API
4 description: "Parser Microservice API"
20 /api/parser/v1/health_check:
22 operationId: api_parser_v1_health_check_list
31 /api/parser/v1/parser:
33 operationId: api_parser_v1_parser_create
34 description: 'Parse model(NS, Service, VNF, PNF)'
40 $ref: '#/definitions/ParseModelRequest'
45 $ref: '#/definitions/ParseModelResponse'
49 $ref: '#/definitions/InternalErrorRequest'
53 /api/parser/v1/parsernsd:
55 operationId: api_parser_v1_parsernsd_create
56 description: Parse NS model
62 $ref: '#/definitions/ParseModelRequest'
67 $ref: '#/definitions/ParseModelResponse'
71 $ref: '#/definitions/InternalErrorRequest'
75 /api/parser/v1/parserpnfd:
77 operationId: api_parser_v1_parserpnfd_create
78 description: Parse PNF model
84 $ref: '#/definitions/ParseModelRequest'
89 $ref: '#/definitions/ParseModelResponse'
93 $ref: '#/definitions/InternalErrorRequest'
97 /api/parser/v1/parservnfd:
99 operationId: api_parser_v1_parservnfd_create
100 description: Parse NF model
106 $ref: '#/definitions/ParseModelRequest'
111 $ref: '#/definitions/ParseModelResponse'
115 $ref: '#/definitions/InternalErrorRequest'
119 /api/parser/v1/service_packages:
121 operationId: api_parser_v1_service_packages_list
122 description: Query Service packages
130 $ref: '#/definitions/ServicePackage'
134 $ref: '#/definitions/InternalErrorRequest'
138 operationId: api_parser_v1_service_packages_create
139 description: On distribute Service package
145 $ref: '#/definitions/ServicePackageDistributeRequest'
152 $ref: '#/definitions/InternalErrorRequest'
156 $ref: '#/definitions/InternalErrorRequest'
160 '/api/parser/v1/service_packages/{csarId}':
162 operationId: api_parser_v1_service_packages_read
163 description: Query one Service package
173 $ref: '#/definitions/ServicePackage'
177 $ref: '#/definitions/InternalErrorRequest'
181 $ref: '#/definitions/InternalErrorRequest'
185 operationId: api_parser_v1_service_packages_delete
186 description: Delete one Service package
198 $ref: '#/definitions/InternalErrorRequest'
202 $ref: '#/definitions/InternalErrorRequest'
210 /api/catalog/v1/health_check:
212 operationId: api_catalog_v1_health_check_list
221 '/api/catalog/v1/jobs/{job_id}':
223 operationId: api_catalog_v1_jobs_read
224 description: Get job status
232 description: response id
238 $ref: '#/definitions/GetJobResponse'
242 $ref: '#/definitions/PostJobResponseResult'
246 operationId: api_catalog_v1_jobs_create
247 description: Update job status
253 $ref: '#/definitions/PostJobRequest'
262 $ref: '#/definitions/PostJobResponseResult'
266 $ref: '#/definitions/PostJobResponseResult'
274 '/api/catalog/v1/mandb/{modelName}':
276 operationId: api_catalog_v1_mandb_read
285 operationId: api_catalog_v1_mandb_delete
298 /api/catalog/v1/nspackages:
300 operationId: api_catalog_v1_nspackages_list
301 description: Query NS packages
309 $ref: '#/definitions/NsPackage'
313 $ref: '#/definitions/InternalErrorRequest'
317 operationId: api_catalog_v1_nspackages_create
318 description: On distribute NS package
324 $ref: '#/definitions/NsPackageDistributeRequest'
329 $ref: '#/definitions/NsPackageDistributeResponse'
333 $ref: '#/definitions/InternalErrorRequest'
337 '/api/catalog/v1/nspackages/{csarId}':
339 operationId: api_catalog_v1_nspackages_read
340 description: Query one NS package
350 $ref: '#/definitions/NsPackage'
352 description: error message
358 operationId: api_catalog_v1_nspackages_delete
359 description: Delete one NS package
369 $ref: '#/definitions/NsPackageDistributeResponse'
371 description: error message
381 /api/catalog/v1/parsernsd:
383 operationId: api_catalog_v1_parsernsd_create
384 description: Parse NS model
390 $ref: '#/definitions/ParseModelRequest'
395 $ref: '#/definitions/ParseModelResponse'
399 $ref: '#/definitions/InternalErrorRequest'
403 /api/catalog/v1/parserpnfd:
405 operationId: api_catalog_v1_parserpnfd_create
406 description: Parse PNF model
412 $ref: '#/definitions/ParseModelRequest'
417 $ref: '#/definitions/ParseModelResponse'
421 $ref: '#/definitions/InternalErrorRequest'
425 /api/catalog/v1/parservnfd:
427 operationId: api_catalog_v1_parservnfd_create
428 description: Parse NF model
434 $ref: '#/definitions/ParseModelRequest'
439 $ref: '#/definitions/ParseModelResponse'
443 $ref: '#/definitions/InternalErrorRequest'
447 /api/catalog/v1/vnfpackages:
449 operationId: api_catalog_v1_vnfpackages_list
450 description: Query Nf packages
458 $ref: '#/definitions/NfPackage'
462 $ref: '#/definitions/InternalErrorRequest'
466 operationId: api_catalog_v1_vnfpackages_create
467 description: On distribute Nf package
473 $ref: '#/definitions/NfPackageDistributeRequest'
478 $ref: '#/definitions/PostJobResponse'
482 $ref: '#/definitions/InternalErrorRequest'
486 '/api/catalog/v1/vnfpackages/{csarId}':
488 operationId: api_catalog_v1_vnfpackages_read
489 description: Query one Nf package
499 $ref: '#/definitions/NfPackage'
501 description: error message
507 operationId: api_catalog_v1_vnfpackages_delete
508 description: Delete one Nf package
518 $ref: '#/definitions/PostJobResponse'
520 description: error message
530 /api/nsd/v1/health_check:
532 operationId: api_nsd_v1_health_check_list
541 /api/nsd/v1/ns_descriptors:
543 operationId: api_nsd_v1_ns_descriptors_list
544 description: Query multiple NSDs
552 $ref: '#/definitions/NsdInfo'
554 description: Internal error
558 operationId: api_nsd_v1_ns_descriptors_create
559 description: Create a NSD
565 $ref: '#/definitions/CreateNsdInfoRequest'
570 $ref: '#/definitions/NsdInfo'
572 description: Internal error
576 '/api/nsd/v1/ns_descriptors/{nsdInfoId}':
578 operationId: api_nsd_v1_ns_descriptors_read
579 description: Query a NSD
585 $ref: '#/definitions/NsdInfo'
587 description: NSDs do not exist
589 description: Internal error
593 operationId: api_nsd_v1_ns_descriptors_delete
594 description: Delete a NSD
598 description: No content
600 description: Internal error
608 '/api/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content':
610 operationId: api_nsd_v1_ns_descriptors_nsd_content_list
611 description: Download NSD content
615 description: No content
617 description: NSD does not exist.
619 description: Internal error
623 operationId: api_nsd_v1_ns_descriptors_nsd_content_update
624 description: Upload NSD content
628 description: PNFD file
630 description: Internal error
638 /api/nsd/v1/pnf_descriptors:
640 operationId: api_nsd_v1_pnf_descriptors_list
641 description: Query multiple PNFDs
649 $ref: '#/definitions/PnfdInfo'
651 description: Internal error
655 operationId: api_nsd_v1_pnf_descriptors_create
656 description: Create a PNFD
662 $ref: '#/definitions/CreatePnfdInfoRequest'
667 $ref: '#/definitions/PnfdInfo'
669 description: Internal error
673 '/api/nsd/v1/pnf_descriptors/{pnfdInfoId}':
675 operationId: api_nsd_v1_pnf_descriptors_read
676 description: Query a PNFD
682 $ref: '#/definitions/PnfdInfo'
684 description: PNFD does not exist
686 description: Internal error
690 operationId: api_nsd_v1_pnf_descriptors_delete
691 description: Delete a PNFD
695 description: No content
697 description: Internal error
705 '/api/nsd/v1/pnf_descriptors/{pnfdInfoId}/pnfd_content':
707 operationId: api_nsd_v1_pnf_descriptors_pnfd_content_list
708 description: Fetch PNFD content
712 description: PNFD file
714 description: PNFD does not exist
716 description: Internal error
720 operationId: api_nsd_v1_pnf_descriptors_pnfd_content_update
721 description: Upload PNFD content
725 description: No content
727 description: Internal error
735 /api/nsd/v1/subscriptions:
737 operationId: api_nsd_v1_subscriptions_list
738 description: Query subscriptions for Nsd Management
746 $ref: '#/definitions/NsdmSubscription'
750 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
754 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
758 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
762 operationId: api_nsd_v1_subscriptions_create
763 description: Create Subscription for NSD Management
769 $ref: '#/definitions/NsdmSubscriptionRequest'
774 $ref: '#/definitions/NsdmSubscription'
778 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
782 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
786 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
790 '/api/nsd/v1/subscriptions/{subscriptionId}':
792 operationId: api_nsd_v1_subscriptions_read
793 description: Query subscriptions for Nsd Management
799 $ref: '#/definitions/NsdmSubscription'
803 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
807 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
811 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
815 operationId: api_nsd_v1_subscriptions_delete
816 description: Delete subscription for Nsd Management
820 description: No_Content
824 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
828 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
832 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
836 - name: subscriptionId
841 /api/vnfpkgm/v1/health_check:
843 operationId: api_vnfpkgm_v1_health_check_list
852 /api/vnfpkgm/v1/subscriptions:
854 operationId: api_vnfpkgm_v1_subscriptions_list
861 $ref: '#/definitions/PkgmSubscription'
865 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
869 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
873 operationId: api_vnfpkgm_v1_subscriptions_create
880 $ref: '#/definitions/PkgmSubscriptionRequest'
885 $ref: '#/definitions/PkgmSubscription'
887 description: Internal error
891 '/api/vnfpkgm/v1/subscriptions/{subscriptionId}':
893 operationId: api_vnfpkgm_v1_subscriptions_read
900 $ref: '#/definitions/PkgmSubscription'
904 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
908 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
912 operationId: api_vnfpkgm_v1_subscriptions_delete
921 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
925 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
929 - name: subscriptionId
933 /api/vnfpkgm/v1/vnf_packages:
935 operationId: api_vnfpkgm_v1_vnf_packages_list
936 description: Query multiple VNF package resource
944 $ref: '#/definitions/VnfPkgInfo'
946 description: Internal error
950 operationId: api_vnfpkgm_v1_vnf_packages_create
951 description: Create an individual VNF package resource
957 $ref: '#/definitions/CreateVnfPkgInfoRequest'
962 $ref: '#/definitions/VnfPkgInfo'
964 description: Internal error
968 '/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}':
970 operationId: api_vnfpkgm_v1_vnf_packages_read
971 description: Query an individual VNF package resource
977 $ref: '#/definitions/VnfPkgInfo'
979 description: VNF package does not exist
981 description: Internal error
985 operationId: api_vnfpkgm_v1_vnf_packages_delete
986 description: Delete an individual VNF package resource
990 description: No content
992 description: Internal error
1000 '/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
1002 operationId: api_vnfpkgm_v1_vnf_packages_artifacts_read
1009 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
1013 $ref: '#/definitions/SUBSCRIPTION_ProblemDetailsSerializer'
1017 - name: artifactPath
1025 '/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content':
1027 operationId: api_vnfpkgm_v1_vnf_packages_package_content_list
1028 description: Fetch VNF package content
1036 $ref: '#/definitions/VnfPkgInfo'
1038 description: VNF package does not exist
1040 description: Internal error
1044 operationId: api_vnfpkgm_v1_vnf_packages_package_content_update
1045 description: Upload VNF package content
1049 description: Successfully
1051 description: Internal error
1059 '/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content/upload_from_uri':
1061 operationId: api_vnfpkgm_v1_vnf_packages_package_content_upload_from_uri_create
1062 description: Upload VNF package content from uri
1068 $ref: '#/definitions/UploadVnfPackageFromUriRequest'
1071 description: Successfully
1073 description: Internal error
1083 operationId: samples_list
1084 description: List all samples.
1093 JobResponseHistoryList:
1094 description: Response History List
1104 description: Job Progress
1108 title: Statusdescription
1109 description: Status Description
1114 description: Error Code
1120 description: Response Id
1123 JobResponseDescriptor:
1124 title: Responsedescriptor
1125 description: Job Response Descriptor
1135 description: Job Progress
1139 title: Statusdescription
1140 description: Status Description
1145 description: Error Code
1151 description: Response Id
1154 responseHistoryList:
1155 description: Response History List
1158 $ref: '#/definitions/JobResponseHistoryList'
1168 $ref: '#/definitions/JobResponseDescriptor'
1169 PostJobResponseResult:
1181 description: Message
1189 description: Job Progress
1194 description: Description
1199 description: Error Code
1204 description: NS Package Info
1215 description: NS Package ID
1220 description: NSD Provider
1225 description: NSD Version
1230 description: CSAR name
1235 description: NSD Model
1240 description: URL to download NSD Model
1250 description: CSAR ID
1255 $ref: '#/definitions/NsPackageInfo'
1256 InternalErrorRequest:
1268 description: Error Message
1271 NsPackageDistributeRequest:
1281 NsPackageDistributeResponse:
1294 title: Statusdescription
1295 description: statusDescription
1300 description: errorCode
1310 description: CSAR ID
1315 description: 'Package type: VNF, PNF, NS, Service'
1333 description: VNF Package Info
1340 description: VNFD ID
1345 description: VNF Package ID
1350 description: VNFD Provider
1355 description: VNFD Version
1360 description: VNF Version
1365 description: CSAR Name
1370 description: VNFD Model
1375 description: URL to download VNFD Model
1379 description: Image Info
1392 description: Index of VNF Image
1397 description: Image file name
1402 description: Image ID
1412 description: User of VIM
1433 description: CSAR ID
1437 $ref: '#/definitions/NfPackageInfo'
1439 description: Image Info
1442 $ref: '#/definitions/NfImageInfo'
1444 NfPackageDistributeRequest:
1451 description: CSAR ID
1455 description: A string for vimIds
1462 description: A list of VIM IDs.
1475 title: Onboardingfailuredetails
1476 description: Failure details of current onboarding procedure.It shall be present when the nsdOnboardingState attribute is CREATED and the uploading or processing fails in NFVO.
1484 description: 'A URI reference according to IETF RFC 3986 [10] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".'
1489 description: The HTTP status code for this occurrence of the problem.
1493 description: A human-readable explanation specific to this occurrence of the problem.
1498 description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
1501 additional_attributes:
1502 title: Additional attributes
1503 description: 'Any number of additional attributes, as defined in a specification or by an implementation.'
1505 additionalProperties:
1506 description: Additional attribute
1511 description: URI of this resource.
1518 description: URI of the referenced resource
1523 description: Links to resources related to this resource.
1530 $ref: '#/definitions/Link'
1532 $ref: '#/definitions/Link'
1536 - nsdOnboardingState
1537 - nsdOperationalState
1544 description: Identifier of the onboarded individual NS descriptor resource.This identifier is allocated by the NFVO.
1549 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.'
1554 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.
1559 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.
1564 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.
1568 title: Nsdinvariantid
1569 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.'
1573 description: Identifies the VNF package for the VNFD referenced by the on-boarded NS descriptor resource.
1576 description: Identifier of the VNF package
1580 description: Identifies the PnfdInfo element for the PNFD referenced by the on-boarded NS descriptor resource.
1583 description: Identifier of the PnfdInfo element
1587 description: Identifies the NsdInfo element for the nested NSD referenced by the on-boarded NS descriptor resource.
1590 description: Identifier of the NsdInfo element
1594 title: Nsdonboardingstate
1595 description: Onboarding state of the individual NS descriptor resource.
1602 onboardingFailureDetails:
1603 $ref: '#/definitions/ProblemDetails'
1604 nsdOperationalState:
1605 title: Nsdoperationalstate
1606 description: Operational state of the individual NS descriptor resource.This attribute can be modified with the PATCH method.
1612 title: Nsdusagestate
1613 description: Usage state of the individual NS descriptor resource.
1619 title: Userdefineddata
1620 description: User defined data for the individual NS descriptor resource.This attribute can be modified with the PATCH method.
1622 additionalProperties:
1623 description: Key Value Pairs
1627 $ref: '#/definitions/NSD_LinkSerializer'
1628 CreateNsdInfoRequest:
1632 title: Userdefineddata
1633 description: User-defined data for the NS descriptor resource to be created.It shall be present when the user defined data is set for the individual NS descriptor resource to be created.
1635 additionalProperties:
1636 description: Key Value Pairs
1641 description: Links to resources related to this resource.
1648 $ref: '#/definitions/Link'
1650 $ref: '#/definitions/Link'
1654 - pnfdOnboardingState
1661 description: Identifier of the onboarded individual PNF descriptor resource. This identifier is allocated by the NFVO.
1666 description: 'This identifier, which is allocated 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.'
1671 description: Name of the onboarded PNFD. This information is copied from the PNFD content and shall be present after the PNFD content is on-boarded.
1676 description: Version of the on-boarded PNFD. This information is copied from the PNFD content and shall be present after the PNFD content is on-boarded.
1681 description: 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.
1685 title: Pnfdinvariantid
1686 description: Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD.
1689 pnfdOnboardingState:
1690 title: Pnfdonboardingstate
1691 description: Onboarding state of the individual PNF descriptor resource.
1698 onboardingFailureDetails:
1699 $ref: '#/definitions/ProblemDetails'
1701 title: Pnfdusagestate
1702 description: Usage state of the individual PNF descriptor resource.
1708 title: Userdefineddata
1709 description: User defined data for the individual PNF descriptor resource. This attribute can be modified with the PATCH method.
1711 additionalProperties:
1712 description: Key Value Pairs
1716 $ref: '#/definitions/_Link'
1717 CreatePnfdInfoRequest:
1721 title: Userdefineddata
1722 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.
1724 additionalProperties:
1725 description: Key Value Pairs
1728 NsdmNotificationsFilter:
1730 description: 'Filter settings for this subscription, to define the of all notifications this subscription relates to.'
1734 description: Match particular notification types
1739 - NsdOnBoardingNotification
1740 - NsdOnboardingFailureNotification
1741 - NsdChangeNotification
1742 - NsdDeletionNotification
1743 - PnfdOnBoardingNotification
1744 - PnfdOnBoardingFailureNotification
1745 - PnfdDeletionNotification
1747 description: Match NS packages with particular nsdInfoIds
1753 description: Match NS Packages with particular nsdIds
1759 description: Match NS Packages with particular nsdNames
1766 description: match NS packages that belong to certain nsdversion
1773 description: Match NS Packages with particular nsdInvariantIds
1779 description: Match NS Packages that has VNF PackageIds
1785 description: Match NS Packages with particular nsdInvariantIds
1791 description: Match NS Packages with particular NS Onboarding State
1800 nsdOperationalState:
1801 description: Match NS Packages with particular NS Operational State
1809 description: Match NS Packages with particular NS Usage State
1817 description: Match PF packages with particular pnfdInfoIds
1823 description: Match PF packages with particular pnfdInfoIds
1829 description: Match PF Packages with particular pnfdNames
1836 description: match PF packages that belong to certain pnfd version
1843 description: Match PF Packages with particular pnfdProvider
1850 description: Match PF Packages with particular pnfdInvariantIds
1855 pnfdOnboardingState:
1856 description: 'Match PF Packages with particular PNF Onboarding State '
1866 description: Match PF Packages with particular PNF usage State
1873 NsdmSubscriptionLink:
1875 description: Links to resources related to this resource.
1881 $ref: '#/definitions/Link'
1891 description: Identifier of this subscription resource.
1897 description: The URI of the endpoint to send the notification to.
1902 $ref: '#/definitions/NsdmNotificationsFilter'
1904 $ref: '#/definitions/NsdmSubscriptionLink'
1905 SUBSCRIPTION_ProblemDetailsSerializer:
1934 description: Instance
1939 description: 'Any number of additional attributes, as defined in a specification or by an implementation.'
1946 description: Parameters for authentication/authorization using BASIC.
1951 description: Username to be used in HTTP Basic authentication.
1957 description: Password to be used in HTTP Basic authentication.
1962 title: Paramsoauth2clientcredentials
1963 description: Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.
1968 description: Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type.
1973 title: Clientpassword
1974 description: Client password to be used in the access token request of the OAuth 2.0 client credentials grant type.
1979 title: Tokenendpoint
1980 description: The token endpoint from which the access token can be obtained.
1984 SubscriptionAuthentication:
1985 title: Authentication
1986 description: Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription.
1992 description: Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification.
1998 - OAUTH2_CLIENT_CREDENTIALS
2001 $ref: '#/definitions/BasicAuth'
2002 paramsOauth2ClientCredentials:
2003 $ref: '#/definitions/OAuthCredentials'
2004 NsdmSubscriptionRequest:
2011 description: The URI of the endpoint to send the notification to.
2015 $ref: '#/definitions/NsdmNotificationsFilter'
2017 $ref: '#/definitions/SubscriptionAuthentication'
2020 description: Service Package Info
2025 description: ServiceD ID
2030 title: Servicepackageid
2031 description: Service Package ID
2035 title: Servicedprovider
2036 description: ServiceD Provider
2040 title: Servicedversion
2041 description: ServiceD Version
2046 description: CSAR name
2050 title: Servicedmodel
2051 description: ServiceD Model
2056 description: URL to download ServiceD Model
2066 description: CSAR ID
2071 $ref: '#/definitions/ServicePackageInfo'
2072 ServicePackageDistributeRequest:
2082 VNF_SUBSCRIPTION_LINKSERIALIZER:
2084 description: URI of this resource.
2091 description: URI of the referenced resource.
2096 description: Links to resources related to this resource.
2102 $ref: '#/definitions/VNF_SUBSCRIPTION_LINKSERIALIZER'
2105 description: match VNF packages that contain VNF products with certain versions
2107 - vnfSoftwareVersion
2111 title: Vnfsoftwareversion
2112 description: VNF software version to match.
2117 description: Match VNF packages that contain VNF products with certain VNFD versions
2124 description: 'match VNF packages that contain VNF products with certain product names, from one particular provider'
2130 title: Vnfproductname
2131 description: Name of the VNF product to match.
2136 $ref: '#/definitions/Version'
2137 vnfProductsProviders:
2138 title: Vnfproductsfromproviders
2139 description: Match VNF packages that contain VNF products from certain providers.
2146 description: Name of the VNFprovider to match.
2151 $ref: '#/definitions/vnfProducts'
2152 PkgmNotificationsFilter:
2154 description: 'Filter settings for this subscription, to define the subset of all notifications this subscription relates to'
2158 description: Match particular notification types
2163 - VnfPackageOnboardingNotification
2164 - VnfPackageChangeNotification
2165 vnfProductsFromProviders:
2166 $ref: '#/definitions/vnfProductsProviders'
2168 description: Match VNF packages with a VNFD identifierlisted in the attribute
2174 description: Match VNF packages with a VNFD identifierlisted in the attribute
2180 description: Operational state of the VNF package.
2188 description: Operational state of the VNF package.
2204 description: Identifier of this subscription resource.
2209 description: The URI of the endpoint to send the notification to.
2214 $ref: '#/definitions/LinkSelf'
2216 $ref: '#/definitions/PkgmNotificationsFilter'
2217 PkgmSubscriptionRequest:
2223 $ref: '#/definitions/PkgmNotificationsFilter'
2226 description: Callback URI to sendthe notification
2231 $ref: '#/definitions/SubscriptionAuthentication'
2234 description: Checksum of the on-boarded VNF package.
2242 description: Name of the algorithm used to generate the checksum.
2247 description: The hexadecimal value of the checksum.
2250 VnfPackageSoftwareImageInfo:
2251 description: Information about VNF package artifacts that are software images.
2269 description: Identifier of the software image.
2274 description: Name of the software image.
2279 description: Provider of the software image.
2284 description: Version of the software image.
2288 $ref: '#/definitions/Checksum'
2290 title: Containerformat
2291 description: 'terminationType: Indicates whether forceful or graceful termination is requested.'
2303 description: Disk format of a software image is the format of the underlying disk image.
2318 description: Time when this software image was created.
2323 description: The minimal disk for this software image in bytes.
2327 description: The minimal RAM for this software image in bytes.
2331 description: Size of this software image in bytes.
2335 description: User-defined data.
2337 additionalProperties:
2338 description: KeyValue Pairs
2343 description: Path in the VNF package.
2346 VnfPackageArtifactInfo:
2347 description: Information about VNF package artifacts contained in the VNF package that are not software images.
2355 description: Path in the VNF package.
2359 $ref: '#/definitions/Checksum'
2362 description: The metadata of the artifact that are available in the VNF package
2364 additionalProperties:
2365 description: KeyValue Pairs
2368 VNF_PKGM_Link_Serializer:
2370 description: Links to resources related to this resource.
2377 $ref: '#/definitions/Link'
2379 $ref: '#/definitions/Link'
2381 $ref: '#/definitions/Link'
2393 description: Identifier of the on-boarded VNF package.
2398 description: 'This identifier, which is managed by the VNF provider, identifies the VNF package and the VNFD in a globally unique way.'
2403 description: Provider of the VNF package and the VNFD.
2407 title: Vnfproductname
2408 description: Name to identify the VNF product.
2412 title: Vnfsoftwareversion
2413 description: Software version of the VNF.
2418 description: The version of the VNvFD.
2422 $ref: '#/definitions/Checksum'
2424 description: Information about VNF package artifacts that are software images.
2427 $ref: '#/definitions/VnfPackageSoftwareImageInfo'
2429 additionalArtifacts:
2430 description: Information about VNF package artifacts contained in the VNF package that are not software images.
2433 $ref: '#/definitions/VnfPackageArtifactInfo'
2436 title: Onboardingstate
2437 description: On-boarding state of the VNF package.
2445 title: Operationalstate
2446 description: Operational state of the VNF package.
2453 description: Usage state of the VNF package.
2459 title: Userdefineddata
2460 description: User defined data for the VNF package.
2462 additionalProperties:
2463 description: KeyValue Pairs
2467 $ref: '#/definitions/VNF_PKGM_Link_Serializer'
2468 CreateVnfPkgInfoRequest:
2472 title: Userdefineddata
2473 description: User defined data for the VNF package.
2475 additionalProperties:
2476 description: KeyValue Pairs
2479 UploadVnfPackageFromUriRequest:
2481 - addressInformation
2485 title: Addressinformation
2486 description: Address information of the VNF package content.
2491 description: User name to be used for authentication.
2496 description: Password to be used for authentication.