4 "title": "Modeling etsicatalog API",
5 "description": "\n\nThe `swagger-ui` view can be found [here](/api/catalog/v1/swagger).\nThe `ReDoc` view can be found [here](/api/catalog/v1/redoc).\nThe swagger YAML document can be found [here](/api/catalog/v1/swagger.yaml).\nThe swagger JSON document can be found [here](/api/catalog/v1/swagger.json).",
8 "host": "127.0.0.1:8806",
11 "consumes": ["application/json"],
12 "produces": ["application/json"],
13 "securityDefinitions": {
22 "/api/catalog/v1/callback_sample": {
24 "operationId": "api_catalog_v1_callback_sample_list",
25 "description": "Callback Sample.",
32 "tags": ["Sample interface"]
36 "/api/catalog/v1/health_check": {
38 "operationId": "api_catalog_v1_health_check_list",
43 "description": "Active"
46 "tags": ["Health Check interface"]
50 "/api/catalog/v1/jobs/{job_id}": {
52 "operationId": "api_catalog_v1_jobs_read",
53 "description": "Get job status",
57 "description": "job id",
62 "description": "response id",
69 "$ref": "#/definitions/GetJobResponse"
75 "$ref": "#/definitions/PostJobResponseResult"
79 "tags": ["Catalog interface"]
82 "operationId": "api_catalog_v1_jobs_create",
83 "description": "Update job status",
89 "$ref": "#/definitions/PostJobRequest"
94 "description": "job id",
101 "$ref": "#/definitions/PostJobResponseResult"
107 "$ref": "#/definitions/PostJobResponseResult"
111 "tags": ["Catalog interface"]
120 "/api/catalog/v1/mandb/{modelName}": {
122 "operationId": "api_catalog_v1_mandb_read",
130 "tags": ["Sample interface"]
133 "operationId": "api_catalog_v1_mandb_delete",
141 "tags": ["Sample interface"]
150 "/api/catalog/v1/nspackages": {
152 "operationId": "api_catalog_v1_nspackages_list",
153 "description": "Query NS packages",
161 "$ref": "#/definitions/NsPackage"
168 "$ref": "#/definitions/InternalErrorRequest"
172 "tags": ["Catalog interface"]
175 "operationId": "api_catalog_v1_nspackages_create",
176 "description": "On distribute NS package",
182 "$ref": "#/definitions/NsPackageDistributeRequest"
189 "$ref": "#/definitions/NsPackageDistributeResponse"
195 "$ref": "#/definitions/InternalErrorRequest"
199 "tags": ["Catalog interface"]
203 "/api/catalog/v1/nspackages/{csarId}": {
205 "operationId": "api_catalog_v1_nspackages_read",
206 "description": "Query one NS package",
210 "description": "csarId",
217 "$ref": "#/definitions/NsPackage"
221 "description": "error message",
227 "tags": ["Catalog interface"]
230 "operationId": "api_catalog_v1_nspackages_delete",
231 "description": "Delete one NS package",
235 "description": "csarId",
242 "$ref": "#/definitions/NsPackageDistributeResponse"
246 "description": "error message",
252 "tags": ["Catalog interface"]
261 "/api/catalog/v1/service_packages": {
263 "operationId": "api_catalog_v1_service_packages_list",
264 "description": "Query Service packages",
272 "$ref": "#/definitions/ServicePackage"
279 "$ref": "#/definitions/InternalErrorRequest"
283 "tags": ["Catalog interface"]
286 "operationId": "api_catalog_v1_service_packages_create",
287 "description": "On distribute Service package",
293 "$ref": "#/definitions/ServicePackageDistributeRequest"
303 "$ref": "#/definitions/InternalErrorRequest"
309 "$ref": "#/definitions/InternalErrorRequest"
313 "tags": ["Catalog interface"]
317 "/api/catalog/v1/service_packages/{csarId}": {
319 "operationId": "api_catalog_v1_service_packages_read",
320 "description": "Query one Service package",
324 "description": "csarId",
331 "$ref": "#/definitions/ServicePackage"
337 "$ref": "#/definitions/InternalErrorRequest"
343 "$ref": "#/definitions/InternalErrorRequest"
347 "tags": ["Catalog interface"]
350 "operationId": "api_catalog_v1_service_packages_delete",
351 "description": "Delete one Service package",
355 "description": "csarId",
365 "$ref": "#/definitions/InternalErrorRequest"
371 "$ref": "#/definitions/InternalErrorRequest"
375 "tags": ["Catalog interface"]
384 "/api/catalog/v1/vnfpackages": {
386 "operationId": "api_catalog_v1_vnfpackages_list",
387 "description": "Query Nf packages",
395 "$ref": "#/definitions/NfPackage"
402 "$ref": "#/definitions/InternalErrorRequest"
406 "tags": ["Catalog interface"]
409 "operationId": "api_catalog_v1_vnfpackages_create",
410 "description": "On distribute Nf package",
416 "$ref": "#/definitions/NfPackageDistributeRequest"
423 "$ref": "#/definitions/PostJobResponse"
429 "$ref": "#/definitions/InternalErrorRequest"
433 "tags": ["Catalog interface"]
437 "/api/catalog/v1/vnfpackages/{csarId}": {
439 "operationId": "api_catalog_v1_vnfpackages_read",
440 "description": "Query one Nf package",
444 "description": "csarId",
451 "$ref": "#/definitions/NfPackage"
455 "description": "error message",
461 "tags": ["Catalog interface"]
464 "operationId": "api_catalog_v1_vnfpackages_delete",
465 "description": "Delete one Nf package",
469 "description": "csarId",
476 "$ref": "#/definitions/PostJobResponse"
480 "description": "error message",
486 "tags": ["Catalog interface"]
495 "/api/nsd/v1/health_check": {
497 "operationId": "api_nsd_v1_health_check_list",
502 "description": "Active"
505 "tags": ["Health Check interface"]
509 "/api/nsd/v1/ns_descriptors": {
511 "operationId": "api_nsd_v1_ns_descriptors_list",
512 "description": "Query multiple NSDs",
520 "$ref": "#/definitions/NsdInfo"
525 "description": "Internal error"
528 "tags": ["NSD Management interface"]
531 "operationId": "api_nsd_v1_ns_descriptors_create",
532 "description": "Create a NSD",
538 "$ref": "#/definitions/CreateNsdInfoRequest"
545 "$ref": "#/definitions/NsdInfo"
549 "description": "Internal error"
552 "tags": ["NSD Management interface"]
556 "/api/nsd/v1/ns_descriptors/{nsdInfoId}": {
558 "operationId": "api_nsd_v1_ns_descriptors_read",
559 "description": "Query a NSD",
565 "$ref": "#/definitions/NsdInfo"
569 "description": "NSDs do not exist"
572 "description": "Internal error"
575 "tags": ["NSD Management interface"]
578 "operationId": "api_nsd_v1_ns_descriptors_delete",
579 "description": "Delete a NSD",
583 "description": "No content"
586 "description": "Internal error"
589 "tags": ["NSD Management interface"]
598 "/api/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content": {
600 "operationId": "api_nsd_v1_ns_descriptors_nsd_content_list",
601 "description": "Download NSD content",
605 "description": "No content"
608 "description": "NSD does not exist."
611 "description": "Internal error"
614 "tags": ["NSD Management interface"]
617 "operationId": "api_nsd_v1_ns_descriptors_nsd_content_update",
618 "description": "Upload NSD content",
622 "description": "PNFD file"
625 "description": "Internal error"
628 "tags": ["NSD Management interface"]
637 "/api/nsd/v1/pnf_descriptors": {
639 "operationId": "api_nsd_v1_pnf_descriptors_list",
640 "description": "Query multiple PNFDs",
648 "$ref": "#/definitions/PnfdInfo"
655 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
659 "tags": ["NSD Management interface"]
662 "operationId": "api_nsd_v1_pnf_descriptors_create",
663 "description": "Create a PNFD",
669 "$ref": "#/definitions/CreatePnfdInfoRequest"
676 "$ref": "#/definitions/PnfdInfo"
682 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
686 "tags": ["NSD Management interface"]
690 "/api/nsd/v1/pnf_descriptors/{pnfdInfoId}": {
692 "operationId": "api_nsd_v1_pnf_descriptors_read",
693 "description": "Query a PNFD",
699 "$ref": "#/definitions/PnfdInfo"
705 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
711 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
715 "tags": ["NSD Management interface"]
718 "operationId": "api_nsd_v1_pnf_descriptors_delete",
719 "description": "Delete a PNFD",
723 "description": "No content"
728 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
732 "tags": ["NSD Management interface"]
735 "name": "pnfdInfoId",
741 "/api/nsd/v1/pnf_descriptors/{pnfdInfoId}/pnfd_content": {
743 "operationId": "Fetch PNFD content",
744 "description": "Fetch PNFD content",
748 "description": "PNFD file",
757 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
763 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
767 "produces": ["application/octet-stream", "application/json"],
768 "tags": ["NSD Management interface"]
771 "operationId": "api_nsd_v1_pnf_descriptors_pnfd_content_update",
772 "description": "Upload PNFD content",
776 "description": "No content"
781 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
785 "tags": ["NSD Management interface"]
788 "name": "pnfdInfoId",
794 "/api/nsd/v1/subscriptions": {
796 "operationId": "api_nsd_v1_subscriptions_list",
797 "description": "Query subscriptions for Nsd Management",
805 "$ref": "#/definitions/NsdmSubscription"
812 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
818 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
824 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
828 "tags": ["NSD Management interface"]
831 "operationId": "api_nsd_v1_subscriptions_create",
832 "description": "Create Subscription for NSD Management",
838 "$ref": "#/definitions/NsdmSubscriptionRequest"
845 "$ref": "#/definitions/NsdmSubscription"
851 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
857 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
863 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
867 "tags": ["NSD Management interface"]
871 "/api/nsd/v1/subscriptions/{subscriptionId}": {
873 "operationId": "api_nsd_v1_subscriptions_read",
874 "description": "Query subscriptions for Nsd Management",
880 "$ref": "#/definitions/NsdmSubscription"
886 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
892 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
898 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
902 "tags": ["NSD Management interface"]
905 "operationId": "api_nsd_v1_subscriptions_delete",
906 "description": "Delete subscription for Nsd Management",
910 "description": "No_Content"
915 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
921 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
927 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
931 "tags": ["NSD Management interface"]
934 "name": "subscriptionId",
940 "/api/parser/v1/health_check": {
942 "operationId": "api_parser_v1_health_check_list",
947 "description": "Active"
950 "tags": ["Health Check interface"]
954 "/api/parser/v1/parser": {
956 "operationId": "api_parser_v1_parser_create",
957 "description": "Parse model(NS, Service, VNF, PNF)",
963 "$ref": "#/definitions/ParseModelRequest"
970 "$ref": "#/definitions/ParseModelResponse"
976 "$ref": "#/definitions/InternalErrorRequest"
980 "tags": ["Parser interface"]
984 "/api/parser/v1/parsernsd": {
986 "operationId": "api_parser_v1_parsernsd_create",
987 "description": "Parse NS model",
993 "$ref": "#/definitions/ParseModelRequest"
1000 "$ref": "#/definitions/ParseModelResponse"
1006 "$ref": "#/definitions/InternalErrorRequest"
1010 "tags": ["Parser interface"]
1014 "/api/parser/v1/parserpnfd": {
1016 "operationId": "api_parser_v1_parserpnfd_create",
1017 "description": "Parse PNF model",
1023 "$ref": "#/definitions/ParseModelRequest"
1030 "$ref": "#/definitions/ParseModelResponse"
1036 "$ref": "#/definitions/InternalErrorRequest"
1040 "tags": ["Parser interface"]
1044 "/api/parser/v1/parservnfd": {
1046 "operationId": "api_parser_v1_parservnfd_create",
1047 "description": "Parse NF model",
1053 "$ref": "#/definitions/ParseModelRequest"
1060 "$ref": "#/definitions/ParseModelResponse"
1066 "$ref": "#/definitions/InternalErrorRequest"
1070 "tags": ["Parser interface"]
1074 "/api/vnfpkgm/v1/health_check": {
1076 "operationId": "api_vnfpkgm_v1_health_check_list",
1081 "description": "Active"
1084 "tags": ["Health Check interface"]
1088 "/api/vnfpkgm/v1/subscriptions": {
1090 "operationId": "api_vnfpkgm_v1_subscriptions_list",
1097 "$ref": "#/definitions/PkgmSubscription"
1103 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
1109 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
1113 "tags": ["VNF Package Management interface"]
1116 "operationId": "api_vnfpkgm_v1_subscriptions_create",
1123 "$ref": "#/definitions/PkgmSubscriptionRequest"
1130 "$ref": "#/definitions/PkgmSubscription"
1136 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
1142 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
1146 "tags": ["VNF Package Management interface"]
1150 "/api/vnfpkgm/v1/subscriptions/{subscriptionId}": {
1152 "operationId": "api_vnfpkgm_v1_subscriptions_read",
1159 "$ref": "#/definitions/PkgmSubscription"
1165 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
1171 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
1175 "tags": ["VNF Package Management interface"]
1178 "operationId": "api_vnfpkgm_v1_subscriptions_delete",
1188 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
1194 "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
1198 "tags": ["VNF Package Management interface"]
1201 "name": "subscriptionId",
1207 "/api/vnfpkgm/v1/vnf_packages": {
1209 "operationId": "api_vnfpkgm_v1_vnf_packages_list",
1210 "description": "Query multiple VNF package resource",
1218 "$ref": "#/definitions/VnfPkgInfo"
1223 "description": "Internal error",
1229 "tags": ["VNF Package Management interface"]
1232 "operationId": "api_vnfpkgm_v1_vnf_packages_create",
1233 "description": "Create an individual VNF package resource",
1239 "$ref": "#/definitions/CreateVnfPkgInfoRequest"
1246 "$ref": "#/definitions/VnfPkgInfo"
1250 "description": "Bad Request",
1256 "description": "Internal error",
1262 "tags": ["VNF Package Management interface"]
1266 "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}": {
1268 "operationId": "api_vnfpkgm_v1_vnf_packages_read",
1269 "description": "Query an individual VNF package resource",
1275 "$ref": "#/definitions/VnfPkgInfo"
1279 "description": "VNF package does not exist",
1285 "description": "Internal error",
1291 "tags": ["VNF Package Management interface"]
1294 "operationId": "api_vnfpkgm_v1_vnf_packages_delete",
1295 "description": "Delete an individual VNF package resource",
1299 "description": "No content"
1302 "description": "Internal error",
1308 "tags": ["VNF Package Management interface"]
1317 "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}": {
1319 "operationId": "api_vnfpkgm_v1_vnf_packages_artifacts_read",
1324 "description": "Return the artifact file",
1331 "description": "Artifact not found",
1337 "description": "Internal error",
1343 "produces": ["application/octet-stream", "application/json"],
1344 "tags": ["VNF Package Management interface"]
1347 "name": "artifactPath",
1358 "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content": {
1360 "operationId": "api_vnfpkgm_v1_vnf_packages_package_content_list",
1361 "description": "Fetch VNF package content",
1365 "description": "VNF package file",
1372 "description": "VNF package does not exist",
1378 "description": "Internal error",
1384 "produces": ["application/octet-stream", "application/json"],
1385 "tags": ["VNF Package Management interface"]
1388 "operationId": "api_vnfpkgm_v1_vnf_packages_package_content_update",
1389 "description": "Upload VNF package content",
1393 "description": "Successfully"
1396 "description": "Internal error",
1402 "tags": ["VNF Package Management interface"]
1411 "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content/upload_from_uri": {
1413 "operationId": "api_vnfpkgm_v1_vnf_packages_package_content_upload_from_uri_create",
1414 "description": "Upload VNF package content from uri",
1420 "$ref": "#/definitions/UploadVnfPackageFromUriRequest"
1425 "description": "Successfully"
1428 "description": "Bad Request",
1434 "description": "Internal error",
1440 "tags": ["VNF Package Management interface"]
1449 "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd": {
1451 "operationId": "VNFD of an on-boarded VNF package",
1452 "description": "Read VNFD of an on-boarded VNF package",
1456 "description": "VNFD of an on-boarded VNF package",
1463 "description": "VNF package does not exist",
1469 "description": "Internal error",
1475 "produces": ["application/octet-stream", "application/json"],
1476 "tags": ["VNF Package Management interface"]
1487 "operationId": "samples_list",
1488 "description": "List all samples.",
1495 "tags": ["Sample interface"]
1501 "JobResponseHistoryList": {
1502 "description": "Response History List",
1507 "description": "Status",
1512 "title": "Progress",
1513 "description": "Job Progress",
1517 "statusDescription": {
1518 "title": "Statusdescription",
1519 "description": "Status Description",
1524 "title": "Errorcode",
1525 "description": "Error Code",
1531 "title": "Responseid",
1532 "description": "Response Id",
1538 "JobResponseDescriptor": {
1539 "title": "Responsedescriptor",
1540 "description": "Job Response Descriptor",
1545 "description": "Status",
1550 "title": "Progress",
1551 "description": "Job Progress",
1555 "statusDescription": {
1556 "title": "Statusdescription",
1557 "description": "Status Description",
1562 "title": "Errorcode",
1563 "description": "Error Code",
1569 "title": "Responseid",
1570 "description": "Response Id",
1574 "responseHistoryList": {
1575 "description": "Response History List",
1578 "$ref": "#/definitions/JobResponseHistoryList"
1588 "description": "Job Id",
1592 "responseDescriptor": {
1593 "$ref": "#/definitions/JobResponseDescriptor"
1597 "PostJobResponseResult": {
1598 "required": ["result"],
1603 "description": "Result",
1609 "description": "Message",
1619 "title": "Progress",
1620 "description": "Job Progress",
1626 "description": "Description",
1632 "description": "Error Code",
1639 "title": "Packageinfo",
1640 "description": "NS Package Info",
1645 "description": "NSD ID",
1651 "title": "Nspackageid",
1652 "description": "NS Package ID",
1657 "title": "Nsdprovider",
1658 "description": "NSD Provider",
1663 "title": "Nsdversion",
1664 "description": "NSD Version",
1669 "title": "Csarname",
1670 "description": "CSAR name",
1675 "title": "Nsdmodel",
1676 "description": "NSD Model",
1681 "title": "Downloadurl",
1682 "description": "URL to download NSD Model",
1695 "description": "CSAR ID",
1701 "$ref": "#/definitions/NsPackageInfo"
1705 "InternalErrorRequest": {
1706 "required": ["error"],
1711 "description": "Error",
1716 "title": "Errormessage",
1717 "description": "Error Message",
1723 "NsPackageDistributeRequest": {
1724 "required": ["csarId"],
1729 "description": "csarId",
1735 "NsPackageDistributeResponse": {
1736 "required": ["status", "statusDescription", "errorCode"],
1741 "description": "status",
1745 "statusDescription": {
1746 "title": "Statusdescription",
1747 "description": "statusDescription",
1752 "title": "Errorcode",
1753 "description": "errorCode",
1759 "ServicePackageInfo": {
1760 "title": "Packageinfo",
1761 "description": "Service Package Info",
1765 "title": "Servicedid",
1766 "description": "ServiceD ID",
1771 "servicePackageId": {
1772 "title": "Servicepackageid",
1773 "description": "Service Package ID",
1777 "servicedProvider": {
1778 "title": "Servicedprovider",
1779 "description": "ServiceD Provider",
1783 "servicedVersion": {
1784 "title": "Servicedversion",
1785 "description": "ServiceD Version",
1790 "title": "Csarname",
1791 "description": "CSAR name",
1796 "title": "Servicedmodel",
1797 "description": "ServiceD Model",
1802 "title": "Downloadurl",
1803 "description": "URL to download ServiceD Model",
1816 "description": "CSAR ID",
1822 "$ref": "#/definitions/ServicePackageInfo"
1826 "ServicePackageDistributeRequest": {
1827 "required": ["csarId"],
1832 "description": "csarId",
1839 "title": "Packageinfo",
1840 "description": "VNF Package Info",
1841 "required": ["vnfPackageId"],
1846 "description": "VNFD ID",
1851 "title": "Vnfpackageid",
1852 "description": "VNF Package ID",
1857 "title": "Vnfdprovider",
1858 "description": "VNFD Provider",
1863 "title": "Vnfdversion",
1864 "description": "VNFD Version",
1869 "title": "Vnfversion",
1870 "description": "VNF Version",
1875 "title": "Csarname",
1876 "description": "CSAR Name",
1881 "title": "Vnfdmodel",
1882 "description": "VNFD Model",
1887 "title": "Downloadurl",
1888 "description": "URL to download VNFD Model",
1895 "description": "Image Info",
1896 "required": ["index", "fileName", "imageId", "vimId", "vimUser", "tenant", "status"],
1901 "description": "Index of VNF Image",
1906 "title": "Filename",
1907 "description": "Image file name",
1913 "description": "Image ID",
1919 "description": "VIM ID",
1925 "description": "User of VIM",
1931 "description": "Tenant",
1937 "description": "Status",
1944 "required": ["csarId", "packageInfo"],
1949 "description": "CSAR ID",
1954 "$ref": "#/definitions/NfPackageInfo"
1957 "description": "Image Info",
1960 "$ref": "#/definitions/NfImageInfo"
1966 "NfPackageDistributeRequest": {
1967 "required": ["csarId"],
1972 "description": "CSAR ID",
1977 "description": "A string for vimIds",
1985 "title": "Labvimid",
1986 "description": "A list of VIM IDs.",
1991 "PostJobResponse": {
1992 "required": ["jobId"],
1997 "description": "jobId",
2004 "title": "Onboardingfailuredetails",
2005 "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.",
2006 "required": ["title", "detail"],
2011 "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\".",
2017 "description": "The HTTP status code for this occurrence of the problem.",
2022 "description": "A human-readable explanation specific to this occurrence of the problem.",
2027 "title": "Instance",
2028 "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.",
2032 "additional_attributes": {
2033 "title": "Additional attributes",
2034 "description": "Any number of additional attributes, as defined in a specification or by an implementation.",
2036 "additionalProperties": {
2037 "description": "Additional attribute",
2046 "description": "URI of this resource.",
2047 "required": ["href"],
2052 "description": "URI of the referenced resource",
2058 "NSD_LinkSerializer": {
2060 "description": "Links to resources related to this resource.",
2061 "required": ["self", "nsd_content"],
2065 "$ref": "#/definitions/UriLink"
2068 "$ref": "#/definitions/UriLink"
2073 "required": ["id", "nsdOnboardingState", "nsdOperationalState", "nsdUsageState", "_links"],
2078 "description": "Identifier of the onboarded individual NS descriptor resource.This identifier is allocated by the NFVO.",
2084 "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.",
2090 "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.",
2095 "title": "Nsdversion",
2096 "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.",
2101 "title": "Nsddesigner",
2102 "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.",
2107 "title": "Nsdinvariantid",
2108 "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.",
2113 "description": "Identifies the VNF package for the VNFD referenced by the on-boarded NS descriptor resource.",
2116 "description": "Identifier of the VNF package",
2122 "description": "Identifies the PnfdInfo element for the PNFD referenced by the on-boarded NS descriptor resource.",
2125 "description": "Identifier of the PnfdInfo element",
2130 "nestedNsdInfoIds": {
2131 "description": "Identifies the NsdInfo element for the nested NSD referenced by the on-boarded NS descriptor resource.",
2134 "description": "Identifier of the NsdInfo element",
2139 "nsdOnboardingState": {
2140 "title": "Nsdonboardingstate",
2141 "description": "Onboarding state of the individual NS descriptor resource.",
2143 "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
2145 "onboardingFailureDetails": {
2146 "$ref": "#/definitions/ProblemDetails"
2148 "nsdOperationalState": {
2149 "title": "Nsdoperationalstate",
2150 "description": "Operational state of the individual NS descriptor resource.This attribute can be modified with the PATCH method.",
2152 "enum": ["ENABLED", "DISABLED"]
2155 "title": "Nsdusagestate",
2156 "description": "Usage state of the individual NS descriptor resource.",
2158 "enum": ["IN_USE", "NOT_IN_USE"]
2160 "userDefinedData": {
2161 "title": "Userdefineddata",
2162 "description": "User defined data for the individual NS descriptor resource.This attribute can be modified with the PATCH method.",
2164 "additionalProperties": {
2165 "description": "Key Value Pairs",
2171 "$ref": "#/definitions/NSD_LinkSerializer"
2175 "CreateNsdInfoRequest": {
2178 "userDefinedData": {
2179 "title": "Userdefineddata",
2180 "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.",
2182 "additionalProperties": {
2183 "description": "Key Value Pairs",
2190 "PNFD_LinkSerializer": {
2192 "description": "Links to resources related to this resource.",
2193 "required": ["self", "pnfd_content"],
2197 "$ref": "#/definitions/UriLink"
2200 "$ref": "#/definitions/UriLink"
2205 "required": ["id", "pnfdOnboardingState", "pnfdUsageState", "_links"],
2210 "description": "Identifier of the onboarded individual PNF descriptor resource. This identifier is allocated by the NFVO.",
2216 "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.",
2221 "title": "Pnfdname",
2222 "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.",
2227 "title": "Pnfdversion",
2228 "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.",
2233 "title": "Pnfdprovider",
2234 "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.",
2238 "pnfdInvariantId": {
2239 "title": "Pnfdinvariantid",
2240 "description": "Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD.",
2244 "pnfdOnboardingState": {
2245 "title": "Pnfdonboardingstate",
2246 "description": "Onboarding state of the individual PNF descriptor resource.",
2248 "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
2250 "onboardingFailureDetails": {
2251 "$ref": "#/definitions/ProblemDetails"
2254 "title": "Pnfdusagestate",
2255 "description": "Usage state of the individual PNF descriptor resource.",
2257 "enum": ["IN_USE", "NOT_IN_USE"]
2259 "userDefinedData": {
2260 "title": "Userdefineddata",
2261 "description": "User defined data for the individual PNF descriptor resource. This attribute can be modified with the PATCH method.",
2263 "additionalProperties": {
2264 "description": "Key Value Pairs",
2270 "$ref": "#/definitions/PNFD_LinkSerializer"
2274 "SUBSCRIPTION_ProblemDetailsSerializer": {
2275 "required": ["status", "detail"],
2280 "description": "Type",
2287 "description": "Title",
2294 "description": "Status",
2299 "description": "Detail",
2304 "title": "Instance",
2305 "description": "Instance",
2310 "additional_details": {
2311 "description": "Any number of additional attributes, as defined in a specification or by an implementation.",
2320 "CreatePnfdInfoRequest": {
2323 "userDefinedData": {
2324 "title": "Userdefineddata",
2325 "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.",
2327 "additionalProperties": {
2328 "description": "Key Value Pairs",
2335 "NsdmNotificationsFilter": {
2337 "description": "Filter settings for this subscription, to define the of all notifications this subscription relates to.",
2340 "notificationTypes": {
2341 "description": "Match particular notification types",
2345 "enum": ["NsdOnBoardingNotification", "NsdOnboardingFailureNotification", "NsdChangeNotification", "NsdDeletionNotification", "PnfdOnBoardingNotification", "PnfdOnBoardingFailureNotification", "PnfdDeletionNotification"]
2349 "description": "Match NS packages with particular nsdInfoIds",
2357 "description": "Match NS Packages with particular nsdIds",
2365 "description": "Match NS Packages with particular nsdNames",
2374 "description": "match NS packages that belong to certain nsdversion",
2383 "description": "Match NS Packages with particular nsdInvariantIds",
2391 "description": "Match NS Packages that has VNF PackageIds",
2398 "nestedNsdInfoIds": {
2399 "description": "Match NS Packages with particular nsdInvariantIds",
2406 "nsdOnboardingState": {
2407 "description": "Match NS Packages with particular NS Onboarding State",
2411 "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
2414 "nsdOperationalState": {
2415 "description": "Match NS Packages with particular NS Operational State",
2419 "enum": ["ENABLED", "DISABLED"]
2423 "description": "Match NS Packages with particular NS Usage State",
2427 "enum": ["IN_USE", "NOT_IN_USE"]
2431 "description": "Match PF packages with particular pnfdInfoIds",
2439 "description": "Match PF packages with particular pnfdInfoIds",
2447 "description": "Match PF Packages with particular pnfdNames",
2456 "description": "match PF packages that belong to certain pnfd version",
2465 "description": "Match PF Packages with particular pnfdProvider",
2473 "pnfdInvariantId": {
2474 "description": "Match PF Packages with particular pnfdInvariantIds",
2481 "pnfdOnboardingState": {
2482 "description": "Match PF Packages with particular PNF Onboarding State ",
2486 "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
2490 "description": "Match PF Packages with particular PNF usage State",
2494 "enum": ["IN_USE", "NOT_IN_USE"]
2499 "NSDM_SUB_LinkSerializer": {
2501 "description": "Links to resources related to this resource.",
2502 "required": ["self"],
2506 "$ref": "#/definitions/UriLink"
2510 "NsdmSubscription": {
2511 "required": ["id", "callbackUri", "_links"],
2516 "description": "Identifier of this subscription resource.",
2522 "title": "Callbackuri",
2523 "description": "The URI of the endpoint to send the notification to.",
2529 "$ref": "#/definitions/NsdmNotificationsFilter"
2532 "$ref": "#/definitions/NSDM_SUB_LinkSerializer"
2537 "title": "Paramsbasic",
2538 "description": "Parameters for authentication/authorization using BASIC.",
2542 "title": "Username",
2543 "description": "Username to be used in HTTP Basic authentication.",
2549 "title": "Password",
2550 "description": "Password to be used in HTTP Basic authentication.",
2557 "OAuthCredentials": {
2558 "title": "Paramsoauth2clientcredentials",
2559 "description": "Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.",
2563 "title": "Clientid",
2564 "description": "Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type.",
2570 "title": "Clientpassword",
2571 "description": "Client password to be used in the access token request of the OAuth 2.0 client credentials grant type.",
2577 "title": "Tokenendpoint",
2578 "description": "The token endpoint from which the access token can be obtained.",
2585 "SubscriptionAuthentication": {
2586 "title": "Authentication",
2587 "description": "Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription.",
2588 "required": ["authType"],
2592 "description": "Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification.",
2596 "enum": ["BASIC", "OAUTH2_CLIENT_CREDENTIALS", "TLS_CERT"]
2600 "$ref": "#/definitions/BasicAuth"
2602 "paramsOauth2ClientCredentials": {
2603 "$ref": "#/definitions/OAuthCredentials"
2607 "NsdmSubscriptionRequest": {
2608 "required": ["callbackUri"],
2612 "title": "Callbackuri",
2613 "description": "The URI of the endpoint to send the notification to.",
2618 "$ref": "#/definitions/NsdmNotificationsFilter"
2621 "$ref": "#/definitions/SubscriptionAuthentication"
2625 "ParseModelRequest": {
2626 "required": ["csarId"],
2631 "description": "CSAR ID",
2636 "title": "Packagetype",
2637 "description": "Package type: VNF, PNF, NS, Service",
2643 "description": "Inputs",
2648 "ParseModelResponse": {
2649 "required": ["model"],
2654 "description": "Model",
2659 "VNF_SUBSCRIPTION_LINKSERIALIZER": {
2661 "description": "URI of this resource.",
2662 "required": ["href"],
2667 "description": "URI of the referenced resource.",
2675 "description": "Links to resources related to this resource.",
2676 "required": ["self"],
2680 "$ref": "#/definitions/VNF_SUBSCRIPTION_LINKSERIALIZER"
2685 "required": ["vnfSoftwareVersion"],
2688 "vnfSoftwareVersion": {
2689 "title": "Vnfsoftwareversion",
2690 "description": "VNF software version to match.",
2696 "description": "Match VNF packages that contain VNF products with certain VNFD versions",
2706 "required": ["vnfProductName"],
2710 "title": "Vnfproductname",
2711 "description": "Name of the VNF product to match.",
2717 "description": "match VNF packages that contain VNF products with certain versions",
2720 "$ref": "#/definitions/Version"
2725 "vnfProductsProviders": {
2726 "required": ["vnfProvider"],
2730 "title": "Vnfprovider",
2731 "description": "Name of the VNFprovider to match.",
2737 "description": "match VNF packages that contain VNF products with certain product names, from one particular provider",
2740 "$ref": "#/definitions/vnfProducts"
2745 "PkgmNotificationsFilter": {
2747 "description": "Filter settings for this subscription, to define the subset of all notifications this subscription relates to",
2750 "notificationTypes": {
2751 "description": "Match particular notification types",
2755 "enum": ["VnfPackageOnboardingNotification", "VnfPackageChangeNotification"]
2758 "vnfProductsFromProviders": {
2759 "description": "Match VNF packages that contain VNF products from certain providers.",
2762 "$ref": "#/definitions/vnfProductsProviders"
2766 "description": "Match VNF packages with a VNFD identifierlisted in the attribute",
2774 "description": "Match VNF packages with a VNFD identifierlisted in the attribute",
2781 "operationalState": {
2782 "description": "Operational state of the VNF package.",
2786 "enum": ["ENABLED", "DISABLED"]
2790 "description": "Operational state of the VNF package.",
2794 "enum": ["IN_USE", "NOT_IN_USE"]
2799 "PkgmSubscription": {
2800 "required": ["id", "callbackUri", "_links"],
2805 "description": "Identifier of this subscription resource.",
2810 "title": "Callbackuri",
2811 "description": "The URI of the endpoint to send the notification to.",
2817 "$ref": "#/definitions/LinkSelf"
2820 "$ref": "#/definitions/PkgmNotificationsFilter"
2824 "PkgmSubscriptionRequest": {
2825 "required": ["callbackUri"],
2829 "$ref": "#/definitions/PkgmNotificationsFilter"
2832 "title": "Callbackuri",
2833 "description": "Callback URI to sendthe notification",
2839 "$ref": "#/definitions/SubscriptionAuthentication"
2844 "title": "Checksum",
2845 "description": "Checksum of the on-boarded VNF package.",
2846 "required": ["algorithm", "hash"],
2850 "title": "Algorithm",
2851 "description": "Name of the algorithm used to generate the checksum.",
2857 "description": "The hexadecimal value of the checksum.",
2863 "VnfPackageSoftwareImageInfo": {
2864 "description": "Information about VNF package artifacts that are software images.",
2865 "required": ["id", "name", "provider", "version", "checksum", "containerFormat", "diskFormat", "createdAt", "minDisk", "minRam", "size", "imagePath"],
2870 "description": "Identifier of the software image.",
2876 "description": "Name of the software image.",
2881 "title": "Provider",
2882 "description": "Provider of the software image.",
2888 "description": "Version of the software image.",
2893 "$ref": "#/definitions/Checksum"
2895 "containerFormat": {
2896 "title": "Containerformat",
2897 "description": "terminationType: Indicates whether forceful or graceful termination is requested.",
2899 "enum": ["AKI", "AMI", "ARI", "BARE", "DOCKER", "OVA", "OVF"]
2902 "title": "Diskformat",
2903 "description": "Disk format of a software image is the format of the underlying disk image.",
2905 "enum": ["AKI", "AMI", "ARI", "ISO", "QCOW2", "RAW", "VDI", "VHD", "VHDX", "VMDK"]
2908 "title": "Createdat",
2909 "description": "Time when this software image was created.",
2911 "format": "date-time"
2915 "description": "The minimal disk for this software image in bytes.",
2920 "description": "The minimal RAM for this software image in bytes.",
2925 "description": "Size of this software image in bytes.",
2929 "title": "Usermetadata",
2930 "description": "User-defined data.",
2932 "additionalProperties": {
2933 "description": "KeyValue Pairs",
2939 "title": "Imagepath",
2940 "description": "Path in the VNF package.",
2946 "VnfPackageArtifactInfo": {
2947 "description": "Information about VNF package artifacts contained in the VNF package that are not software images.",
2948 "required": ["artifactPath", "checksum"],
2952 "title": "Artifactpath",
2953 "description": "Path in the VNF package.",
2958 "$ref": "#/definitions/Checksum"
2961 "title": "Metadata",
2962 "description": "The metadata of the artifact that are available in the VNF package",
2964 "additionalProperties": {
2965 "description": "KeyValue Pairs",
2972 "VNF_PKGM_Link_Serializer": {
2974 "description": "Links to resources related to this resource.",
2975 "required": ["self", "packageContent"],
2979 "$ref": "#/definitions/UriLink"
2982 "$ref": "#/definitions/UriLink"
2985 "$ref": "#/definitions/UriLink"
2990 "required": ["id", "onboardingState", "operationalState", "usageState", "_links"],
2995 "description": "Identifier of the on-boarded VNF package.",
3001 "description": "This identifier, which is managed by the VNF provider, identifies the VNF package and the VNFD in a globally unique way.",
3006 "title": "Vnfprovider",
3007 "description": "Provider of the VNF package and the VNFD.",
3012 "title": "Vnfproductname",
3013 "description": "Name to identify the VNF product.",
3017 "vnfSoftwareVersion": {
3018 "title": "Vnfsoftwareversion",
3019 "description": "Software version of the VNF.",
3024 "title": "Vnfdversion",
3025 "description": "The version of the VNvFD.",
3030 "$ref": "#/definitions/Checksum"
3033 "description": "Information about VNF package artifacts that are software images.",
3036 "$ref": "#/definitions/VnfPackageSoftwareImageInfo"
3040 "additionalArtifacts": {
3041 "description": "Information about VNF package artifacts contained in the VNF package that are not software images.",
3044 "$ref": "#/definitions/VnfPackageArtifactInfo"
3048 "onboardingState": {
3049 "title": "Onboardingstate",
3050 "description": "On-boarding state of the VNF package.",
3052 "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
3054 "operationalState": {
3055 "title": "Operationalstate",
3056 "description": "Operational state of the VNF package.",
3058 "enum": ["ENABLED", "DISABLED"]
3061 "title": "Usagestate",
3062 "description": "Usage state of the VNF package.",
3064 "enum": ["IN_USE", "NOT_IN_USE"]
3066 "userDefinedData": {
3067 "title": "Userdefineddata",
3068 "description": "User defined data for the VNF package.",
3070 "additionalProperties": {
3071 "description": "KeyValue Pairs",
3077 "$ref": "#/definitions/VNF_PKGM_Link_Serializer"
3081 "CreateVnfPkgInfoRequest": {
3084 "userDefinedData": {
3085 "title": "Userdefineddata",
3086 "description": "User defined data for the VNF package.",
3088 "additionalProperties": {
3089 "description": "KeyValue Pairs",
3096 "UploadVnfPackageFromUriRequest": {
3097 "required": ["addressInformation"],
3100 "addressInformation": {
3101 "title": "Addressinformation",
3102 "description": "Address information of the VNF package content.",
3107 "title": "Username",
3108 "description": "User name to be used for authentication.",
3113 "title": "Password",
3114 "description": "Password to be used for authentication.",