aboutsummaryrefslogtreecommitdiffstats
path: root/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src
diff options
context:
space:
mode:
authorwaqas.ikram <waqas.ikram@est.tech>2020-04-08 15:48:21 +0100
committerwaqas.ikram <waqas.ikram@est.tech>2020-04-09 15:57:53 +0100
commit12bfb7b86a783f63b8072ac67462202d59173940 (patch)
tree9c7699f462510d0fee349d28a577233a9cbfb23b /adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src
parent35121d207a7408414c2e46ba8afd76fb492101b1 (diff)
Refactor SOL003 Adapter to organize its modules
based on functions Change-Id: I10b2376a552272ac3b405b2dae718adcb7e1e489 Issue-ID: SO-2771 Signed-off-by: waqas.ikram <waqas.ikram@est.tech>
Diffstat (limited to 'adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src')
-rw-r--r--adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/ETSI-Catalog-API.json3121
-rw-r--r--adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFLifecycleManagement-API.json8143
-rw-r--r--adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFLifecycleManagementNotification-API.json1897
-rw-r--r--adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFLifecycleOperationGranting-API.json2774
-rw-r--r--adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFPackageManagement-API.json7352
5 files changed, 0 insertions, 23287 deletions
diff --git a/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/ETSI-Catalog-API.json b/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/ETSI-Catalog-API.json
deleted file mode 100644
index 35a8c2bd3d..0000000000
--- a/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/ETSI-Catalog-API.json
+++ /dev/null
@@ -1,3121 +0,0 @@
-{
- "swagger": "2.0",
- "info": {
- "title": "Modeling etsicatalog API",
- "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).",
- "version": "v1"
- },
- "host": "127.0.0.1:8806",
- "schemes": ["http"],
- "basePath": "/",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "securityDefinitions": {
- "Basic": {
- "type": "basic"
- }
- },
- "security": [{
- "Basic": []
- }],
- "paths": {
- "/api/catalog/v1/callback_sample": {
- "get": {
- "operationId": "api_catalog_v1_callback_sample_list",
- "description": "Callback Sample.",
- "parameters": [],
- "responses": {
- "200": {
- "description": ""
- }
- },
- "tags": ["Sample interface"]
- },
- "parameters": []
- },
- "/api/catalog/v1/health_check": {
- "get": {
- "operationId": "api_catalog_v1_health_check_list",
- "description": "",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Active"
- }
- },
- "tags": ["Health Check interface"]
- },
- "parameters": []
- },
- "/api/catalog/v1/jobs/{job_id}": {
- "get": {
- "operationId": "api_catalog_v1_jobs_read",
- "description": "Get job status",
- "parameters": [{
- "name": "job_id",
- "in": "query",
- "description": "job id",
- "type": "string"
- }, {
- "name": "responseId",
- "in": "query",
- "description": "response id",
- "type": "string"
- }],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/GetJobResponse"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/PostJobResponseResult"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "post": {
- "operationId": "api_catalog_v1_jobs_create",
- "description": "Update job status",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/PostJobRequest"
- }
- }, {
- "name": "job_id",
- "in": "query",
- "description": "job id",
- "type": "string"
- }],
- "responses": {
- "202": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/PostJobResponseResult"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/PostJobResponseResult"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "parameters": [{
- "name": "job_id",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/catalog/v1/mandb/{modelName}": {
- "get": {
- "operationId": "api_catalog_v1_mandb_read",
- "description": "",
- "parameters": [],
- "responses": {
- "200": {
- "description": ""
- }
- },
- "tags": ["Sample interface"]
- },
- "delete": {
- "operationId": "api_catalog_v1_mandb_delete",
- "description": "",
- "parameters": [],
- "responses": {
- "204": {
- "description": ""
- }
- },
- "tags": ["Sample interface"]
- },
- "parameters": [{
- "name": "modelName",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/catalog/v1/nspackages": {
- "get": {
- "operationId": "api_catalog_v1_nspackages_list",
- "description": "Query NS packages",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/NsPackage"
- }
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "post": {
- "operationId": "api_catalog_v1_nspackages_create",
- "description": "On distribute NS package",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/NsPackageDistributeRequest"
- }
- }],
- "responses": {
- "202": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/NsPackageDistributeResponse"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "parameters": []
- },
- "/api/catalog/v1/nspackages/{csarId}": {
- "get": {
- "operationId": "api_catalog_v1_nspackages_read",
- "description": "Query one NS package",
- "parameters": [{
- "name": "csarId",
- "in": "query",
- "description": "csarId",
- "type": "string"
- }],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/NsPackage"
- }
- },
- "500": {
- "description": "error message",
- "schema": {
- "type": "string"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "delete": {
- "operationId": "api_catalog_v1_nspackages_delete",
- "description": "Delete one NS package",
- "parameters": [{
- "name": "csarId",
- "in": "query",
- "description": "csarId",
- "type": "string"
- }],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/NsPackageDistributeResponse"
- }
- },
- "500": {
- "description": "error message",
- "schema": {
- "type": "string"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "parameters": [{
- "name": "csarId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/catalog/v1/service_packages": {
- "get": {
- "operationId": "api_catalog_v1_service_packages_list",
- "description": "Query Service packages",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ServicePackage"
- }
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "post": {
- "operationId": "api_catalog_v1_service_packages_create",
- "description": "On distribute Service package",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ServicePackageDistributeRequest"
- }
- }],
- "responses": {
- "202": {
- "description": ""
- },
- "400": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "parameters": []
- },
- "/api/catalog/v1/service_packages/{csarId}": {
- "get": {
- "operationId": "api_catalog_v1_service_packages_read",
- "description": "Query one Service package",
- "parameters": [{
- "name": "csarId",
- "in": "query",
- "description": "csarId",
- "type": "string"
- }],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/ServicePackage"
- }
- },
- "404": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "delete": {
- "operationId": "api_catalog_v1_service_packages_delete",
- "description": "Delete one Service package",
- "parameters": [{
- "name": "csarId",
- "in": "query",
- "description": "csarId",
- "type": "string"
- }],
- "responses": {
- "204": {
- "description": ""
- },
- "404": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "parameters": [{
- "name": "csarId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/catalog/v1/vnfpackages": {
- "get": {
- "operationId": "api_catalog_v1_vnfpackages_list",
- "description": "Query Nf packages",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/NfPackage"
- }
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "post": {
- "operationId": "api_catalog_v1_vnfpackages_create",
- "description": "On distribute Nf package",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/NfPackageDistributeRequest"
- }
- }],
- "responses": {
- "202": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/PostJobResponse"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "parameters": []
- },
- "/api/catalog/v1/vnfpackages/{csarId}": {
- "get": {
- "operationId": "api_catalog_v1_vnfpackages_read",
- "description": "Query one Nf package",
- "parameters": [{
- "name": "csarId",
- "in": "query",
- "description": "csarId",
- "type": "string"
- }],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/NfPackage"
- }
- },
- "500": {
- "description": "error message",
- "schema": {
- "type": "string"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "delete": {
- "operationId": "api_catalog_v1_vnfpackages_delete",
- "description": "Delete one Nf package",
- "parameters": [{
- "name": "csarId",
- "in": "query",
- "description": "csarId",
- "type": "string"
- }],
- "responses": {
- "202": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/PostJobResponse"
- }
- },
- "500": {
- "description": "error message",
- "schema": {
- "type": "string"
- }
- }
- },
- "tags": ["Catalog interface"]
- },
- "parameters": [{
- "name": "csarId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/nsd/v1/health_check": {
- "get": {
- "operationId": "api_nsd_v1_health_check_list",
- "description": "",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Active"
- }
- },
- "tags": ["Health Check interface"]
- },
- "parameters": []
- },
- "/api/nsd/v1/ns_descriptors": {
- "get": {
- "operationId": "api_nsd_v1_ns_descriptors_list",
- "description": "Query multiple NSDs",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/NsdInfo"
- }
- }
- },
- "500": {
- "description": "Internal error"
- }
- },
- "tags": ["NSD Management interface"]
- },
- "post": {
- "operationId": "api_nsd_v1_ns_descriptors_create",
- "description": "Create a NSD",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateNsdInfoRequest"
- }
- }],
- "responses": {
- "201": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/NsdInfo"
- }
- },
- "500": {
- "description": "Internal error"
- }
- },
- "tags": ["NSD Management interface"]
- },
- "parameters": []
- },
- "/api/nsd/v1/ns_descriptors/{nsdInfoId}": {
- "get": {
- "operationId": "api_nsd_v1_ns_descriptors_read",
- "description": "Query a NSD",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/NsdInfo"
- }
- },
- "404": {
- "description": "NSDs do not exist"
- },
- "500": {
- "description": "Internal error"
- }
- },
- "tags": ["NSD Management interface"]
- },
- "delete": {
- "operationId": "api_nsd_v1_ns_descriptors_delete",
- "description": "Delete a NSD",
- "parameters": [],
- "responses": {
- "204": {
- "description": "No content"
- },
- "500": {
- "description": "Internal error"
- }
- },
- "tags": ["NSD Management interface"]
- },
- "parameters": [{
- "name": "nsdInfoId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content": {
- "get": {
- "operationId": "api_nsd_v1_ns_descriptors_nsd_content_list",
- "description": "Download NSD content",
- "parameters": [],
- "responses": {
- "204": {
- "description": "No content"
- },
- "404": {
- "description": "NSD does not exist."
- },
- "500": {
- "description": "Internal error"
- }
- },
- "tags": ["NSD Management interface"]
- },
- "put": {
- "operationId": "api_nsd_v1_ns_descriptors_nsd_content_update",
- "description": "Upload NSD content",
- "parameters": [],
- "responses": {
- "204": {
- "description": "PNFD file"
- },
- "500": {
- "description": "Internal error"
- }
- },
- "tags": ["NSD Management interface"]
- },
- "parameters": [{
- "name": "nsdInfoId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/nsd/v1/pnf_descriptors": {
- "get": {
- "operationId": "api_nsd_v1_pnf_descriptors_list",
- "description": "Query multiple PNFDs",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/PnfdInfo"
- }
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["NSD Management interface"]
- },
- "post": {
- "operationId": "api_nsd_v1_pnf_descriptors_create",
- "description": "Create a PNFD",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreatePnfdInfoRequest"
- }
- }],
- "responses": {
- "201": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/PnfdInfo"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["NSD Management interface"]
- },
- "parameters": []
- },
- "/api/nsd/v1/pnf_descriptors/{pnfdInfoId}": {
- "get": {
- "operationId": "api_nsd_v1_pnf_descriptors_read",
- "description": "Query a PNFD",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/PnfdInfo"
- }
- },
- "404": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["NSD Management interface"]
- },
- "delete": {
- "operationId": "api_nsd_v1_pnf_descriptors_delete",
- "description": "Delete a PNFD",
- "parameters": [],
- "responses": {
- "204": {
- "description": "No content"
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["NSD Management interface"]
- },
- "parameters": [{
- "name": "pnfdInfoId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/nsd/v1/pnf_descriptors/{pnfdInfoId}/pnfd_content": {
- "get": {
- "operationId": "Fetch PNFD content",
- "description": "Fetch PNFD content",
- "parameters": [],
- "responses": {
- "200": {
- "description": "PNFD file",
- "schema": {
- "type": "string",
- "format": "binary"
- }
- },
- "404": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "produces": ["application/octet-stream", "application/json"],
- "tags": ["NSD Management interface"]
- },
- "put": {
- "operationId": "api_nsd_v1_pnf_descriptors_pnfd_content_update",
- "description": "Upload PNFD content",
- "parameters": [],
- "responses": {
- "204": {
- "description": "No content"
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["NSD Management interface"]
- },
- "parameters": [{
- "name": "pnfdInfoId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/nsd/v1/subscriptions": {
- "get": {
- "operationId": "api_nsd_v1_subscriptions_list",
- "description": "Query subscriptions for Nsd Management",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/NsdmSubscription"
- }
- }
- },
- "400": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "404": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["NSD Management interface"]
- },
- "post": {
- "operationId": "api_nsd_v1_subscriptions_create",
- "description": "Create Subscription for NSD Management",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/NsdmSubscriptionRequest"
- }
- }],
- "responses": {
- "201": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/NsdmSubscription"
- }
- },
- "303": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "400": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["NSD Management interface"]
- },
- "parameters": []
- },
- "/api/nsd/v1/subscriptions/{subscriptionId}": {
- "get": {
- "operationId": "api_nsd_v1_subscriptions_read",
- "description": "Query subscriptions for Nsd Management",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/NsdmSubscription"
- }
- },
- "400": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "404": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["NSD Management interface"]
- },
- "delete": {
- "operationId": "api_nsd_v1_subscriptions_delete",
- "description": "Delete subscription for Nsd Management",
- "parameters": [],
- "responses": {
- "204": {
- "description": "No_Content"
- },
- "400": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "404": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["NSD Management interface"]
- },
- "parameters": [{
- "name": "subscriptionId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/parser/v1/health_check": {
- "get": {
- "operationId": "api_parser_v1_health_check_list",
- "description": "",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Active"
- }
- },
- "tags": ["Health Check interface"]
- },
- "parameters": []
- },
- "/api/parser/v1/parser": {
- "post": {
- "operationId": "api_parser_v1_parser_create",
- "description": "Parse model(NS, Service, VNF, PNF)",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ParseModelRequest"
- }
- }],
- "responses": {
- "202": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/ParseModelResponse"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- }
- },
- "tags": ["Parser interface"]
- },
- "parameters": []
- },
- "/api/parser/v1/parsernsd": {
- "post": {
- "operationId": "api_parser_v1_parsernsd_create",
- "description": "Parse NS model",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ParseModelRequest"
- }
- }],
- "responses": {
- "202": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/ParseModelResponse"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- }
- },
- "tags": ["Parser interface"]
- },
- "parameters": []
- },
- "/api/parser/v1/parserpnfd": {
- "post": {
- "operationId": "api_parser_v1_parserpnfd_create",
- "description": "Parse PNF model",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ParseModelRequest"
- }
- }],
- "responses": {
- "202": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/ParseModelResponse"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- }
- },
- "tags": ["Parser interface"]
- },
- "parameters": []
- },
- "/api/parser/v1/parservnfd": {
- "post": {
- "operationId": "api_parser_v1_parservnfd_create",
- "description": "Parse NF model",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ParseModelRequest"
- }
- }],
- "responses": {
- "202": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/ParseModelResponse"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/InternalErrorRequest"
- }
- }
- },
- "tags": ["Parser interface"]
- },
- "parameters": []
- },
- "/api/vnfpkgm/v1/health_check": {
- "get": {
- "operationId": "api_vnfpkgm_v1_health_check_list",
- "description": "",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Active"
- }
- },
- "tags": ["Health Check interface"]
- },
- "parameters": []
- },
- "/api/vnfpkgm/v1/subscriptions": {
- "get": {
- "operationId": "api_vnfpkgm_v1_subscriptions_list",
- "description": "",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/PkgmSubscription"
- }
- },
- "400": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["VNF Package Management interface"]
- },
- "post": {
- "operationId": "api_vnfpkgm_v1_subscriptions_create",
- "description": "",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/PkgmSubscriptionRequest"
- }
- }],
- "responses": {
- "201": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/PkgmSubscription"
- }
- },
- "400": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["VNF Package Management interface"]
- },
- "parameters": []
- },
- "/api/vnfpkgm/v1/subscriptions/{subscriptionId}": {
- "get": {
- "operationId": "api_vnfpkgm_v1_subscriptions_read",
- "description": "",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/PkgmSubscription"
- }
- },
- "404": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["VNF Package Management interface"]
- },
- "delete": {
- "operationId": "api_vnfpkgm_v1_subscriptions_delete",
- "description": "",
- "parameters": [],
- "responses": {
- "204": {
- "description": ""
- },
- "404": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- },
- "500": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/SUBSCRIPTION_ProblemDetailsSerializer"
- }
- }
- },
- "tags": ["VNF Package Management interface"]
- },
- "parameters": [{
- "name": "subscriptionId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/vnfpkgm/v1/vnf_packages": {
- "get": {
- "operationId": "api_vnfpkgm_v1_vnf_packages_list",
- "description": "Query multiple VNF package resource",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/VnfPkgInfo"
- }
- }
- },
- "500": {
- "description": "Internal error",
- "schema": {
- "type": "string"
- }
- }
- },
- "tags": ["VNF Package Management interface"]
- },
- "post": {
- "operationId": "api_vnfpkgm_v1_vnf_packages_create",
- "description": "Create an individual VNF package resource",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateVnfPkgInfoRequest"
- }
- }],
- "responses": {
- "201": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/VnfPkgInfo"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "type": "string"
- }
- },
- "500": {
- "description": "Internal error",
- "schema": {
- "type": "string"
- }
- }
- },
- "tags": ["VNF Package Management interface"]
- },
- "parameters": []
- },
- "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}": {
- "get": {
- "operationId": "api_vnfpkgm_v1_vnf_packages_read",
- "description": "Query an individual VNF package resource",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/VnfPkgInfo"
- }
- },
- "404": {
- "description": "VNF package does not exist",
- "schema": {
- "type": "string"
- }
- },
- "500": {
- "description": "Internal error",
- "schema": {
- "type": "string"
- }
- }
- },
- "tags": ["VNF Package Management interface"]
- },
- "delete": {
- "operationId": "api_vnfpkgm_v1_vnf_packages_delete",
- "description": "Delete an individual VNF package resource",
- "parameters": [],
- "responses": {
- "204": {
- "description": "No content"
- },
- "500": {
- "description": "Internal error",
- "schema": {
- "type": "string"
- }
- }
- },
- "tags": ["VNF Package Management interface"]
- },
- "parameters": [{
- "name": "vnfPkgId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}": {
- "get": {
- "operationId": "api_vnfpkgm_v1_vnf_packages_artifacts_read",
- "description": "",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Return the artifact file",
- "schema": {
- "type": "string",
- "format": "binary"
- }
- },
- "404": {
- "description": "Artifact not found",
- "schema": {
- "type": "string"
- }
- },
- "500": {
- "description": "Internal error",
- "schema": {
- "type": "string"
- }
- }
- },
- "produces": ["application/octet-stream", "application/json"],
- "tags": ["VNF Package Management interface"]
- },
- "parameters": [{
- "name": "artifactPath",
- "in": "path",
- "required": true,
- "type": "string"
- }, {
- "name": "vnfPkgId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content": {
- "get": {
- "operationId": "api_vnfpkgm_v1_vnf_packages_package_content_list",
- "description": "Fetch VNF package content",
- "parameters": [],
- "responses": {
- "200": {
- "description": "VNF package file",
- "schema": {
- "type": "string",
- "format": "binary"
- }
- },
- "404": {
- "description": "VNF package does not exist",
- "schema": {
- "type": "string"
- }
- },
- "500": {
- "description": "Internal error",
- "schema": {
- "type": "string"
- }
- }
- },
- "produces": ["application/octet-stream", "application/json"],
- "tags": ["VNF Package Management interface"]
- },
- "put": {
- "operationId": "api_vnfpkgm_v1_vnf_packages_package_content_update",
- "description": "Upload VNF package content",
- "parameters": [],
- "responses": {
- "202": {
- "description": "Successfully"
- },
- "500": {
- "description": "Internal error",
- "schema": {
- "type": "string"
- }
- }
- },
- "tags": ["VNF Package Management interface"]
- },
- "parameters": [{
- "name": "vnfPkgId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content/upload_from_uri": {
- "post": {
- "operationId": "api_vnfpkgm_v1_vnf_packages_package_content_upload_from_uri_create",
- "description": "Upload VNF package content from uri",
- "parameters": [{
- "name": "data",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/UploadVnfPackageFromUriRequest"
- }
- }],
- "responses": {
- "202": {
- "description": "Successfully"
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "type": "string"
- }
- },
- "500": {
- "description": "Internal error",
- "schema": {
- "type": "string"
- }
- }
- },
- "tags": ["VNF Package Management interface"]
- },
- "parameters": [{
- "name": "vnfPkgId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd": {
- "get": {
- "operationId": "VNFD of an on-boarded VNF package",
- "description": "Read VNFD of an on-boarded VNF package",
- "parameters": [],
- "responses": {
- "200": {
- "description": "VNFD of an on-boarded VNF package",
- "schema": {
- "type": "string",
- "format": "binary"
- }
- },
- "404": {
- "description": "VNF package does not exist",
- "schema": {
- "type": "string"
- }
- },
- "500": {
- "description": "Internal error",
- "schema": {
- "type": "string"
- }
- }
- },
- "produces": ["application/octet-stream", "application/json"],
- "tags": ["VNF Package Management interface"]
- },
- "parameters": [{
- "name": "vnfPkgId",
- "in": "path",
- "required": true,
- "type": "string"
- }]
- },
- "/samples/": {
- "get": {
- "operationId": "samples_list",
- "description": "List all samples.",
- "parameters": [],
- "responses": {
- "200": {
- "description": ""
- }
- },
- "tags": ["Sample interface"]
- },
- "parameters": []
- }
- },
- "definitions": {
- "JobResponseHistoryList": {
- "description": "Response History List",
- "type": "object",
- "properties": {
- "status": {
- "title": "Status",
- "description": "Status",
- "type": "string",
- "minLength": 1
- },
- "progress": {
- "title": "Progress",
- "description": "Job Progress",
- "type": "string",
- "minLength": 1
- },
- "statusDescription": {
- "title": "Statusdescription",
- "description": "Status Description",
- "type": "string",
- "minLength": 1
- },
- "errorCode": {
- "title": "Errorcode",
- "description": "Error Code",
- "type": "string",
- "minLength": 1,
- "x-nullable": true
- },
- "responseId": {
- "title": "Responseid",
- "description": "Response Id",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "JobResponseDescriptor": {
- "title": "Responsedescriptor",
- "description": "Job Response Descriptor",
- "type": "object",
- "properties": {
- "status": {
- "title": "Status",
- "description": "Status",
- "type": "string",
- "minLength": 1
- },
- "progress": {
- "title": "Progress",
- "description": "Job Progress",
- "type": "string",
- "minLength": 1
- },
- "statusDescription": {
- "title": "Statusdescription",
- "description": "Status Description",
- "type": "string",
- "minLength": 1
- },
- "errorCode": {
- "title": "Errorcode",
- "description": "Error Code",
- "type": "string",
- "minLength": 1,
- "x-nullable": true
- },
- "responseId": {
- "title": "Responseid",
- "description": "Response Id",
- "type": "string",
- "minLength": 1
- },
- "responseHistoryList": {
- "description": "Response History List",
- "type": "array",
- "items": {
- "$ref": "#/definitions/JobResponseHistoryList"
- }
- }
- }
- },
- "GetJobResponse": {
- "type": "object",
- "properties": {
- "jobId": {
- "title": "Jobid",
- "description": "Job Id",
- "type": "string",
- "minLength": 1
- },
- "responseDescriptor": {
- "$ref": "#/definitions/JobResponseDescriptor"
- }
- }
- },
- "PostJobResponseResult": {
- "required": ["result"],
- "type": "object",
- "properties": {
- "result": {
- "title": "Result",
- "description": "Result",
- "type": "string",
- "minLength": 1
- },
- "msg": {
- "title": "Msg",
- "description": "Message",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "PostJobRequest": {
- "type": "object",
- "properties": {
- "progress": {
- "title": "Progress",
- "description": "Job Progress",
- "type": "string",
- "minLength": 1
- },
- "desc": {
- "title": "Desc",
- "description": "Description",
- "type": "string",
- "minLength": 1
- },
- "errcode": {
- "title": "Errcode",
- "description": "Error Code",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "NsPackageInfo": {
- "title": "Packageinfo",
- "description": "NS Package Info",
- "type": "object",
- "properties": {
- "nsdId": {
- "title": "Nsdid",
- "description": "NSD ID",
- "type": "string",
- "minLength": 1,
- "x-nullable": true
- },
- "nsPackageId": {
- "title": "Nspackageid",
- "description": "NS Package ID",
- "type": "string",
- "x-nullable": true
- },
- "nsdProvider": {
- "title": "Nsdprovider",
- "description": "NSD Provider",
- "type": "string",
- "x-nullable": true
- },
- "nsdVersion": {
- "title": "Nsdversion",
- "description": "NSD Version",
- "type": "string",
- "x-nullable": true
- },
- "csarName": {
- "title": "Csarname",
- "description": "CSAR name",
- "type": "string",
- "x-nullable": true
- },
- "nsdModel": {
- "title": "Nsdmodel",
- "description": "NSD Model",
- "type": "string",
- "x-nullable": true
- },
- "downloadUrl": {
- "title": "Downloadurl",
- "description": "URL to download NSD Model",
- "type": "string",
- "minLength": 1,
- "x-nullable": true
- }
- },
- "x-nullable": true
- },
- "NsPackage": {
- "type": "object",
- "properties": {
- "csarId": {
- "title": "Csarid",
- "description": "CSAR ID",
- "type": "string",
- "minLength": 1,
- "x-nullable": true
- },
- "packageInfo": {
- "$ref": "#/definitions/NsPackageInfo"
- }
- }
- },
- "InternalErrorRequest": {
- "required": ["error"],
- "type": "object",
- "properties": {
- "error": {
- "title": "Error",
- "description": "Error",
- "type": "string",
- "minLength": 1
- },
- "errorMessage": {
- "title": "Errormessage",
- "description": "Error Message",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "NsPackageDistributeRequest": {
- "required": ["csarId"],
- "type": "object",
- "properties": {
- "csarId": {
- "title": "Csarid",
- "description": "csarId",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "NsPackageDistributeResponse": {
- "required": ["status", "statusDescription", "errorCode"],
- "type": "object",
- "properties": {
- "status": {
- "title": "Status",
- "description": "status",
- "type": "string",
- "minLength": 1
- },
- "statusDescription": {
- "title": "Statusdescription",
- "description": "statusDescription",
- "type": "string",
- "minLength": 1
- },
- "errorCode": {
- "title": "Errorcode",
- "description": "errorCode",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "ServicePackageInfo": {
- "title": "Packageinfo",
- "description": "Service Package Info",
- "type": "object",
- "properties": {
- "servicedId": {
- "title": "Servicedid",
- "description": "ServiceD ID",
- "type": "string",
- "minLength": 1,
- "x-nullable": true
- },
- "servicePackageId": {
- "title": "Servicepackageid",
- "description": "Service Package ID",
- "type": "string",
- "x-nullable": true
- },
- "servicedProvider": {
- "title": "Servicedprovider",
- "description": "ServiceD Provider",
- "type": "string",
- "x-nullable": true
- },
- "servicedVersion": {
- "title": "Servicedversion",
- "description": "ServiceD Version",
- "type": "string",
- "x-nullable": true
- },
- "csarName": {
- "title": "Csarname",
- "description": "CSAR name",
- "type": "string",
- "x-nullable": true
- },
- "servicedModel": {
- "title": "Servicedmodel",
- "description": "ServiceD Model",
- "type": "string",
- "x-nullable": true
- },
- "downloadUrl": {
- "title": "Downloadurl",
- "description": "URL to download ServiceD Model",
- "type": "string",
- "minLength": 1,
- "x-nullable": true
- }
- },
- "x-nullable": true
- },
- "ServicePackage": {
- "type": "object",
- "properties": {
- "csarId": {
- "title": "Csarid",
- "description": "CSAR ID",
- "type": "string",
- "minLength": 1,
- "x-nullable": true
- },
- "packageInfo": {
- "$ref": "#/definitions/ServicePackageInfo"
- }
- }
- },
- "ServicePackageDistributeRequest": {
- "required": ["csarId"],
- "type": "object",
- "properties": {
- "csarId": {
- "title": "Csarid",
- "description": "csarId",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "NfPackageInfo": {
- "title": "Packageinfo",
- "description": "VNF Package Info",
- "required": ["vnfPackageId"],
- "type": "object",
- "properties": {
- "vnfdId": {
- "title": "Vnfdid",
- "description": "VNFD ID",
- "type": "string",
- "x-nullable": true
- },
- "vnfPackageId": {
- "title": "Vnfpackageid",
- "description": "VNF Package ID",
- "type": "string",
- "minLength": 1
- },
- "vnfdProvider": {
- "title": "Vnfdprovider",
- "description": "VNFD Provider",
- "type": "string",
- "x-nullable": true
- },
- "vnfdVersion": {
- "title": "Vnfdversion",
- "description": "VNFD Version",
- "type": "string",
- "x-nullable": true
- },
- "vnfVersion": {
- "title": "Vnfversion",
- "description": "VNF Version",
- "type": "string",
- "x-nullable": true
- },
- "csarName": {
- "title": "Csarname",
- "description": "CSAR Name",
- "type": "string",
- "x-nullable": true
- },
- "vnfdModel": {
- "title": "Vnfdmodel",
- "description": "VNFD Model",
- "type": "string",
- "x-nullable": true
- },
- "downloadUrl": {
- "title": "Downloadurl",
- "description": "URL to download VNFD Model",
- "type": "string",
- "x-nullable": true
- }
- }
- },
- "NfImageInfo": {
- "description": "Image Info",
- "required": ["index", "fileName", "imageId", "vimId", "vimUser", "tenant", "status"],
- "type": "object",
- "properties": {
- "index": {
- "title": "Index",
- "description": "Index of VNF Image",
- "type": "string",
- "minLength": 1
- },
- "fileName": {
- "title": "Filename",
- "description": "Image file name",
- "type": "string",
- "minLength": 1
- },
- "imageId": {
- "title": "Imageid",
- "description": "Image ID",
- "type": "string",
- "minLength": 1
- },
- "vimId": {
- "title": "Vimid",
- "description": "VIM ID",
- "type": "string",
- "minLength": 1
- },
- "vimUser": {
- "title": "Vimuser",
- "description": "User of VIM",
- "type": "string",
- "minLength": 1
- },
- "tenant": {
- "title": "Tenant",
- "description": "Tenant",
- "type": "string",
- "minLength": 1
- },
- "status": {
- "title": "Status",
- "description": "Status",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "NfPackage": {
- "required": ["csarId", "packageInfo"],
- "type": "object",
- "properties": {
- "csarId": {
- "title": "Csarid",
- "description": "CSAR ID",
- "type": "string",
- "minLength": 1
- },
- "packageInfo": {
- "$ref": "#/definitions/NfPackageInfo"
- },
- "imageInfo": {
- "description": "Image Info",
- "type": "array",
- "items": {
- "$ref": "#/definitions/NfImageInfo"
- },
- "x-nullable": true
- }
- }
- },
- "NfPackageDistributeRequest": {
- "required": ["csarId"],
- "type": "object",
- "properties": {
- "csarId": {
- "title": "Csarid",
- "description": "CSAR ID",
- "type": "string",
- "minLength": 1
- },
- "vimIds": {
- "description": "A string for vimIds",
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- },
- "labVimId": {
- "title": "Labvimid",
- "description": "A list of VIM IDs.",
- "type": "string"
- }
- }
- },
- "PostJobResponse": {
- "required": ["jobId"],
- "type": "object",
- "properties": {
- "jobId": {
- "title": "Jobid",
- "description": "jobId",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "ProblemDetails": {
- "title": "Onboardingfailuredetails",
- "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.",
- "required": ["title", "detail"],
- "type": "object",
- "properties": {
- "type": {
- "title": "Type",
- "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\".",
- "type": "string",
- "x-nullable": true
- },
- "title": {
- "title": "Title",
- "description": "The HTTP status code for this occurrence of the problem.",
- "type": "integer"
- },
- "detail": {
- "title": "Detail",
- "description": "A human-readable explanation specific to this occurrence of the problem.",
- "type": "string",
- "minLength": 1
- },
- "instance": {
- "title": "Instance",
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.",
- "type": "string",
- "x-nullable": true
- },
- "additional_attributes": {
- "title": "Additional attributes",
- "description": "Any number of additional attributes, as defined in a specification or by an implementation.",
- "type": "object",
- "additionalProperties": {
- "description": "Additional attribute",
- "type": "string"
- },
- "x-nullable": true
- }
- }
- },
- "UriLink": {
- "title": "Self",
- "description": "URI of this resource.",
- "required": ["href"],
- "type": "object",
- "properties": {
- "href": {
- "title": "Href",
- "description": "URI of the referenced resource",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "NSD_LinkSerializer": {
- "title": " links",
- "description": "Links to resources related to this resource.",
- "required": ["self", "nsd_content"],
- "type": "object",
- "properties": {
- "self": {
- "$ref": "#/definitions/UriLink"
- },
- "nsd_content": {
- "$ref": "#/definitions/UriLink"
- }
- }
- },
- "NsdInfo": {
- "required": ["id", "nsdOnboardingState", "nsdOperationalState", "nsdUsageState", "_links"],
- "type": "object",
- "properties": {
- "id": {
- "title": "Id",
- "description": "Identifier of the onboarded individual NS descriptor resource.This identifier is allocated by the NFVO.",
- "type": "string",
- "minLength": 1
- },
- "nsdId": {
- "title": "Nsdid",
- "description": "This identifier, which is allocated by the NSD designer,identifies the NSD in a globally unique way.It is copied from the NSD content and shall be present after the NSD content is on-boarded.",
- "type": "string",
- "x-nullable": true
- },
- "nsdName": {
- "title": "Nsdname",
- "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.",
- "type": "string",
- "x-nullable": true
- },
- "nsdVersion": {
- "title": "Nsdversion",
- "description": "Version of the on-boarded NSD.This information is copied from the NSD content and shall be present after the NSD content is on-boarded.",
- "type": "string",
- "x-nullable": true
- },
- "nsdDesigner": {
- "title": "Nsddesigner",
- "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.",
- "type": "string",
- "x-nullable": true
- },
- "nsdInvariantId": {
- "title": "Nsdinvariantid",
- "description": "This identifier, which is allocated by the NSD designer,identifies an NSD in a version independent manner.This information is copied from the NSD content and shall be present after the NSD content is on-boarded.",
- "type": "string",
- "x-nullable": true
- },
- "vnfPkgIds": {
- "description": "Identifies the VNF package for the VNFD referenced by the on-boarded NS descriptor resource.",
- "type": "array",
- "items": {
- "description": "Identifier of the VNF package",
- "type": "string"
- },
- "x-nullable": true
- },
- "pnfdInfoIds": {
- "description": "Identifies the PnfdInfo element for the PNFD referenced by the on-boarded NS descriptor resource.",
- "type": "array",
- "items": {
- "description": "Identifier of the PnfdInfo element",
- "type": "string"
- },
- "x-nullable": true
- },
- "nestedNsdInfoIds": {
- "description": "Identifies the NsdInfo element for the nested NSD referenced by the on-boarded NS descriptor resource.",
- "type": "array",
- "items": {
- "description": "Identifier of the NsdInfo element",
- "type": "string"
- },
- "x-nullable": true
- },
- "nsdOnboardingState": {
- "title": "Nsdonboardingstate",
- "description": "Onboarding state of the individual NS descriptor resource.",
- "type": "string",
- "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
- },
- "onboardingFailureDetails": {
- "$ref": "#/definitions/ProblemDetails"
- },
- "nsdOperationalState": {
- "title": "Nsdoperationalstate",
- "description": "Operational state of the individual NS descriptor resource.This attribute can be modified with the PATCH method.",
- "type": "string",
- "enum": ["ENABLED", "DISABLED"]
- },
- "nsdUsageState": {
- "title": "Nsdusagestate",
- "description": "Usage state of the individual NS descriptor resource.",
- "type": "string",
- "enum": ["IN_USE", "NOT_IN_USE"]
- },
- "userDefinedData": {
- "title": "Userdefineddata",
- "description": "User defined data for the individual NS descriptor resource.This attribute can be modified with the PATCH method.",
- "type": "object",
- "additionalProperties": {
- "description": "Key Value Pairs",
- "type": "string"
- },
- "x-nullable": true
- },
- "_links": {
- "$ref": "#/definitions/NSD_LinkSerializer"
- }
- }
- },
- "CreateNsdInfoRequest": {
- "type": "object",
- "properties": {
- "userDefinedData": {
- "title": "Userdefineddata",
- "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.",
- "type": "object",
- "additionalProperties": {
- "description": "Key Value Pairs",
- "type": "string"
- },
- "x-nullable": true
- }
- }
- },
- "PNFD_LinkSerializer": {
- "title": " links",
- "description": "Links to resources related to this resource.",
- "required": ["self", "pnfd_content"],
- "type": "object",
- "properties": {
- "self": {
- "$ref": "#/definitions/UriLink"
- },
- "pnfd_content": {
- "$ref": "#/definitions/UriLink"
- }
- }
- },
- "PnfdInfo": {
- "required": ["id", "pnfdOnboardingState", "pnfdUsageState", "_links"],
- "type": "object",
- "properties": {
- "id": {
- "title": "Id",
- "description": "Identifier of the onboarded individual PNF descriptor resource. This identifier is allocated by the NFVO.",
- "type": "string",
- "minLength": 1
- },
- "pnfdId": {
- "title": "Pnfdid",
- "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.",
- "type": "string",
- "x-nullable": true
- },
- "pnfdName": {
- "title": "Pnfdname",
- "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.",
- "type": "string",
- "x-nullable": true
- },
- "pnfdVersion": {
- "title": "Pnfdversion",
- "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.",
- "type": "string",
- "x-nullable": true
- },
- "pnfdProvider": {
- "title": "Pnfdprovider",
- "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.",
- "type": "string",
- "x-nullable": true
- },
- "pnfdInvariantId": {
- "title": "Pnfdinvariantid",
- "description": "Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD.",
- "type": "string",
- "x-nullable": true
- },
- "pnfdOnboardingState": {
- "title": "Pnfdonboardingstate",
- "description": "Onboarding state of the individual PNF descriptor resource.",
- "type": "string",
- "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
- },
- "onboardingFailureDetails": {
- "$ref": "#/definitions/ProblemDetails"
- },
- "pnfdUsageState": {
- "title": "Pnfdusagestate",
- "description": "Usage state of the individual PNF descriptor resource.",
- "type": "string",
- "enum": ["IN_USE", "NOT_IN_USE"]
- },
- "userDefinedData": {
- "title": "Userdefineddata",
- "description": "User defined data for the individual PNF descriptor resource. This attribute can be modified with the PATCH method.",
- "type": "object",
- "additionalProperties": {
- "description": "Key Value Pairs",
- "type": "string"
- },
- "x-nullable": true
- },
- "_links": {
- "$ref": "#/definitions/PNFD_LinkSerializer"
- }
- }
- },
- "SUBSCRIPTION_ProblemDetailsSerializer": {
- "required": ["status", "detail"],
- "type": "object",
- "properties": {
- "type": {
- "title": "Type",
- "description": "Type",
- "type": "string",
- "minLength": 1,
- "x-nullable": true
- },
- "title": {
- "title": "Title",
- "description": "Title",
- "type": "string",
- "minLength": 1,
- "x-nullable": true
- },
- "status": {
- "title": "Status",
- "description": "Status",
- "type": "integer"
- },
- "detail": {
- "title": "Detail",
- "description": "Detail",
- "type": "string",
- "minLength": 1
- },
- "instance": {
- "title": "Instance",
- "description": "Instance",
- "type": "string",
- "minLength": 1,
- "x-nullable": true
- },
- "additional_details": {
- "description": "Any number of additional attributes, as defined in a specification or by an implementation.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-nullable": true
- }
- }
- },
- "CreatePnfdInfoRequest": {
- "type": "object",
- "properties": {
- "userDefinedData": {
- "title": "Userdefineddata",
- "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.",
- "type": "object",
- "additionalProperties": {
- "description": "Key Value Pairs",
- "type": "string"
- },
- "x-nullable": true
- }
- }
- },
- "NsdmNotificationsFilter": {
- "title": "Filter",
- "description": "Filter settings for this subscription, to define the of all notifications this subscription relates to.",
- "type": "object",
- "properties": {
- "notificationTypes": {
- "description": "Match particular notification types",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["NsdOnBoardingNotification", "NsdOnboardingFailureNotification", "NsdChangeNotification", "NsdDeletionNotification", "PnfdOnBoardingNotification", "PnfdOnBoardingFailureNotification", "PnfdDeletionNotification"]
- }
- },
- "nsdInfoId": {
- "description": "Match NS packages with particular nsdInfoIds",
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- },
- "nsdId": {
- "description": "Match NS Packages with particular nsdIds",
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- },
- "nsdName": {
- "description": "Match NS Packages with particular nsdNames",
- "type": "array",
- "items": {
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- }
- },
- "nsdVersion": {
- "description": "match NS packages that belong to certain nsdversion",
- "type": "array",
- "items": {
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- }
- },
- "nsdInvariantId": {
- "description": "Match NS Packages with particular nsdInvariantIds",
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- },
- "vnfPkgIds": {
- "description": "Match NS Packages that has VNF PackageIds",
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- },
- "nestedNsdInfoIds": {
- "description": "Match NS Packages with particular nsdInvariantIds",
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- },
- "nsdOnboardingState": {
- "description": "Match NS Packages with particular NS Onboarding State",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
- }
- },
- "nsdOperationalState": {
- "description": "Match NS Packages with particular NS Operational State",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["ENABLED", "DISABLED"]
- }
- },
- "nsdUsageState": {
- "description": "Match NS Packages with particular NS Usage State",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["IN_USE", "NOT_IN_USE"]
- }
- },
- "pnfdInfoIds": {
- "description": "Match PF packages with particular pnfdInfoIds",
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- },
- "pnfdId": {
- "description": "Match PF packages with particular pnfdInfoIds",
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- },
- "pnfdName": {
- "description": "Match PF Packages with particular pnfdNames",
- "type": "array",
- "items": {
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- }
- },
- "pnfdVersion": {
- "description": "match PF packages that belong to certain pnfd version",
- "type": "array",
- "items": {
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- }
- },
- "pnfdProvider": {
- "description": "Match PF Packages with particular pnfdProvider",
- "type": "array",
- "items": {
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- }
- },
- "pnfdInvariantId": {
- "description": "Match PF Packages with particular pnfdInvariantIds",
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- },
- "pnfdOnboardingState": {
- "description": "Match PF Packages with particular PNF Onboarding State ",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
- }
- },
- "pnfdUsageState": {
- "description": "Match PF Packages with particular PNF usage State",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["IN_USE", "NOT_IN_USE"]
- }
- }
- }
- },
- "NSDM_SUB_LinkSerializer": {
- "title": " links",
- "description": "Links to resources related to this resource.",
- "required": ["self"],
- "type": "object",
- "properties": {
- "self": {
- "$ref": "#/definitions/UriLink"
- }
- }
- },
- "NsdmSubscription": {
- "required": ["id", "callbackUri", "_links"],
- "type": "object",
- "properties": {
- "id": {
- "title": "Id",
- "description": "Identifier of this subscription resource.",
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- },
- "callbackUri": {
- "title": "Callbackuri",
- "description": "The URI of the endpoint to send the notification to.",
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- },
- "filter": {
- "$ref": "#/definitions/NsdmNotificationsFilter"
- },
- "_links": {
- "$ref": "#/definitions/NSDM_SUB_LinkSerializer"
- }
- }
- },
- "BasicAuth": {
- "title": "Paramsbasic",
- "description": "Parameters for authentication/authorization using BASIC.",
- "type": "object",
- "properties": {
- "userName": {
- "title": "Username",
- "description": "Username to be used in HTTP Basic authentication.",
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- },
- "password": {
- "title": "Password",
- "description": "Password to be used in HTTP Basic authentication.",
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- }
- }
- },
- "OAuthCredentials": {
- "title": "Paramsoauth2clientcredentials",
- "description": "Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.",
- "type": "object",
- "properties": {
- "clientId": {
- "title": "Clientid",
- "description": "Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type.",
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- },
- "clientPassword": {
- "title": "Clientpassword",
- "description": "Client password to be used in the access token request of the OAuth 2.0 client credentials grant type.",
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- },
- "tokenEndpoint": {
- "title": "Tokenendpoint",
- "description": "The token endpoint from which the access token can be obtained.",
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- }
- }
- },
- "SubscriptionAuthentication": {
- "title": "Authentication",
- "description": "Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription.",
- "required": ["authType"],
- "type": "object",
- "properties": {
- "authType": {
- "description": "Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["BASIC", "OAUTH2_CLIENT_CREDENTIALS", "TLS_CERT"]
- }
- },
- "paramsBasic": {
- "$ref": "#/definitions/BasicAuth"
- },
- "paramsOauth2ClientCredentials": {
- "$ref": "#/definitions/OAuthCredentials"
- }
- }
- },
- "NsdmSubscriptionRequest": {
- "required": ["callbackUri"],
- "type": "object",
- "properties": {
- "callbackUri": {
- "title": "Callbackuri",
- "description": "The URI of the endpoint to send the notification to.",
- "type": "string",
- "minLength": 1
- },
- "filter": {
- "$ref": "#/definitions/NsdmNotificationsFilter"
- },
- "authentication": {
- "$ref": "#/definitions/SubscriptionAuthentication"
- }
- }
- },
- "ParseModelRequest": {
- "required": ["csarId"],
- "type": "object",
- "properties": {
- "csarId": {
- "title": "Csarid",
- "description": "CSAR ID",
- "type": "string",
- "minLength": 1
- },
- "packageType": {
- "title": "Packagetype",
- "description": "Package type: VNF, PNF, NS, Service",
- "type": "string",
- "minLength": 1
- },
- "inputs": {
- "title": "Inputs",
- "description": "Inputs",
- "type": "object"
- }
- }
- },
- "ParseModelResponse": {
- "required": ["model"],
- "type": "object",
- "properties": {
- "model": {
- "title": "Model",
- "description": "Model",
- "type": "object"
- }
- }
- },
- "VNF_SUBSCRIPTION_LINKSERIALIZER": {
- "title": "Self",
- "description": "URI of this resource.",
- "required": ["href"],
- "type": "object",
- "properties": {
- "href": {
- "title": "Href",
- "description": "URI of the referenced resource.",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "LinkSelf": {
- "title": " links",
- "description": "Links to resources related to this resource.",
- "required": ["self"],
- "type": "object",
- "properties": {
- "self": {
- "$ref": "#/definitions/VNF_SUBSCRIPTION_LINKSERIALIZER"
- }
- }
- },
- "Version": {
- "required": ["vnfSoftwareVersion"],
- "type": "object",
- "properties": {
- "vnfSoftwareVersion": {
- "title": "Vnfsoftwareversion",
- "description": "VNF software version to match.",
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- },
- "vnfdVersions": {
- "description": "Match VNF packages that contain VNF products with certain VNFD versions",
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- }
- }
- },
- "vnfProducts": {
- "required": ["vnfProductName"],
- "type": "object",
- "properties": {
- "vnfProductName": {
- "title": "Vnfproductname",
- "description": "Name of the VNF product to match.",
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- },
- "versions": {
- "description": "match VNF packages that contain VNF products with certain versions",
- "type": "array",
- "items": {
- "$ref": "#/definitions/Version"
- }
- }
- }
- },
- "vnfProductsProviders": {
- "required": ["vnfProvider"],
- "type": "object",
- "properties": {
- "vnfProvider": {
- "title": "Vnfprovider",
- "description": "Name of the VNFprovider to match.",
- "type": "string",
- "maxLength": 255,
- "minLength": 1
- },
- "vnfProducts": {
- "description": "match VNF packages that contain VNF products with certain product names, from one particular provider",
- "type": "array",
- "items": {
- "$ref": "#/definitions/vnfProducts"
- }
- }
- }
- },
- "PkgmNotificationsFilter": {
- "title": "Filter",
- "description": "Filter settings for this subscription, to define the subset of all notifications this subscription relates to",
- "type": "object",
- "properties": {
- "notificationTypes": {
- "description": "Match particular notification types",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["VnfPackageOnboardingNotification", "VnfPackageChangeNotification"]
- }
- },
- "vnfProductsFromProviders": {
- "description": "Match VNF packages that contain VNF products from certain providers.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/vnfProductsProviders"
- }
- },
- "vnfdId": {
- "description": "Match VNF packages with a VNFD identifierlisted in the attribute",
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- },
- "vnfPkgId": {
- "description": "Match VNF packages with a VNFD identifierlisted in the attribute",
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- },
- "operationalState": {
- "description": "Operational state of the VNF package.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["ENABLED", "DISABLED"]
- }
- },
- "usageState": {
- "description": "Operational state of the VNF package.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["IN_USE", "NOT_IN_USE"]
- }
- }
- }
- },
- "PkgmSubscription": {
- "required": ["id", "callbackUri", "_links"],
- "type": "object",
- "properties": {
- "id": {
- "title": "Id",
- "description": "Identifier of this subscription resource.",
- "type": "string",
- "minLength": 1
- },
- "callbackUri": {
- "title": "Callbackuri",
- "description": "The URI of the endpoint to send the notification to.",
- "type": "string",
- "format": "uri",
- "minLength": 1
- },
- "_links": {
- "$ref": "#/definitions/LinkSelf"
- },
- "filter": {
- "$ref": "#/definitions/PkgmNotificationsFilter"
- }
- }
- },
- "PkgmSubscriptionRequest": {
- "required": ["callbackUri"],
- "type": "object",
- "properties": {
- "filter": {
- "$ref": "#/definitions/PkgmNotificationsFilter"
- },
- "callbackUri": {
- "title": "Callbackuri",
- "description": "Callback URI to sendthe notification",
- "type": "string",
- "format": "uri",
- "minLength": 1
- },
- "authentication": {
- "$ref": "#/definitions/SubscriptionAuthentication"
- }
- }
- },
- "Checksum": {
- "title": "Checksum",
- "description": "Checksum of the on-boarded VNF package.",
- "required": ["algorithm", "hash"],
- "type": "object",
- "properties": {
- "algorithm": {
- "title": "Algorithm",
- "description": "Name of the algorithm used to generate the checksum.",
- "type": "string",
- "minLength": 1
- },
- "hash": {
- "title": "Hash",
- "description": "The hexadecimal value of the checksum.",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "VnfPackageSoftwareImageInfo": {
- "description": "Information about VNF package artifacts that are software images.",
- "required": ["id", "name", "provider", "version", "checksum", "containerFormat", "diskFormat", "createdAt", "minDisk", "minRam", "size", "imagePath"],
- "type": "object",
- "properties": {
- "id": {
- "title": "Id",
- "description": "Identifier of the software image.",
- "type": "string",
- "minLength": 1
- },
- "name": {
- "title": "Name",
- "description": "Name of the software image.",
- "type": "string",
- "minLength": 1
- },
- "provider": {
- "title": "Provider",
- "description": "Provider of the software image.",
- "type": "string",
- "minLength": 1
- },
- "version": {
- "title": "Version",
- "description": "Version of the software image.",
- "type": "string",
- "minLength": 1
- },
- "checksum": {
- "$ref": "#/definitions/Checksum"
- },
- "containerFormat": {
- "title": "Containerformat",
- "description": "terminationType: Indicates whether forceful or graceful termination is requested.",
- "type": "string",
- "enum": ["AKI", "AMI", "ARI", "BARE", "DOCKER", "OVA", "OVF"]
- },
- "diskFormat": {
- "title": "Diskformat",
- "description": "Disk format of a software image is the format of the underlying disk image.",
- "type": "string",
- "enum": ["AKI", "AMI", "ARI", "ISO", "QCOW2", "RAW", "VDI", "VHD", "VHDX", "VMDK"]
- },
- "createdAt": {
- "title": "Createdat",
- "description": "Time when this software image was created.",
- "type": "string",
- "format": "date-time"
- },
- "minDisk": {
- "title": "Mindisk",
- "description": "The minimal disk for this software image in bytes.",
- "type": "integer"
- },
- "minRam": {
- "title": "Minram",
- "description": "The minimal RAM for this software image in bytes.",
- "type": "integer"
- },
- "size": {
- "title": "Size",
- "description": "Size of this software image in bytes.",
- "type": "integer"
- },
- "userMetadata": {
- "title": "Usermetadata",
- "description": "User-defined data.",
- "type": "object",
- "additionalProperties": {
- "description": "KeyValue Pairs",
- "type": "string"
- },
- "x-nullable": true
- },
- "imagePath": {
- "title": "Imagepath",
- "description": "Path in the VNF package.",
- "type": "string",
- "minLength": 1
- }
- }
- },
- "VnfPackageArtifactInfo": {
- "description": "Information about VNF package artifacts contained in the VNF package that are not software images.",
- "required": ["artifactPath", "checksum"],
- "type": "object",
- "properties": {
- "artifactPath": {
- "title": "Artifactpath",
- "description": "Path in the VNF package.",
- "type": "string",
- "minLength": 1
- },
- "checksum": {
- "$ref": "#/definitions/Checksum"
- },
- "metadata": {
- "title": "Metadata",
- "description": "The metadata of the artifact that are available in the VNF package",
- "type": "object",
- "additionalProperties": {
- "description": "KeyValue Pairs",
- "type": "string"
- },
- "x-nullable": true
- }
- }
- },
- "VNF_PKGM_Link_Serializer": {
- "title": " links",
- "description": "Links to resources related to this resource.",
- "required": ["self", "packageContent"],
- "type": "object",
- "properties": {
- "self": {
- "$ref": "#/definitions/UriLink"
- },
- "vnfd": {
- "$ref": "#/definitions/UriLink"
- },
- "packageContent": {
- "$ref": "#/definitions/UriLink"
- }
- }
- },
- "VnfPkgInfo": {
- "required": ["id", "onboardingState", "operationalState", "usageState", "_links"],
- "type": "object",
- "properties": {
- "id": {
- "title": "Id",
- "description": "Identifier of the on-boarded VNF package.",
- "type": "string",
- "minLength": 1
- },
- "vnfdId": {
- "title": "Vnfdid",
- "description": "This identifier, which is managed by the VNF provider, identifies the VNF package and the VNFD in a globally unique way.",
- "type": "string",
- "x-nullable": true
- },
- "vnfProvider": {
- "title": "Vnfprovider",
- "description": "Provider of the VNF package and the VNFD.",
- "type": "string",
- "x-nullable": true
- },
- "vnfProductName": {
- "title": "Vnfproductname",
- "description": "Name to identify the VNF product.",
- "type": "string",
- "x-nullable": true
- },
- "vnfSoftwareVersion": {
- "title": "Vnfsoftwareversion",
- "description": "Software version of the VNF.",
- "type": "string",
- "x-nullable": true
- },
- "vnfdVersion": {
- "title": "Vnfdversion",
- "description": "The version of the VNvFD.",
- "type": "string",
- "x-nullable": true
- },
- "checksum": {
- "$ref": "#/definitions/Checksum"
- },
- "softwareImages": {
- "description": "Information about VNF package artifacts that are software images.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VnfPackageSoftwareImageInfo"
- },
- "x-nullable": true
- },
- "additionalArtifacts": {
- "description": "Information about VNF package artifacts contained in the VNF package that are not software images.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VnfPackageArtifactInfo"
- },
- "x-nullable": true
- },
- "onboardingState": {
- "title": "Onboardingstate",
- "description": "On-boarding state of the VNF package.",
- "type": "string",
- "enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED"]
- },
- "operationalState": {
- "title": "Operationalstate",
- "description": "Operational state of the VNF package.",
- "type": "string",
- "enum": ["ENABLED", "DISABLED"]
- },
- "usageState": {
- "title": "Usagestate",
- "description": "Usage state of the VNF package.",
- "type": "string",
- "enum": ["IN_USE", "NOT_IN_USE"]
- },
- "userDefinedData": {
- "title": "Userdefineddata",
- "description": "User defined data for the VNF package.",
- "type": "object",
- "additionalProperties": {
- "description": "KeyValue Pairs",
- "type": "string"
- },
- "x-nullable": true
- },
- "_links": {
- "$ref": "#/definitions/VNF_PKGM_Link_Serializer"
- }
- }
- },
- "CreateVnfPkgInfoRequest": {
- "type": "object",
- "properties": {
- "userDefinedData": {
- "title": "Userdefineddata",
- "description": "User defined data for the VNF package.",
- "type": "object",
- "additionalProperties": {
- "description": "KeyValue Pairs",
- "type": "string"
- },
- "x-nullable": true
- }
- }
- },
- "UploadVnfPackageFromUriRequest": {
- "required": ["addressInformation"],
- "type": "object",
- "properties": {
- "addressInformation": {
- "title": "Addressinformation",
- "description": "Address information of the VNF package content.",
- "type": "string",
- "minLength": 1
- },
- "userName": {
- "title": "Username",
- "description": "User name to be used for authentication.",
- "type": "string",
- "minLength": 1
- },
- "password": {
- "title": "Password",
- "description": "Password to be used for authentication.",
- "type": "string",
- "minLength": 1
- }
- }
- }
- }
-} \ No newline at end of file
diff --git a/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFLifecycleManagement-API.json b/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFLifecycleManagement-API.json
deleted file mode 100644
index 2bc25a2d5b..0000000000
--- a/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFLifecycleManagement-API.json
+++ /dev/null
@@ -1,8143 +0,0 @@
-{
- "swagger": "2.0",
- "info": {
- "version": "1.1.1",
- "title": "SOL003 - VNF Lifecycle Management interface",
- "description": "SOL003 - VNF Lifecycle Management interface definition\n\nIMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence.\n\nIn clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes to the attribute-based filtering mechanism are being considered in v2.5.1 of this GS for inclusion in the corresponding future ETSI NFV OpenAPI design.\nPlease report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=\n",
- "license": {
- "name": "ETSI Forge copyright notice",
- "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
- }
- },
- "externalDocs": {
- "description": "ETSI GS NFV-SOL 003 V2.4.1",
- "url": "http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.04.01_60/gs_NFV-SOL003v020401p.pdf"
- },
- "basePath": "/vnflcm/v1",
- "schemes": ["https"],
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "paths": {
- "/vnf_instances": {
- "post": {
- "description": "Create VNF Identifier\n\nThe POST method creates a new VNF instance resource.\n",
- "tags": ["Sol003VnfLcm"],
- "parameters": [{
- "name": "createVnfRequest",
- "description": "The VNF creation parameters",
- "in": "body",
- "required": true,
- "schema": {
- "type": "object",
- "required": ["vnfdId"],
- "properties": {
- "vnfdId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfInstanceName": {
- "description": "Human-readable name of the VNF instance to be created.\n",
- "type": "string"
- },
- "vnfInstanceDescription": {
- "description": "Human-readable description of the VNF instance to be created.\n",
- "type": "string"
- }
- }
- }
- }, {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }, {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- }, {
- "name": "Content-Type",
- "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "201": {
- "description": "A VNF Instance identifier was created successfully",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "Location": {
- "description": "The resource URI of the created VNF instance",
- "type": "string",
- "format": "url"
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "This type represents a VNF instance.\n",
- "type": "object",
- "required": ["id", "vnfdId", "vnfProvider", "vnfProductName", "vnfSoftwareVersion", "vnfdVersion", "vnfPkgId", "instantiationState"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfInstanceName": {
- "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
- "type": "string"
- },
- "vnfInstanceDescription": {
- "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
- "type": "string"
- },
- "vnfdId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfProvider": {
- "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
- "type": "string"
- },
- "vnfProductName": {
- "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
- "type": "string"
- },
- "vnfSoftwareVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfdVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfPkgId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfConfigurableProperties": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "vimConnectionInfo": {
- "description": "Information about VIM connections to be used for managing the resources for the VNF instance. This attribute shall only be supported and present if VNF-related resource management in direct mode is applicable. This attribute can be modified with the PATCH method.\n",
- "type": "array",
- "items": {
- "description": "This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This structure is used to convey VIM-related parameters over the Or-Vnfm interface. Additional parameters for a VIM may be configured into the VNFM by means outside the scope of the present document, and bound to the identifier of that VIM.\n",
- "type": "object",
- "required": ["id", "vimType"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimType": {
- "description": "Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003.\n",
- "type": "string"
- },
- "interfaceInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "accessInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "extra": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "instantiationState": {
- "description": "The instantiation state of the VNF.\n",
- "type": "string",
- "enum": ["NOT_INSTANTIATED", "INSTANTIATED"]
- },
- "instantiatedVnfInfo": {
- "description": "Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n",
- "type": "object",
- "required": ["flavourId", "vnfState"],
- "properties": {
- "flavourId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "vnfState": {
- "type": "string",
- "enum": ["STARTED", "STOPPED"]
- },
- "scaleStatus": {
- "description": "Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n",
- "type": "array",
- "items": {
- "required": ["aspectId", "scaleLevel"],
- "type": "object",
- "properties": {
- "aspectId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "scaleLevel": {
- "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
- "type": "integer"
- }
- }
- }
- },
- "extCpInfo": {
- "description": "Information about the external CPs exposed by the VNF instance.\n",
- "type": "array",
- "minItems": 1,
- "items": {
- "type": "object",
- "required": ["id", "cpdId"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "cpdId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "cpProtocolInfo": {
- "description": "Network protocol information for this CP.\n",
- "type": "array",
- "items": {
- "description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
- "required": ["layerProtocol"],
- "properties": {
- "layerProtocol": {
- "description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
- "type": "string",
- "enum": ["IP_OVER_ETHERNET"]
- },
- "ipOverEthernet": {
- "description": "This type represents information about a network address that has been assigned.\n",
- "type": "object",
- "required": ["macAddress"],
- "properties": {
- "macAddress": {
- "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
- "type": "string",
- "format": "MAC"
- },
- "ipAddresses": {
- "description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["type"],
- "properties": {
- "type": {
- "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
- "type": "string",
- "enum": ["IPV4", "IPV6"]
- },
- "addresses": {
- "description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n",
- "type": "array",
- "items": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- },
- "isDynamic": {
- "description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
- "type": "boolean"
- },
- "addressRange": {
- "description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
- "type": "object",
- "required": ["minAddress", "maxAddress"],
- "properties": {
- "minAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- },
- "maxAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- },
- "subnetId": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "extLinkPortId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- }
- }
- },
- "extVirtualLinkInfo": {
- "description": "Information about the external VLs the VNF instance is connected to.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "extLinkPorts": {
- "description": "Link ports of this VL.\n",
- "type": "array",
- "items": {
- "description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "extManagedVirtualLinkInfo": {
- "description": "External virtual links the VNF instance is connected to.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "vnfVirtualLinkDescId"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfVirtualLinkDescId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "networkResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "vnfLinkPorts": {
- "description": "Link ports of this VL.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "monitoringParameters": {
- "description": "Active monitoring parameters.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "value", "timeStamp"],
- "properties": {
- "id": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "name": {
- "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
- "type": "string"
- },
- "value": {
- "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification.\n",
- "type": "object"
- },
- "timeStamp": {
- "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
- "type": "string"
- }
- }
- }
- },
- "localizationLanguage": {
- "description": "Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646.\n",
- "type": "string"
- },
- "vnfcResourceInfo": {
- "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
- "type": "array",
- "items": {
- "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
- "type": "object",
- "required": ["id", "vduId", "computeResource"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "vduId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "computeResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "storageResourceIds": {
- "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
- "type": "array",
- "items": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfcCpInfo": {
- "description": "CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is associated to an external CP of the VNF instance. May be present otherwise.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "cpdId"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "cpdId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "vnfExtCpId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "cpProtocolInfo": {
- "description": "Network protocol information for this CP.\n",
- "type": "array",
- "items": {
- "description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
- "required": ["layerProtocol"],
- "properties": {
- "layerProtocol": {
- "description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
- "type": "string",
- "enum": ["IP_OVER_ETHERNET"]
- },
- "ipOverEthernet": {
- "description": "This type represents information about a network address that has been assigned.\n",
- "type": "object",
- "required": ["macAddress"],
- "properties": {
- "macAddress": {
- "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
- "type": "string",
- "format": "MAC"
- },
- "ipAddresses": {
- "description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["type"],
- "properties": {
- "type": {
- "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
- "type": "string",
- "enum": ["IPV4", "IPV6"]
- },
- "addresses": {
- "description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n",
- "type": "array",
- "items": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- },
- "isDynamic": {
- "description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
- "type": "boolean"
- },
- "addressRange": {
- "description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
- "type": "object",
- "required": ["minAddress", "maxAddress"],
- "properties": {
- "minAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- },
- "maxAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- },
- "subnetId": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "vnfLinkPortId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "virtualLinkResourceInfo": {
- "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
- "type": "array",
- "items": {
- "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
- "type": "object",
- "required": ["id", "vnfVirtualLinkDescId", "networkResource"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "vnfVirtualLinkDescId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "networkResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfLinkPorts": {
- "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "virtualStorageResourceInfo": {
- "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
- "type": "array",
- "items": {
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
- "type": "object",
- "required": ["id", "virtualStorageDescId", "storageResource"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "virtualStorageDescId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "storageResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "extensions": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": ["self"],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "indicators": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "instantiate": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "terminate": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "scale": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "scaleToLevel": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "changeFlavour": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "heal": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "operate": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "changeExtConn": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "409": {
- "description": "Conflict\nAnother request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "Requested Range Not Satisfiable\nThis code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "422": {
- "description": "Unprocessable Entity\nIf the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem. NOTE 2: This error response code is only applicable for methods that have a request body.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/vnf_instances/{vnfInstanceId}": {
- "parameters": [{
- "name": "vnfInstanceId",
- "description": "Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
- "in": "path",
- "type": "string",
- "required": true
- }
- ],
- "get": {
- "description": "Query VNF\n\nThe GET method retrieves information about a VNF instance by reading an individual VNF instance resource.\n",
- "tags": ["Sol003VnfLcm"],
- "parameters": [{
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }, {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- }, {
- "name": "Content-Type",
- "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK\nInformation about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "This type represents a VNF instance.\n",
- "type": "object",
- "required": ["id", "vnfdId", "vnfProvider", "vnfProductName", "vnfSoftwareVersion", "vnfdVersion", "vnfPkgId", "instantiationState"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfInstanceName": {
- "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
- "type": "string"
- },
- "vnfInstanceDescription": {
- "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
- "type": "string"
- },
- "vnfdId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfProvider": {
- "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
- "type": "string"
- },
- "vnfProductName": {
- "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
- "type": "string"
- },
- "vnfSoftwareVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfdVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfPkgId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfConfigurableProperties": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "vimConnectionInfo": {
- "description": "Information about VIM connections to be used for managing the resources for the VNF instance. This attribute shall only be supported and present if VNF-related resource management in direct mode is applicable. This attribute can be modified with the PATCH method.\n",
- "type": "array",
- "items": {
- "description": "This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This structure is used to convey VIM-related parameters over the Or-Vnfm interface. Additional parameters for a VIM may be configured into the VNFM by means outside the scope of the present document, and bound to the identifier of that VIM.\n",
- "type": "object",
- "required": ["id", "vimType"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimType": {
- "description": "Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003.\n",
- "type": "string"
- },
- "interfaceInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "accessInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "extra": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "instantiationState": {
- "description": "The instantiation state of the VNF.\n",
- "type": "string",
- "enum": ["NOT_INSTANTIATED", "INSTANTIATED"]
- },
- "instantiatedVnfInfo": {
- "description": "Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n",
- "type": "object",
- "required": ["flavourId", "vnfState"],
- "properties": {
- "flavourId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "vnfState": {
- "type": "string",
- "enum": ["STARTED", "STOPPED"]
- },
- "scaleStatus": {
- "description": "Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n",
- "type": "array",
- "items": {
- "required": ["aspectId", "scaleLevel"],
- "type": "object",
- "properties": {
- "aspectId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "scaleLevel": {
- "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
- "type": "integer"
- }
- }
- }
- },
- "extCpInfo": {
- "description": "Information about the external CPs exposed by the VNF instance.\n",
- "type": "array",
- "minItems": 1,
- "items": {
- "type": "object",
- "required": ["id", "cpdId"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "cpdId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "cpProtocolInfo": {
- "description": "Network protocol information for this CP.\n",
- "type": "array",
- "items": {
- "description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
- "required": ["layerProtocol"],
- "properties": {
- "layerProtocol": {
- "description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
- "type": "string",
- "enum": ["IP_OVER_ETHERNET"]
- },
- "ipOverEthernet": {
- "description": "This type represents information about a network address that has been assigned.\n",
- "type": "object",
- "required": ["macAddress"],
- "properties": {
- "macAddress": {
- "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
- "type": "string",
- "format": "MAC"
- },
- "ipAddresses": {
- "description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["type"],
- "properties": {
- "type": {
- "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
- "type": "string",
- "enum": ["IPV4", "IPV6"]
- },
- "addresses": {
- "description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n",
- "type": "array",
- "items": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- },
- "isDynamic": {
- "description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
- "type": "boolean"
- },
- "addressRange": {
- "description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
- "type": "object",
- "required": ["minAddress", "maxAddress"],
- "properties": {
- "minAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- },
- "maxAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- },
- "subnetId": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "extLinkPortId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- }
- }
- },
- "extVirtualLinkInfo": {
- "description": "Information about the external VLs the VNF instance is connected to.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "extLinkPorts": {
- "description": "Link ports of this VL.\n",
- "type": "array",
- "items": {
- "description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "extManagedVirtualLinkInfo": {
- "description": "External virtual links the VNF instance is connected to.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "vnfVirtualLinkDescId"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfVirtualLinkDescId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "networkResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "vnfLinkPorts": {
- "description": "Link ports of this VL.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "monitoringParameters": {
- "description": "Active monitoring parameters.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "value", "timeStamp"],
- "properties": {
- "id": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "name": {
- "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
- "type": "string"
- },
- "value": {
- "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification.\n",
- "type": "object"
- },
- "timeStamp": {
- "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
- "type": "string"
- }
- }
- }
- },
- "localizationLanguage": {
- "description": "Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646.\n",
- "type": "string"
- },
- "vnfcResourceInfo": {
- "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
- "type": "array",
- "items": {
- "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
- "type": "object",
- "required": ["id", "vduId", "computeResource"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "vduId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "computeResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "storageResourceIds": {
- "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
- "type": "array",
- "items": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfcCpInfo": {
- "description": "CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is associated to an external CP of the VNF instance. May be present otherwise.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "cpdId"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "cpdId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "vnfExtCpId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "cpProtocolInfo": {
- "description": "Network protocol information for this CP.\n",
- "type": "array",
- "items": {
- "description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
- "required": ["layerProtocol"],
- "properties": {
- "layerProtocol": {
- "description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
- "type": "string",
- "enum": ["IP_OVER_ETHERNET"]
- },
- "ipOverEthernet": {
- "description": "This type represents information about a network address that has been assigned.\n",
- "type": "object",
- "required": ["macAddress"],
- "properties": {
- "macAddress": {
- "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
- "type": "string",
- "format": "MAC"
- },
- "ipAddresses": {
- "description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["type"],
- "properties": {
- "type": {
- "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
- "type": "string",
- "enum": ["IPV4", "IPV6"]
- },
- "addresses": {
- "description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n",
- "type": "array",
- "items": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- },
- "isDynamic": {
- "description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
- "type": "boolean"
- },
- "addressRange": {
- "description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
- "type": "object",
- "required": ["minAddress", "maxAddress"],
- "properties": {
- "minAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- },
- "maxAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- },
- "subnetId": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "vnfLinkPortId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "virtualLinkResourceInfo": {
- "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
- "type": "array",
- "items": {
- "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
- "type": "object",
- "required": ["id", "vnfVirtualLinkDescId", "networkResource"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "vnfVirtualLinkDescId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "networkResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfLinkPorts": {
- "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "virtualStorageResourceInfo": {
- "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
- "type": "array",
- "items": {
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
- "type": "object",
- "required": ["id", "virtualStorageDescId", "storageResource"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "virtualStorageDescId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "storageResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "extensions": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": ["self"],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "indicators": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "instantiate": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "terminate": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "scale": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "scaleToLevel": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "changeFlavour": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "heal": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "operate": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "changeExtConn": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "409": {
- "description": "Conflict\nAnother request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "Requested Range Not Satisfiable\nThis code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- },
- "delete": {
- "description": "Delete VNF Identifier\n\nThis method deletes an individual VNF instance resource.\n",
- "tags": ["Sol003VnfLcm"],
- "parameters": [{
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content\nThe VNF instance resource and the associated VNF identifier were deleted successfully. The response body shall be empty.\n",
- "headers": {
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- }
- },
- "400": {
- "description": "Bad Request\nIt fhe request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "409": {
- "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is in INSTANTIATED state. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "412": {
- "description": "Precondition Failed\nA precondition given in an HTTP request header is not fulfilled. Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity. The response body should contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/vnf_instances/{vnfInstanceId}/instantiate": {
- "parameters": [{
- "name": "vnfInstanceId",
- "description": "Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
- "in": "path",
- "type": "string",
- "required": true
- }
- ],
- "post": {
- "description": "Instantiate VNF\n\nThe POST method instantiates a VNF instance.\n",
- "tags": ["Sol003VnfLcm"],
- "parameters": [{
- "name": "InstantiateVnfRequest",
- "description": "Parameters for the VNF instantiation.",
- "in": "body",
- "required": true,
- "schema": {
- "type": "object",
- "required": ["flavourId"],
- "properties": {
- "flavourId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "extVirtualLinks": {
- "description": "Information about external VLs to connect the VNF to.\n",
- "type": "array",
- "items": {
- "description": "This type represents an external VL.\n",
- "type": "object",
- "required": ["id", "resourceId", "extCps"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "extCps": {
- "description": "External CPs of the VNF to be connected to this external VL.\n",
- "type": "array",
- "items": {
- "description": "This type represents configuration information for external CPs created from a CPD.\n",
- "type": "object",
- "required": ["cpdId"],
- "properties": {
- "cpdId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "cpConfig": {
- "description": "List of instance data that need to be configured on the CP instances created from the respective CPD.\n",
- "type": "array",
- "items": {
- "description": "This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n",
- "type": "object",
- "properties": {
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "linkPortId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "cpProtocolData": {
- "description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": * The \"linkPortId\" and \"cpProtocolData\" attributes shall both be absent for the deletion of an existing external CP instance\n addressed by cpInstanceId. \n* At least one of these attributes shall be present for a to-be-created external CP instance or an existing external\n CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
- "type": "array",
- "items": {
- "description": "This type represents network protocol data.\n",
- "type": "object",
- "required": ["layerProtocol"],
- "properties": {
- "layerProtocol": {
- "description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
- "type": "string",
- "enum": ["IP_OVER_ETHERNET"]
- },
- "ipOverEthernet": {
- "description": "This type represents network address data for IP over Ethernet.\n",
- "type": "object",
- "properties": {
- "macAddress": {
- "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
- "type": "string",
- "format": "MAC"
- },
- "ipAddresses": {
- "description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["type"],
- "properties": {
- "type": {
- "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
- "type": "string",
- "enum": ["IPV4", "IPV6"]
- },
- "fixedAddresses": {
- "description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
- "type": "array",
- "items": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- },
- "numDynamicAddresses": {
- "description": "Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
- "type": "integer"
- },
- "addressRange": {
- "description": "An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n",
- "type": "object",
- "required": ["minAddress", "maxAddress"],
- "properties": {
- "minAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- },
- "maxAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- },
- "subnetId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "extLinkPorts": {
- "description": "Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the VNFM shall create the link ports on the external VL.\n",
- "type": "array",
- "items": {
- "description": "This type represents an externally provided link port to be used to connect an external connection point to an external VL.\n",
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "vimConnectionInfo": {
- "description": "Information about VIM connections to be used for managing the resources for the VNF instance, or refer to external / externally-managed virtual links. This attribute shall only be supported and may be present if VNF-related resource management in direct mode is applicable.\n",
- "type": "array",
- "items": {
- "description": "This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This structure is used to convey VIM-related parameters over the Or-Vnfm interface. Additional parameters for a VIM may be configured into the VNFM by means outside the scope of the present document, and bound to the identifier of that VIM.\n",
- "type": "object",
- "required": ["id", "vimType"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimType": {
- "description": "Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003.\n",
- "type": "string"
- },
- "interfaceInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "accessInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "additionalParams": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- }, {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }, {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- }, {
- "name": "Content-Type",
- "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "202": {
- "description": "Accepted\nThe request was accepted for processing, but the processing has not been completed. The response body shall be empty. The HTTP response shall include a \"Location\" HTTP header that contains the URI of the newly-created \"VNF LCM operation occurrence\" resource corresponding to the operation.\n",
- "headers": {
- "Location": {
- "description": "The resource URI of the created VNF instance",
- "type": "string",
- "format": "url"
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- }
- },
- "400": {
- "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "409": {
- "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is in INSTANTIATED state. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "Requested Range Not Satisfiable\nThis code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/vnf_instances/{vnfInstanceId}/terminate": {
- "parameters": [{
- "name": "vnfInstanceId",
- "description": "The identifier of the VNF instance to be terminated. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
- "in": "path",
- "type": "string",
- "required": true
- }
- ],
- "post": {
- "description": "Terminate VNF\n\nThe POST method terminates a VNF instance.\n",
- "tags": ["Sol003VnfLcm"],
- "parameters": [{
- "name": "TerminateVnfRequest",
- "description": "Parameters for the VNF termination.",
- "in": "body",
- "required": true,
- "schema": {
- "type": "object",
- "required": ["terminationType"],
- "properties": {
- "terminationType": {
- "description": "Indicates whether forceful or graceful termination is requested. VNFM Adapter will only support FORCEFUL in Dublin.\n",
- "type": "string",
- "enum": ["FORCEFUL", "GRACEFUL"]
- }
- }
- }
- }, {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }, {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- }, {
- "name": "Content-Type",
- "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "202": {
- "description": "Accepted\nThe request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a \"Location\" HTTP header that contains the URI of the newly-created \"VNF LCM operation occurrence\" resource corresponding to the operation.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "Location": {
- "description": "The resource URI of the created VNF instance",
- "type": "string",
- "format": "url"
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "This type represents a VNF instance.\n",
- "type": "object",
- "required": ["id", "vnfdId", "vnfProvider", "vnfProductName", "vnfSoftwareVersion", "vnfdVersion", "vnfPkgId", "instantiationState"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfInstanceName": {
- "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
- "type": "string"
- },
- "vnfInstanceDescription": {
- "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
- "type": "string"
- },
- "vnfdId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfProvider": {
- "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
- "type": "string"
- },
- "vnfProductName": {
- "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
- "type": "string"
- },
- "vnfSoftwareVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfdVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfPkgId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfConfigurableProperties": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "vimConnectionInfo": {
- "description": "Information about VIM connections to be used for managing the resources for the VNF instance. This attribute shall only be supported and present if VNF-related resource management in direct mode is applicable. This attribute can be modified with the PATCH method.\n",
- "type": "array",
- "items": {
- "description": "This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This structure is used to convey VIM-related parameters over the Or-Vnfm interface. Additional parameters for a VIM may be configured into the VNFM by means outside the scope of the present document, and bound to the identifier of that VIM.\n",
- "type": "object",
- "required": ["id", "vimType"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimType": {
- "description": "Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003.\n",
- "type": "string"
- },
- "interfaceInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "accessInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "extra": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "instantiationState": {
- "description": "The instantiation state of the VNF.\n",
- "type": "string",
- "enum": ["NOT_INSTANTIATED", "INSTANTIATED"]
- },
- "instantiatedVnfInfo": {
- "description": "Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n",
- "type": "object",
- "required": ["flavourId", "vnfState"],
- "properties": {
- "flavourId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "vnfState": {
- "type": "string",
- "enum": ["STARTED", "STOPPED"]
- },
- "scaleStatus": {
- "description": "Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n",
- "type": "array",
- "items": {
- "required": ["aspectId", "scaleLevel"],
- "type": "object",
- "properties": {
- "aspectId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "scaleLevel": {
- "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
- "type": "integer"
- }
- }
- }
- },
- "extCpInfo": {
- "description": "Information about the external CPs exposed by the VNF instance.\n",
- "type": "array",
- "minItems": 1,
- "items": {
- "type": "object",
- "required": ["id", "cpdId"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "cpdId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "cpProtocolInfo": {
- "description": "Network protocol information for this CP.\n",
- "type": "array",
- "items": {
- "description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
- "required": ["layerProtocol"],
- "properties": {
- "layerProtocol": {
- "description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
- "type": "string",
- "enum": ["IP_OVER_ETHERNET"]
- },
- "ipOverEthernet": {
- "description": "This type represents information about a network address that has been assigned.\n",
- "type": "object",
- "required": ["macAddress"],
- "properties": {
- "macAddress": {
- "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
- "type": "string",
- "format": "MAC"
- },
- "ipAddresses": {
- "description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["type"],
- "properties": {
- "type": {
- "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
- "type": "string",
- "enum": ["IPV4", "IPV6"]
- },
- "addresses": {
- "description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n",
- "type": "array",
- "items": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- },
- "isDynamic": {
- "description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
- "type": "boolean"
- },
- "addressRange": {
- "description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
- "type": "object",
- "required": ["minAddress", "maxAddress"],
- "properties": {
- "minAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- },
- "maxAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- },
- "subnetId": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "extLinkPortId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- }
- }
- },
- "extVirtualLinkInfo": {
- "description": "Information about the external VLs the VNF instance is connected to.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "extLinkPorts": {
- "description": "Link ports of this VL.\n",
- "type": "array",
- "items": {
- "description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "extManagedVirtualLinkInfo": {
- "description": "External virtual links the VNF instance is connected to.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "vnfVirtualLinkDescId"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfVirtualLinkDescId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "networkResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "vnfLinkPorts": {
- "description": "Link ports of this VL.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "monitoringParameters": {
- "description": "Active monitoring parameters.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "value", "timeStamp"],
- "properties": {
- "id": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "name": {
- "description": "Human readable name of the monitoring parameter, as defined in the VNFD.\n",
- "type": "string"
- },
- "value": {
- "description": "Value of the monitoring parameter known to the VNFM (e.g. obtained for autoscaling purposes). The type of the \"value\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures/Objects)) is assumed to be defined in an external measurement specification.\n",
- "type": "object"
- },
- "timeStamp": {
- "description": "Represents the point in time when the measurement has been performed, as known to the VNFM. Should be formatted according to ETF RFC 3339.\n",
- "type": "string"
- }
- }
- }
- },
- "localizationLanguage": {
- "description": "Information about localization language of the VNF (includes e.g. strings in the VNFD). The localization languages supported by a VNF can be declared in the VNFD, and localization language selection can take place at instantiation time. The value shall comply with the format defined in IETF RFC 5646.\n",
- "type": "string"
- },
- "vnfcResourceInfo": {
- "description": "Information about the virtualised compute and storage resources used by the VNFCs of the VNF instance.\n",
- "type": "array",
- "items": {
- "description": "This type represents the information on virtualised compute and storage resources used by a VNFC in a VNF instance.\n",
- "type": "object",
- "required": ["id", "vduId", "computeResource"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "vduId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "computeResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "storageResourceIds": {
- "description": "References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance.\n",
- "type": "array",
- "items": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfcCpInfo": {
- "description": "CPs of the VNFC instance. Shall be present when that particular CP of the VNFC instance is associated to an external CP of the VNF instance. May be present otherwise.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "cpdId"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "cpdId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "vnfExtCpId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "cpProtocolInfo": {
- "description": "Network protocol information for this CP.\n",
- "type": "array",
- "items": {
- "description": "This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses.\n",
- "required": ["layerProtocol"],
- "properties": {
- "layerProtocol": {
- "description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
- "type": "string",
- "enum": ["IP_OVER_ETHERNET"]
- },
- "ipOverEthernet": {
- "description": "This type represents information about a network address that has been assigned.\n",
- "type": "object",
- "required": ["macAddress"],
- "properties": {
- "macAddress": {
- "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
- "type": "string",
- "format": "MAC"
- },
- "ipAddresses": {
- "description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["type"],
- "properties": {
- "type": {
- "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
- "type": "string",
- "enum": ["IPV4", "IPV6"]
- },
- "addresses": {
- "description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided).\n",
- "type": "array",
- "items": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- },
- "isDynamic": {
- "description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
- "type": "boolean"
- },
- "addressRange": {
- "description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present.\n",
- "type": "object",
- "required": ["minAddress", "maxAddress"],
- "properties": {
- "minAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- },
- "maxAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- },
- "subnetId": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "vnfLinkPortId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "virtualLinkResourceInfo": {
- "description": "Information about the virtualised network resources used by the VLs of the VNF instance.\n",
- "type": "array",
- "items": {
- "description": "This type represents the information that allows addressing a virtualised resource that is used by an internal VL instance in a VNF instance.\n",
- "type": "object",
- "required": ["id", "vnfVirtualLinkDescId", "networkResource"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "vnfVirtualLinkDescId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "networkResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfLinkPorts": {
- "description": "Links ports of this VL. Shall be present when the linkPort is used for external connectivity by the VNF (refer to VnfLinkPortInfo). May be present otherwise.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "virtualStorageResourceInfo": {
- "description": "Information on the virtualised storage resource(s) used as storage for the VNF instance.\n",
- "type": "array",
- "items": {
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.\n",
- "type": "object",
- "required": ["id", "virtualStorageDescId", "storageResource"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "virtualStorageDescId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "storageResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "extensions": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": ["self"],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "indicators": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "instantiate": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "terminate": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "scale": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "scaleToLevel": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "changeFlavour": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "heal": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "operate": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "changeExtConn": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "409": {
- "description": "Conflict\nThe operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is in NOT-INSTANTIATED state, or that another lifecycle management operation is ongoing. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/vnf_lcm_op_occs/{vnfLcmOpOccId}": {
- "parameters": [{
- "name": "vnfLcmOpOccId",
- "description": "Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the \"vnfLcmOpOccId\" attribute in the VnfLcmOperationOccurrenceNotification.\n",
- "in": "path",
- "required": true,
- "type": "string"
- }
- ],
- "get": {
- "description": "Get Operation Status\n\nThe client can use this method to retrieve status information about a VNF lifecycle management operation occurrence by reading an individual \"VNF LCM operation occurrence\" resource.\n",
- "tags": ["Sol003VnfLcm"],
- "parameters": [{
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }, {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK\nInformation about an individual VNF instance was queried successfully. The response body shall contain status information about a VNF lifecycle management operation occurrence.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "This type represents a VNF lifecycle management operation occurrence.\n",
- "type": "object",
- "required": ["id", "operationState", "stateEnteredTime", "startTime", "vnfInstanceId", "operation", "isAutomaticInvocation", "operationParams", "isCancelPending"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "operationState": {
- "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
- "type": "string",
- "enum": ["STARTING", "PROCESSING", "COMPLETED", "FAILED_TEMP", "FAILED", "ROLLING_BACK", "ROLLED_BACK"]
- },
- "stateEnteredTime": {
- "description": "Date-time when the current state was entered.\n",
- "type": "string",
- "format": "date-time"
- },
- "startTime": {
- "description": "Date-time of the start of the operation.\n",
- "type": "string",
- "format": "date-time"
- },
- "vnfInstanceId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "grantId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "operation": {
- "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
- "type": "string",
- "enum": ["INSTANTIATE", "SCALE", "SCALE_TO_LEVEL", "CHANGE_FLAVOUR", "TERMINATE", "HEAL", "OPERATE", "CHANGE_EXT_CONN", "MODIFY_INFO"]
- },
- "isAutomaticInvocation": {
- "description": "Set to true if this VNF LCM operation occurrence has been triggered by an automated procedure inside the VNFM (i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf triggered by auto-heal). Set to false otherwise.\n",
- "type": "boolean"
- },
- "operationParams": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "isCancelPending": {
- "description": "If the VNF LCM operation occurrence is in \"STARTING\", \"PROCESSING\" or \"ROLLING_BACK\" state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false.\n",
- "type": "boolean"
- },
- "cancelMode": {
- "description": "Cancellation mode. GRACEFUL: If the VNF LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state, the VNFM shall not start any new resource management operation and shall wait for the ongoing resource management operations in the underlying system, typically the VIM, to finish execution or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in \"STARTING\" state, the VNFM shall not start any resource management operation and shall wait for the granting request to finish execution or time out. After that, the VNFM shall put the operation occurrence into the ROLLED_BACK state. FORCEFUL: If the VNF LCM operation occurrence is in \"PROCESSING\" or \"ROLLING_BACK\" state, the VNFM shall not start any new resource management operation, shall cancel the ongoing resource management operations in the underlying system, typically the VIM, and shall wait for the cancellation to finish or to time out. After that, the VNFM shall put the operation occurrence into the FAILED_TEMP state. If the VNF LCM operation occurrence is in \"STARTING\" state, the VNFM shall not start any resource management operation and put the operation occurrence into the ROLLED_BACK state.\n",
- "type": "string",
- "enum": ["GRACEFUL", "FORCEFUL"]
- },
- "error": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- },
- "resourceChanges": {
- "description": "This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable.\n",
- "type": "object",
- "properties": {
- "affectedVnfcs": {
- "description": "Information about VNFC instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
- "type": "array",
- "items": {
- "description": "This type provides information about added, deleted, modified and temporary VNFCs.\n",
- "type": "object",
- "required": ["id", "vduId", "changeType", "computeResource"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "vduId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "changeType": {
- "description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists.\n",
- "type": "string",
- "enum": ["ADDED", "REMOVED", "MODIFIED", "TEMPORARY"]
- },
- "computeResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "affectedVnfcCpIds": {
- "description": "Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance.\n",
- "type": "array",
- "items": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- },
- "addedStorageResourceIds": {
- "description": "References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC.\n",
- "type": "array",
- "items": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- },
- "removedStorageResourceIds": {
- "description": "References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC.\n",
- "type": "array",
- "items": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- }
- },
- "affectedVirtualLinks": {
- "description": "Information about VL instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
- "type": "array",
- "items": {
- "description": "This type provides information about added, deleted, modified and temporary VLs.\n",
- "type": "object",
- "required": ["id", "virtualLinkDescId", "changeType", "networkResource"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "virtualLinkDescId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "changeType": {
- "description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists.\n",
- "type": "string",
- "enum": ["ADDED", "REMOVED", "MODIFIED", "TEMPORARY", "LINK_PORT_ADDED", "LINK_PORT_REMOVED"]
- },
- "networkResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "affectedVirtualStorages": {
- "description": "Information about virtualised storage instances that were affected during the lifecycle operation. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
- "type": "array",
- "items": {
- "description": "This type provides information about added, deleted, modified and temporary virtual storage resources.\n",
- "type": "object",
- "required": ["id", "virtualStorageDescId", "changeType", "storageResource"],
- "properties": {
- "id": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "virtualStorageDescId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "changeType": {
- "description": "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVirtualStorage structure exists as long as the temporary resource exists.\n",
- "type": "string",
- "enum": ["ADDED", "REMOVED", "MODIFIED", "TEMPORARY"]
- },
- "storageResource": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- }
- }
- },
- "changedInfo": {
- "description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"VnfInfoModificationRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly e.g. when modifying the referenced VNF package.\n",
- "type": "object",
- "properties": {
- "vnfInstanceName": {
- "description": "If present, this attribute signals modifications of the \"vnfInstanceName\" attribute in \"VnfInstance\".\n",
- "type": "string"
- },
- "vnfInstanceDescription": {
- "description": "If present, this attribute signals modifications of the \"vnfInstanceDescription\" attribute in \"VnfInstance\".\n",
- "type": "string"
- },
- "vnfConfigurableProperties": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "extensions": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "vimConnectionInfo": {
- "description": "If present, this attribute signals modifications of certain entries in the \"vimConnectionInfo\" attribute array in \"VnfInstance\".\n",
- "type": "array",
- "items": {
- "description": "This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This structure is used to convey VIM-related parameters over the Or-Vnfm interface. Additional parameters for a VIM may be configured into the VNFM by means outside the scope of the present document, and bound to the identifier of that VIM.\n",
- "type": "object",
- "required": ["id", "vimType"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimType": {
- "description": "Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003.\n",
- "type": "string"
- },
- "interfaceInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "accessInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "extra": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "vnfPkgId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfdId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfProvider": {
- "description": "If present, this attribute signals modifications of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n",
- "type": "string"
- },
- "vnfProductName": {
- "description": "If present, this attribute signals modifications of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n",
- "type": "string"
- },
- "vnfSoftwareVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfdVersion": {
- "description": "A Version.\n",
- "type": "string"
- }
- }
- },
- "changedExtConnectivity": {
- "description": "Information about changed external connectivity, if applicable. This allows the NFVO to obtain the information contained in the latest \"result\" notification if it has not received it due to an error or a wrongly configured subscription filter.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "extLinkPorts": {
- "description": "Link ports of this VL.\n",
- "type": "array",
- "items": {
- "description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL.\n",
- "type": "object",
- "required": ["id", "resourceHandle"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": ["vimConnectionId", "resourceId"],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- },
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": ["self", "vnfInstance"],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "vnfInstance": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "grant": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "cancel": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "retry": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "rollback": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "fail": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "409": {
- "description": "Conflict\nAnother request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/subscriptions": {
- "post": {
- "description": "Subscribe\n\nThe POST method creates a new subscription. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide duplicates of notifications to the NFVO, and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating a subscription resource if another subscription resource with the same filter and callbackUri already exists (in which case it shall return the “201 Created” response code), or may decide to not create a duplicate subscription resource (in which case it shall return a “303 See Other” response code referencing the existing subscription resource with the same filter and callbackUri).\n",
- "tags": ["Sol003VnfLcm"],
- "parameters": [{
- "name": "LccnSubscriptionRequest",
- "description": "Details of the subscription to be created.\n",
- "in": "body",
- "required": true,
- "schema": {
- "description": "This type represents a subscription request related to notifications about VNF lifecycle changes.\n",
- "type": "object",
- "required": ["callbackUri"],
- "properties": {
- "filter": {
- "description": "This type represents a subscription filter related to notifications about VNF lifecycle changes. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n",
- "type": "object",
- "properties": {
- "vnfInstanceSubscriptionFilter": {
- "description": "This type represents subscription filter criteria to match VNF instances.\n",
- "type": "object",
- "properties": {
- "vnfInstanceIds": {
- "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- }
- }
- },
- "notificationTypes": {
- "description": "Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["VnfLcmOperationOccurrenceNotification", "VnfIdentifierCreationNotification", "VnfIdentifierDeletionNotification"]
- }
- },
- "operationTypes": {
- "description": "Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
- "type": "array",
- "items": {
- "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
- "type": "string",
- "enum": ["INSTANTIATE", "TERMINATE"]
- }
- },
- "operationStates": {
- "description": "Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
- "type": "array",
- "items": {
- "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
- "type": "string",
- "enum": ["STARTING", "PROCESSING", "COMPLETED", "FAILED_TEMP", "FAILED", "ROLLING_BACK", "ROLLED_BACK"]
- }
- }
- }
- },
- "callbackUri": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- },
- "authentication": {
- "type": "object",
- "required": ["authType"],
- "properties": {
- "authType": {
- "description": "Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification. Permitted values: * BASIC: In every HTTP request to the notification endpoint, use HTTP Basic authentication with the client credentials. \n* OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer token, obtained\n using the client credentials grant type.\n* TLS_CERT: Every HTTP request to the notification endpoint is sent over a mutually authenticated TLS session, i.e. not only the\n server is authenticated, but also the client is authenticated\n during the TLS tunnel setup.\n",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["BASIC", "OAUTH2_CLIENT_CREDENTIALS", "TLS_CERT"]
- }
- },
- "paramsBasic": {
- "description": "Parameters for authentication/authorization using BASIC. Shall be present if authType is \"BASIC\" and the contained information has not been provisioned out of band. Shall be absent otherwise.\n",
- "type": "object",
- "properties": {
- "userName": {
- "description": "Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n",
- "type": "string"
- },
- "password": {
- "description": "Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n",
- "type": "string"
- }
- }
- },
- "paramsOauth2ClientCredentials": {
- "description": "Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is \"OAUTH2_CLIENT_CREDENTIALS\" and the contained information has not been provisioned out of band. Shall be absent otherwise.\n",
- "type": "object",
- "properties": {
- "clientId": {
- "description": "Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process.\n",
- "type": "string"
- },
- "clientPassword": {
- "description": "Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process.\n",
- "type": "string"
- },
- "tokenEndpoint": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }, {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }, {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- }, {
- "name": "Content-Type",
- "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "201": {
- "description": "Created\nThe subscription was created successfully. The response body shall contain a representation of the created subscription resource. The HTTP response shall include a \"Location\" HTTP header that points to the created subscription resource.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "Location": {
- "description": "The resource URI of the created VNF instance",
- "type": "string",
- "format": "url"
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "This type represents a subscription related to notifications about VNF lifecycle changes.\n",
- "type": "object",
- "required": ["id", "callbackUri", "_links"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "filter": {
- "description": "This type represents a subscription filter related to notifications about VNF lifecycle changes. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n",
- "type": "object",
- "properties": {
- "vnfInstanceSubscriptionFilter": {
- "description": "This type represents subscription filter criteria to match VNF instances.\n",
- "type": "object",
- "properties": {
- "vnfdIds": {
- "description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "vnfProductsFromProviders": {
- "description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["vnfProvider"],
- "properties": {
- "vnfProvider": {
- "description": "Name of the VNF provider to match.\n",
- "type": "string"
- },
- "vnfProducts": {
- "description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["vnfProductName"],
- "properties": {
- "vnfProductName": {
- "description": "Name of the VNF product to match.\n",
- "type": "string"
- },
- "versions": {
- "description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["vnfSoftwareVersion"],
- "properties": {
- "vnfSoftwareVersion": {
- "description": "A version.\n",
- "type": "string"
- },
- "vnfdVersions": {
- "description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "description": "A version.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "vnfInstanceIds": {
- "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "vnfInstanceNames": {
- "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "notificationTypes": {
- "description": "Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["VnfLcmOperationOccurrenceNotification", "VnfIdentifierCreationNotification", "VnfIdentifierDeletionNotification"]
- }
- },
- "operationTypes": {
- "description": "Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
- "type": "array",
- "items": {
- "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
- "type": "string",
- "enum": ["INSTANTIATE", "SCALE", "SCALE_TO_LEVEL", "CHANGE_FLAVOUR", "TERMINATE", "HEAL", "OPERATE", "CHANGE_EXT_CONN", "MODIFY_INFO"]
- }
- },
- "operationStates": {
- "description": "Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
- "type": "array",
- "items": {
- "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
- "type": "string",
- "enum": ["STARTING", "PROCESSING", "COMPLETED", "FAILED_TEMP", "FAILED", "ROLLING_BACK", "ROLLED_BACK"]
- }
- }
- }
- },
- "callbackUri": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": ["self"],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- }
- }
- }
- }
- }
- },
- "303": {
- "description": "See Other\nA subscription with the same callbackURI and the same filter already exists and the policy of the VNFM is to not create redundant subscriptions. The HTTP response shall include a \"Location\" HTTP header that contains the resource URI of the existing subscription resource. The response body shall be empty.\n",
- "headers": {
- "Location": {
- "description": "The resource URI of the created VNF instance",
- "type": "string",
- "format": "url"
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- }
- },
- "400": {
- "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- },
- "get": {
- "description": "Query Subscription Information\n\nThe GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations.\n",
- "tags": ["Sol003VnfLcm"],
- "parameters": [{
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }, {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK\nThe list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "This type represents a subscription related to notifications about VNF lifecycle changes.\n",
- "type": "object",
- "required": ["id", "callbackUri", "_links"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "filter": {
- "description": "This type represents a subscription filter related to notifications about VNF lifecycle changes. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n",
- "type": "object",
- "properties": {
- "vnfInstanceSubscriptionFilter": {
- "description": "This type represents subscription filter criteria to match VNF instances.\n",
- "type": "object",
- "properties": {
- "vnfdIds": {
- "description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "vnfProductsFromProviders": {
- "description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["vnfProvider"],
- "properties": {
- "vnfProvider": {
- "description": "Name of the VNF provider to match.\n",
- "type": "string"
- },
- "vnfProducts": {
- "description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["vnfProductName"],
- "properties": {
- "vnfProductName": {
- "description": "Name of the VNF product to match.\n",
- "type": "string"
- },
- "versions": {
- "description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["vnfSoftwareVersion"],
- "properties": {
- "vnfSoftwareVersion": {
- "description": "A version.\n",
- "type": "string"
- },
- "vnfdVersions": {
- "description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "description": "A version.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "vnfInstanceIds": {
- "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "vnfInstanceNames": {
- "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "notificationTypes": {
- "description": "Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["VnfLcmOperationOccurrenceNotification", "VnfIdentifierCreationNotification", "VnfIdentifierDeletionNotification"]
- }
- },
- "operationTypes": {
- "description": "Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
- "type": "array",
- "items": {
- "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
- "type": "string",
- "enum": ["INSTANTIATE", "SCALE", "SCALE_TO_LEVEL", "CHANGE_FLAVOUR", "TERMINATE", "HEAL", "OPERATE", "CHANGE_EXT_CONN", "MODIFY_INFO"]
- }
- },
- "operationStates": {
- "description": "Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
- "type": "array",
- "items": {
- "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
- "type": "string",
- "enum": ["STARTING", "PROCESSING", "COMPLETED", "FAILED_TEMP", "FAILED", "ROLLING_BACK", "ROLLED_BACK"]
- }
- }
- }
- },
- "callbackUri": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": ["self"],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad Request\nInvalid attribute-based filtering parameters. The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute should convey more information about the error.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}": {
- "parameters": [{
- "name": "subscriptionId",
- "description": "Identifier of this subscription. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
- "in": "path",
- "type": "string",
- "required": true
- }
- ],
- "get": {
- "description": "Query Subscription Information\n\nThe GET method retrieves information about a subscription by reading an individual subscription resource.\n",
- "tags": ["Sol003VnfLcm"],
- "parameters": [{
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- }, {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK\nThe operation has completed successfully. The response body shall contain a representation of the subscription resource.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "This type represents a subscription related to notifications about VNF lifecycle changes.\n",
- "type": "object",
- "required": ["id", "callbackUri", "_links"],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "filter": {
- "description": "This type represents a subscription filter related to notifications about VNF lifecycle changes. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n",
- "type": "object",
- "properties": {
- "vnfInstanceSubscriptionFilter": {
- "description": "This type represents subscription filter criteria to match VNF instances.\n",
- "type": "object",
- "properties": {
- "vnfdIds": {
- "description": "If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "vnfProductsFromProviders": {
- "description": "If present, match VNF instances that belong to VNF products from certain providers. The attributes \"vnfdIds\" and \"vnfProductsFromProviders\" are alternatives to reference to VNF instances that are based on certain VNFDs in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["vnfProvider"],
- "properties": {
- "vnfProvider": {
- "description": "Name of the VNF provider to match.\n",
- "type": "string"
- },
- "vnfProducts": {
- "description": "If present, match VNF instances that belong to VNF products with certain product names, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["vnfProductName"],
- "properties": {
- "vnfProductName": {
- "description": "Name of the VNF product to match.\n",
- "type": "string"
- },
- "versions": {
- "description": "If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": ["vnfSoftwareVersion"],
- "properties": {
- "vnfSoftwareVersion": {
- "description": "A version.\n",
- "type": "string"
- },
- "vnfdVersions": {
- "description": "If present, match VNF instances that belong to VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "description": "A version.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "vnfInstanceIds": {
- "description": "If present, match VNF instances with an instance identifier listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "vnfInstanceNames": {
- "description": "If present, match VNF instances with a VNF Instance Name listed in this attribute. The attributes \"vnfInstanceIds\" and \"vnfInstanceNames\" are alternatives to reference to particular VNF Instances in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "notificationTypes": {
- "description": "Match particular notification types. Permitted values: * VnfLcmOperationOccurrenceNotification * VnfIdentifierCreationNotification * VnfIdentifierDeletionNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
- "type": "array",
- "items": {
- "type": "string",
- "enum": ["VnfLcmOperationOccurrenceNotification", "VnfIdentifierCreationNotification", "VnfIdentifierDeletionNotification"]
- }
- },
- "operationTypes": {
- "description": "Match particular VNF lifecycle operation types for the notification of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
- "type": "array",
- "items": {
- "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
- "type": "string",
- "enum": ["INSTANTIATE", "SCALE", "SCALE_TO_LEVEL", "CHANGE_FLAVOUR", "TERMINATE", "HEAL", "OPERATE", "CHANGE_EXT_CONN", "MODIFY_INFO"]
- }
- },
- "operationStates": {
- "description": "Match particular LCM operation state values as reported in notifications of type VnfLcmOperationOccurrenceNotification. May be present if the \"notificationTypes\" attribute contains the value \"VnfLcmOperationOccurrenceNotification\", and shall be absent otherwise.\n",
- "type": "array",
- "items": {
- "description": "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
- "type": "string",
- "enum": ["STARTING", "PROCESSING", "COMPLETED", "FAILED_TEMP", "FAILED", "ROLLING_BACK", "ROLLED_BACK"]
- }
- }
- }
- },
- "callbackUri": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": ["self"],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": ["href"],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- },
- "delete": {
- "description": "Terminate Subscription\n\nThe DELETE method terminates an individual subscription.\n",
- "tags": ["Sol003VnfLcm"],
- "parameters": [{
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content\nThe subscription resource was deleted successfully. The response body shall be empty.\n",
- "headers": {
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- }
- },
- "400": {
- "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": ["status", "detail"],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- }
- }
-}
diff --git a/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFLifecycleManagementNotification-API.json b/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFLifecycleManagementNotification-API.json
deleted file mode 100644
index d3b6ebaa7e..0000000000
--- a/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFLifecycleManagementNotification-API.json
+++ /dev/null
@@ -1,1897 +0,0 @@
-{
- "swagger" : "2.0",
- "info" : {
- "description" : "SOL003 - VNF Lifecycle Management Notification interface\n\nIMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence.\n\nIn clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes to the attribute-based filtering mechanism are being considered in v2.5.1 of this GS for inclusion in the corresponding future ETSI NFV OpenAPI design.\nPlease report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=\n",
- "version" : "1.1.1",
- "title" : "SOL003 - VNF Lifecycle Management Notification interface",
- "license" : {
- "name" : "ETSI Forge copyright notice",
- "url" : "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
- }
- },
- "basePath" : "/so/vnfm-adapter/v1/",
- "schemes" : [ "https" ],
- "consumes" : [ "application/json" ],
- "produces" : [ "application/json" ],
- "paths" : {
- "/lcn/VnfLcmOperationOccurrenceNotification" : {
- "post" : {
- "description" : "Notify\n\nThe POST method delivers a notification from the server to the client.\n",
- "parameters" : [ {
- "in" : "body",
- "name" : "VnfLcmOperationOccurrenceNotification",
- "description" : "A notification about on-boarding of a VNF package.",
- "required" : true,
- "schema" : {
- "$ref" : "#/definitions/VnfLcmOperationOccurrenceNotification"
- }
- }, {
- "name" : "Authorization",
- "in" : "header",
- "description" : "The authorization token for the request. Reference: IETF RFC 7235\n",
- "required" : false,
- "type" : "string"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "description" : "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
- "required" : true,
- "type" : "string"
- } ],
- "responses" : {
- "204" : {
- "description" : "No Content\nThe notification was delivered successfully.\n",
- "headers" : {
- "WWW-Authenticate" : {
- "type" : "string",
- "description" : "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n"
- }
- }
- },
- "400" : {
- "description" : "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- },
- "WWW-Authenticate" : {
- "type" : "string",
- "description" : "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n"
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "401" : {
- "description" : "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- },
- "WWW-Authenticate" : {
- "type" : "string",
- "description" : "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n"
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "403" : {
- "description" : "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "404" : {
- "description" : "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "405" : {
- "description" : "Method Not Allowed\nIf a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "406" : {
- "description" : "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case. \n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "500" : {
- "description" : "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "503" : {
- "description" : "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- }
- }
- }
- },
- "/lcn/VnfIdentifierCreationNotification" : {
- "post" : {
- "description" : "Notify\n\nThe POST method delivers a notification from the server to the client.\n",
- "parameters" : [ {
- "in" : "body",
- "name" : "VnfIdentifierCreationNotification",
- "description" : "A notification about the creation of a VNF identifier and the related VNF instance resource.\n",
- "required" : true,
- "schema" : {
- "$ref" : "#/definitions/VnfIdentifierCreationNotification"
- }
- }, {
- "name" : "Authorization",
- "in" : "header",
- "description" : "The authorization token for the request. Reference: IETF RFC 7235\n",
- "required" : false,
- "type" : "string"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "description" : "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
- "required" : true,
- "type" : "string"
- } ],
- "responses" : {
- "204" : {
- "description" : "No Content\nThe notification was delivered successfully.\n",
- "headers" : {
- "WWW-Authenticate" : {
- "type" : "string",
- "description" : "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n"
- }
- }
- },
- "400" : {
- "description" : "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- },
- "WWW-Authenticate" : {
- "type" : "string",
- "description" : "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n"
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "401" : {
- "description" : "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- },
- "WWW-Authenticate" : {
- "type" : "string",
- "description" : "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n"
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "403" : {
- "description" : "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "404" : {
- "description" : "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "405" : {
- "description" : "Method Not Allowed\nIf a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "406" : {
- "description" : "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case. \n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "500" : {
- "description" : "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "503" : {
- "description" : "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- }
- }
- }
- },
- "/lcn/VnfIdentifierDeletionNotification" : {
- "post" : {
- "description" : "Notify\n\nThe POST method delivers a notification from the server to the client.\n",
- "parameters" : [ {
- "in" : "body",
- "name" : "VnfIdentifierDeletionNotification",
- "description" : "A notification about the deletion of a VNF identifier and the related VNF instance resource.\n",
- "required" : true,
- "schema" : {
- "$ref" : "#/definitions/VnfIdentifierDeletionNotification"
- }
- }, {
- "name" : "Authorization",
- "in" : "header",
- "description" : "The authorization token for the request. Reference: IETF RFC 7235\n",
- "required" : false,
- "type" : "string"
- }, {
- "name" : "Content-Type",
- "in" : "header",
- "description" : "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
- "required" : true,
- "type" : "string"
- } ],
- "responses" : {
- "204" : {
- "description" : "No Content\nThe notification was delivered successfully.\n",
- "headers" : {
- "WWW-Authenticate" : {
- "type" : "string",
- "description" : "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n"
- }
- }
- },
- "400" : {
- "description" : "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- },
- "WWW-Authenticate" : {
- "type" : "string",
- "description" : "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n"
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "401" : {
- "description" : "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- },
- "WWW-Authenticate" : {
- "type" : "string",
- "description" : "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n"
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "403" : {
- "description" : "Forbidden\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "404" : {
- "description" : "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "405" : {
- "description" : "Method Not Allowed\nIf a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "406" : {
- "description" : "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case. \n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "500" : {
- "description" : "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- },
- "503" : {
- "description" : "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers" : {
- "Content-Type" : {
- "type" : "string",
- "description" : "The MIME type of the body of the response."
- }
- },
- "schema" : {
- "type" : "object",
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n"
- }
- }
- }
- }
- }
- },
- "definitions" : {
- "lcnVnfLcmOperationOccurrenceNotification_changedInfo_vimConnectionInfo" : {
- "required" : [ "id", "vimType" ],
- "properties" : {
- "id" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "vimId" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "vimType" : {
- "type" : "string",
- "description" : "Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003.\n"
- },
- "interfaceInfo" : {
- "type" : "object",
- "description" : "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159. \n",
- "properties" : { }
- },
- "accessInfo" : {
- "type" : "object",
- "description" : "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159. \n",
- "properties" : { }
- },
- "extra" : {
- "type" : "object",
- "description" : "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159. \n",
- "properties" : { }
- }
- },
- "description" : "This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This structure is used to convey VIM-related parameters over the Or-Vnfm interface. Additional parameters for a VIM may be configured into the VNFM by means outside the scope of the present document, and bound to the identifier of that VIM.\n",
- "example" : {
- "vimType" : "vimType",
- "vimId" : "vimId",
- "extra" : "{}",
- "interfaceInfo" : "{}",
- "id" : "id",
- "accessInfo" : "{}"
- }
- },
- "lcnVnfLcmOperationOccurrenceNotification_computeResource" : {
- "required" : [ "resourceId", "vimConnectionId" ],
- "properties" : {
- "vimConnectionId" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "resourceProviderId" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "resourceId" : {
- "type" : "string",
- "description" : "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n"
- },
- "vimLevelResourceType" : {
- "type" : "string",
- "description" : "Type of the resource in the scope of the VIM or the resource provider.\n"
- }
- },
- "description" : "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "example" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- }
- },
- "lcnVnfLcmOperationOccurrenceNotification_affectedVnfcs" : {
- "required" : [ "changeType", "computeResource", "id", "vduId" ],
- "properties" : {
- "id" : {
- "type" : "string",
- "description" : "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
- },
- "vduId" : {
- "type" : "string",
- "description" : "An identifier that is unique within a VNF descriptor.\n"
- },
- "changeType" : {
- "type" : "string",
- "description" : "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVnfc structure exists as long as the temporary resource exists.\n",
- "enum" : [ "ADDED", "REMOVED", "MODIFIED", "TEMPORARY" ]
- },
- "computeResource" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_computeResource"
- },
- "metadata" : {
- "type" : "object",
- "description" : "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159. \n",
- "properties" : { }
- },
- "affectedVnfcCpIds" : {
- "type" : "array",
- "description" : "Identifiers of CP(s) of the VNFC instance that were affected by the change. Shall be present for those affected CPs of the VNFC instance that are associated to an external CP of the VNF instance. May be present for further affected CPs of the VNFC instance.\n",
- "items" : {
- "type" : "string",
- "description" : "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
- }
- },
- "addedStorageResourceIds" : {
- "type" : "array",
- "description" : "References to VirtualStorage resources that have been added. Each value refers to a VirtualStorageResourceInfo item in the VnfInstance that was added to the VNFC. It shall be provided if at least one storage resource was added to the VNFC.\n",
- "items" : {
- "type" : "string",
- "description" : "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
- }
- },
- "removedStorageResourceIds" : {
- "type" : "array",
- "description" : "References to VirtualStorage resources that have been removed. The value contains the identifier of a VirtualStorageResourceInfo item that has been removed from the VNFC, and might no longer exist in the VnfInstance. It shall be provided if at least one storage resource was removed from the VNFC.\n",
- "items" : {
- "type" : "string",
- "description" : "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
- }
- }
- },
- "description" : "This type provides information about added, deleted, modified and temporary VNFCs. \n",
- "example" : {
- "addedStorageResourceIds" : [ "addedStorageResourceIds", "addedStorageResourceIds" ],
- "metadata" : "{}",
- "changeType" : "ADDED",
- "affectedVnfcCpIds" : [ "affectedVnfcCpIds", "affectedVnfcCpIds" ],
- "id" : "id",
- "vduId" : "vduId",
- "computeResource" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "removedStorageResourceIds" : [ "removedStorageResourceIds", "removedStorageResourceIds" ]
- }
- },
- "lcnVnfLcmOperationOccurrenceNotification_changedExtConnectivity" : {
- "required" : [ "id", "resourceHandle" ],
- "properties" : {
- "id" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "resourceHandle" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_computeResource"
- },
- "extLinkPorts" : {
- "type" : "array",
- "description" : "Link ports of this VL.\n",
- "items" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_extLinkPorts"
- }
- }
- },
- "example" : {
- "resourceHandle" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "extLinkPorts" : [ {
- "resourceHandle" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "id" : "id",
- "cpInstanceId" : "cpInstanceId"
- }, {
- "resourceHandle" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "id" : "id",
- "cpInstanceId" : "cpInstanceId"
- } ],
- "id" : "id"
- }
- },
- "lcnVnfLcmOperationOccurrenceNotification_error" : {
- "required" : [ "detail", "status" ],
- "properties" : {
- "type" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference according to IETF RFC 3986 [5] 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\".\n"
- },
- "title" : {
- "type" : "string",
- "description" : "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n"
- },
- "status" : {
- "type" : "integer",
- "description" : "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n"
- },
- "detail" : {
- "type" : "string",
- "description" : "A human-readable explanation specific to this occurrence of the problem.\n"
- },
- "instance" : {
- "type" : "string",
- "format" : "URI",
- "description" : "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n"
- }
- },
- "description" : "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "example" : {
- "instance" : "instance",
- "detail" : "detail",
- "type" : "type",
- "title" : "title",
- "status" : 0
- }
- },
- "VnfLcmOperationOccurrenceNotification" : {
- "type" : "object",
- "required" : [ "_links", "id", "isAutomaticInvocation", "notificationStatus", "notificationType", "operation", "operationState", "subscriptionId", "timeStamp", "vnfInstanceId", "vnfLcmOpOccId" ],
- "properties" : {
- "id" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "notificationType" : {
- "type" : "string",
- "description" : "Discriminator for the different notification types. Shall be set to \"VnfLcmOperationOccurrenceNotification\" for this notification type.\n",
- "enum" : [ "VnfLcmOperationOccurrenceNotification" ]
- },
- "subscriptionId" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "timeStamp" : {
- "type" : "string",
- "format" : "date-time",
- "description" : "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n"
- },
- "notificationStatus" : {
- "type" : "string",
- "description" : "Indicates whether this notification reports about the start of a lifecycle operation or the result of a lifecycle operation. Permitted values: * START: Informs about the start of the VNF LCM operation\n occurrence.\n* RESULT: Informs about the final or intermediate result of the VNF\n LCM operation occurrence.\n",
- "enum" : [ "START", "RESULT" ]
- },
- "operationState" : {
- "type" : "string",
- "description" : "Value | Description ------|------------ STARTING | The LCM operation is starting. PROCESSING | The LCM operation is currently in execution. COMPLETED | he LCM operation has been completed successfully. FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed. FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed. ROLLING_BACK | The LCM operation is currently being rolled back. ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.\n",
- "enum" : [ "STARTING", "PROCESSING", "COMPLETED", "FAILED_TEMP", "FAILED", "ROLLING_BACK", "ROLLED_BACK" ]
- },
- "vnfInstanceId" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "operation" : {
- "type" : "string",
- "description" : "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation. \n",
- "enum" : [ "INSTANTIATE", "SCALE", "SCALE_TO_LEVEL", "CHANGE_FLAVOUR", "TERMINATE", "HEAL", "OPERATE", "CHANGE_EXT_CONN", "MODIFY_INFO" ]
- },
- "isAutomaticInvocation" : {
- "type" : "boolean",
- "description" : "Set to true if this VNF LCM operation occurrence has been triggered by an automated procedure inside the VNFM (i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf triggered by auto-heal). Set to false otherwise.\n"
- },
- "vnfLcmOpOccId" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "affectedVnfcs" : {
- "type" : "array",
- "description" : "Information about VNFC instances that were affected during the lifecycle operation. Shall be present if the \"notificationStatus\" is set to \"RESULT\" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the VNF LCM operation occurrence and by any of the error handling procedures for that operation occurrence.\n",
- "items" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_affectedVnfcs"
- }
- },
- "affectedVirtualLinks" : {
- "type" : "array",
- "description" : "Information about VL instances that were affected during the lifecycle operation. Shall be present if the \"notificationStatus\" is set to \"RESULT\" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the VNF LCM operation occurrence and by any of the error handling procedures for that operation occurrence.\n",
- "items" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_affectedVirtualLinks"
- }
- },
- "affectedVirtualStorages" : {
- "type" : "array",
- "description" : "Information about virtualised storage instances that were affected during the lifecycle operation. Shall be present if the \"notificationStatus\" is set to \"RESULT\" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the VNF LCM operation occurrence and by any of the error handling procedures for that operation occurrence.\n",
- "items" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_affectedVirtualStorages"
- }
- },
- "changedInfo" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_changedInfo"
- },
- "changedExtConnectivity" : {
- "type" : "array",
- "description" : "Information about changed external connectivity, if this notification represents the result of a lifecycle operation occurrence. Shall be present if the \"notificationStatus\" is set to \"RESULT\" and the \"operation\" is set to \"CHANGE_EXT_CONN\". Shall be absent otherwise.\n",
- "items" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_changedExtConnectivity"
- }
- },
- "error" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_error"
- },
- "_links" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification__links"
- }
- },
- "description" : "This type represents a VNF lifecycle management operation occurrence notification, which informs the receiver of changes in the VNF lifecycle caused by a VNF LCM operation occurrence. The support of the notification is mandatory. This notification shall be triggered by the VNFM when there is a change in the VNF lifecycle caused by a VNF LCM operation occurrence, including: * Instantiation of the VNF * Scaling of the VNF instance (including auto-scaling) * Healing of the VNF instance (including auto-healing) * Change of the state of the VNF instance (i.e. Operate VNF) * Change of the deployment flavour of the VNF instance * Change of the external connectivity of the VNF instance * Termination of the VNF instance * Modification of VNF instance information and/or VNF configurable\n properties through the \"PATCH\" method on the \"Individual VNF instance\"\n resource.\nIf this is the initial notification about the start of a VNF LCM operation occurrence, it is assumed that the notification is sent by the VNFM before any action (including sending the grant request) is taken as part of the LCM operation. Due to possible race conditions, the \"start\" notification, the grant request and the LCM operation acknowledgment can arrive in any order at the NFVO, and the NFVO shall be able to handle such a situation. If this is a notification about a final or intermediate result state of a VNF LCM operation occurrence, the notification shall be sent after all related actions of the LCM operation that led to this state have been executed. The new state shall be set in the VnfLcmOpOcc resource before the notification about the state change is sent.\n",
- "example" : {
- "notificationStatus" : "START",
- "affectedVirtualLinks" : [ {
- "metadata" : "{}",
- "networkResource" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "changeType" : "ADDED",
- "virtualLinkDescId" : "virtualLinkDescId",
- "id" : "id"
- }, {
- "metadata" : "{}",
- "networkResource" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "changeType" : "ADDED",
- "virtualLinkDescId" : "virtualLinkDescId",
- "id" : "id"
- } ],
- "affectedVirtualStorages" : [ {
- "metadata" : "{}",
- "virtualStorageDescId" : "virtualStorageDescId",
- "changeType" : "ADDED",
- "id" : "id",
- "storageResource" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- }
- }, {
- "metadata" : "{}",
- "virtualStorageDescId" : "virtualStorageDescId",
- "changeType" : "ADDED",
- "id" : "id",
- "storageResource" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- }
- } ],
- "affectedVnfcs" : [ {
- "addedStorageResourceIds" : [ "addedStorageResourceIds", "addedStorageResourceIds" ],
- "metadata" : "{}",
- "changeType" : "ADDED",
- "affectedVnfcCpIds" : [ "affectedVnfcCpIds", "affectedVnfcCpIds" ],
- "id" : "id",
- "vduId" : "vduId",
- "computeResource" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "removedStorageResourceIds" : [ "removedStorageResourceIds", "removedStorageResourceIds" ]
- }, {
- "addedStorageResourceIds" : [ "addedStorageResourceIds", "addedStorageResourceIds" ],
- "metadata" : "{}",
- "changeType" : "ADDED",
- "affectedVnfcCpIds" : [ "affectedVnfcCpIds", "affectedVnfcCpIds" ],
- "id" : "id",
- "vduId" : "vduId",
- "computeResource" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "removedStorageResourceIds" : [ "removedStorageResourceIds", "removedStorageResourceIds" ]
- } ],
- "_links" : {
- "subscription" : {
- "href" : "http://example.com/aeiou"
- },
- "vnfLcmOpOcc" : {
- "href" : "http://example.com/aeiou"
- },
- "vnfInstance" : {
- "href" : "http://example.com/aeiou"
- }
- },
- "operationState" : "STARTING",
- "notificationType" : "VnfLcmOperationOccurrenceNotification",
- "error" : {
- "instance" : "instance",
- "detail" : "detail",
- "type" : "type",
- "title" : "title",
- "status" : 0
- },
- "timeStamp" : "2000-01-23T04:56:07.000+00:00",
- "vnfInstanceId" : "vnfInstanceId",
- "vnfLcmOpOccId" : "vnfLcmOpOccId",
- "changedInfo" : {
- "vnfProductName" : "vnfProductName",
- "metadata" : "{}",
- "extensions" : "{}",
- "vimConnectionInfo" : [ {
- "vimType" : "vimType",
- "vimId" : "vimId",
- "extra" : "{}",
- "interfaceInfo" : "{}",
- "id" : "id",
- "accessInfo" : "{}"
- }, {
- "vimType" : "vimType",
- "vimId" : "vimId",
- "extra" : "{}",
- "interfaceInfo" : "{}",
- "id" : "id",
- "accessInfo" : "{}"
- } ],
- "vnfdVersion" : "vnfdVersion",
- "vnfProvider" : "vnfProvider",
- "vnfConfigurableProperties" : "{}",
- "vnfPkgId" : "vnfPkgId",
- "vnfdId" : "vnfdId",
- "vnfInstanceName" : "vnfInstanceName",
- "vnfInstanceDescription" : "vnfInstanceDescription",
- "vnfSoftwareVersion" : "vnfSoftwareVersion"
- },
- "changedExtConnectivity" : [ {
- "resourceHandle" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "extLinkPorts" : [ {
- "resourceHandle" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "id" : "id",
- "cpInstanceId" : "cpInstanceId"
- }, {
- "resourceHandle" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "id" : "id",
- "cpInstanceId" : "cpInstanceId"
- } ],
- "id" : "id"
- }, {
- "resourceHandle" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "extLinkPorts" : [ {
- "resourceHandle" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "id" : "id",
- "cpInstanceId" : "cpInstanceId"
- }, {
- "resourceHandle" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "id" : "id",
- "cpInstanceId" : "cpInstanceId"
- } ],
- "id" : "id"
- } ],
- "id" : "id",
- "subscriptionId" : "subscriptionId",
- "isAutomaticInvocation" : true,
- "operation" : "INSTANTIATE"
- }
- },
- "lcnVnfLcmOperationOccurrenceNotification_extLinkPorts" : {
- "required" : [ "id", "resourceHandle" ],
- "properties" : {
- "id" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "resourceHandle" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_computeResource"
- },
- "cpInstanceId" : {
- "type" : "string",
- "description" : "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
- }
- },
- "description" : "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL. \n",
- "example" : {
- "resourceHandle" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "id" : "id",
- "cpInstanceId" : "cpInstanceId"
- }
- },
- "VnfIdentifierCreationNotification" : {
- "type" : "object",
- "required" : [ "_links", "id", "notificationType", "timeStamp", "vnfInstanceId" ],
- "properties" : {
- "id" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "notificationType" : {
- "type" : "string",
- "description" : "Discriminator for the different notification types. Shall be set to \"VnfIdentifierCreationNotification\" for this notification type.\n",
- "enum" : [ "VnfIdentifierCreationNotification" ]
- },
- "subscriptionId" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "timeStamp" : {
- "type" : "string",
- "format" : "date-time",
- "description" : "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n"
- },
- "vnfInstanceId" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "_links" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification__links"
- }
- },
- "description" : "This type represents a VNF identifier creation notification, which informs the receiver of the creation of a new VNF instance resource and the associated VNF instance identifier. This notification shall be triggered by the VNFM when it has created a VNF instance resource and the associated VNF instance identifier.\n",
- "example" : {
- "timeStamp" : "2000-01-23T04:56:07.000+00:00",
- "vnfInstanceId" : "vnfInstanceId",
- "_links" : {
- "subscription" : {
- "href" : "http://example.com/aeiou"
- },
- "vnfLcmOpOcc" : {
- "href" : "http://example.com/aeiou"
- },
- "vnfInstance" : {
- "href" : "http://example.com/aeiou"
- }
- },
- "id" : "id",
- "notificationType" : "VnfIdentifierCreationNotification",
- "subscriptionId" : "subscriptionId"
- }
- },
- "lcnVnfLcmOperationOccurrenceNotification__links_vnfInstance" : {
- "required" : [ "href" ],
- "properties" : {
- "href" : {
- "type" : "string",
- "format" : "url",
- "description" : "URI of the referenced resource.\n"
- }
- },
- "description" : "This type represents a link to a resource.\n",
- "example" : {
- "href" : "http://example.com/aeiou"
- }
- },
- "lcnVnfLcmOperationOccurrenceNotification_changedInfo" : {
- "properties" : {
- "vnfInstanceName" : {
- "type" : "string",
- "description" : "If present, this attribute signals modifications of the \"vnfInstanceName\" attribute in \"VnfInstance\".\n"
- },
- "vnfInstanceDescription" : {
- "type" : "string",
- "description" : "If present, this attribute signals modifications of the \"vnfInstanceDescription\" attribute in \"VnfInstance\".\n"
- },
- "vnfConfigurableProperties" : {
- "type" : "object",
- "description" : "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159. \n",
- "properties" : { }
- },
- "metadata" : {
- "type" : "object",
- "description" : "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159. \n",
- "properties" : { }
- },
- "extensions" : {
- "type" : "object",
- "description" : "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159. \n",
- "properties" : { }
- },
- "vimConnectionInfo" : {
- "type" : "array",
- "description" : "If present, this attribute signals modifications of certain entries in the \"vimConnectionInfo\" attribute array in \"VnfInstance\".\n",
- "items" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_changedInfo_vimConnectionInfo"
- }
- },
- "vnfPkgId" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "vnfdId" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "vnfProvider" : {
- "type" : "string",
- "description" : "If present, this attribute signals modifications of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n"
- },
- "vnfProductName" : {
- "type" : "string",
- "description" : "If present, this attribute signals modifications of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfPkgId\" attribute) was modified implicitly following a request to modify the \"vnfPkgId\" attribute, by copying the value of this attribute from the VNFD in the VNF Package identified by the \"vnfPkgId” attribute.\n"
- },
- "vnfSoftwareVersion" : {
- "type" : "string",
- "description" : "A Version.\n"
- },
- "vnfdVersion" : {
- "type" : "string",
- "description" : "A Version.\n"
- }
- },
- "description" : "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"VnfInfoModificationRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly e.g. when modifying the referenced VNF package.\n",
- "example" : {
- "vnfProductName" : "vnfProductName",
- "metadata" : "{}",
- "extensions" : "{}",
- "vimConnectionInfo" : [ {
- "vimType" : "vimType",
- "vimId" : "vimId",
- "extra" : "{}",
- "interfaceInfo" : "{}",
- "id" : "id",
- "accessInfo" : "{}"
- }, {
- "vimType" : "vimType",
- "vimId" : "vimId",
- "extra" : "{}",
- "interfaceInfo" : "{}",
- "id" : "id",
- "accessInfo" : "{}"
- } ],
- "vnfdVersion" : "vnfdVersion",
- "vnfProvider" : "vnfProvider",
- "vnfConfigurableProperties" : "{}",
- "vnfPkgId" : "vnfPkgId",
- "vnfdId" : "vnfdId",
- "vnfInstanceName" : "vnfInstanceName",
- "vnfInstanceDescription" : "vnfInstanceDescription",
- "vnfSoftwareVersion" : "vnfSoftwareVersion"
- }
- },
- "lcnVnfLcmOperationOccurrenceNotification_affectedVirtualStorages" : {
- "required" : [ "changeType", "id", "storageResource", "virtualStorageDescId" ],
- "properties" : {
- "id" : {
- "type" : "string",
- "description" : "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
- },
- "virtualStorageDescId" : {
- "type" : "string",
- "description" : "An identifier that is unique within a VNF descriptor.\n"
- },
- "changeType" : {
- "type" : "string",
- "description" : "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY For a temporary resource, an AffectedVirtualStorage structure exists as long as the temporary resource exists.\n",
- "enum" : [ "ADDED", "REMOVED", "MODIFIED", "TEMPORARY" ]
- },
- "storageResource" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_computeResource"
- },
- "metadata" : {
- "type" : "object",
- "description" : "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159. \n",
- "properties" : { }
- }
- },
- "description" : "This type provides information about added, deleted, modified and temporary virtual storage resources.\n",
- "example" : {
- "metadata" : "{}",
- "virtualStorageDescId" : "virtualStorageDescId",
- "changeType" : "ADDED",
- "id" : "id",
- "storageResource" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- }
- }
- },
- "lcnVnfLcmOperationOccurrenceNotification__links" : {
- "required" : [ "subscription", "vnfInstance" ],
- "properties" : {
- "vnfInstance" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification__links_vnfInstance"
- },
- "subscription" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification__links_vnfInstance"
- },
- "vnfLcmOpOcc" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification__links_vnfInstance"
- }
- },
- "description" : "This type represents the links to resources that a notification can contain.\n",
- "example" : {
- "subscription" : {
- "href" : "http://example.com/aeiou"
- },
- "vnfLcmOpOcc" : {
- "href" : "http://example.com/aeiou"
- },
- "vnfInstance" : {
- "href" : "http://example.com/aeiou"
- }
- }
- },
- "VnfIdentifierDeletionNotification" : {
- "type" : "object",
- "required" : [ "_links", "id", "notificationType", "timeStamp", "vnfInstanceId" ],
- "properties" : {
- "id" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "notificationType" : {
- "type" : "string",
- "description" : "Discriminator for the different notification types. Shall be set to \"VnfIdentifierDeletionNotification\" for this notification type.\n",
- "enum" : [ "VnfIdentifierDeletionNotification" ]
- },
- "subscriptionId" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "timeStamp" : {
- "type" : "string",
- "format" : "date-time",
- "description" : "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n"
- },
- "vnfInstanceId" : {
- "type" : "string",
- "description" : "An identifier with the intention of being globally unique.\n"
- },
- "_links" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification__links"
- }
- },
- "description" : "This type represents a VNF identifier deletion notification, which informs the receiver of the deletion of a new VNF instance resource and the associated VNF instance identifier. This notification shall be triggered by the VNFM when it has deleted a VNF instance resource and the associated VNF instance identifier.\n",
- "example" : {
- "timeStamp" : "2000-01-23T04:56:07.000+00:00",
- "vnfInstanceId" : "vnfInstanceId",
- "_links" : {
- "subscription" : {
- "href" : "http://example.com/aeiou"
- },
- "vnfLcmOpOcc" : {
- "href" : "http://example.com/aeiou"
- },
- "vnfInstance" : {
- "href" : "http://example.com/aeiou"
- }
- },
- "id" : "id",
- "notificationType" : "VnfIdentifierDeletionNotification",
- "subscriptionId" : "subscriptionId"
- }
- },
- "lcnVnfLcmOperationOccurrenceNotification_affectedVirtualLinks" : {
- "required" : [ "changeType", "id", "networkResource", "virtualLinkDescId" ],
- "properties" : {
- "id" : {
- "type" : "string",
- "description" : "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n"
- },
- "virtualLinkDescId" : {
- "type" : "string",
- "description" : "An identifier that is unique within a VNF descriptor.\n"
- },
- "changeType" : {
- "type" : "string",
- "description" : "Signals the type of change. Permitted values: * ADDED * REMOVED * MODIFIED * TEMPORARY * LINK_PORT_ADDED * LINK_PORT_REMOVED For a temporary resource, an AffectedVirtualLink structure exists as long as the temporary resource exists.\n",
- "enum" : [ "ADDED", "REMOVED", "MODIFIED", "TEMPORARY", "LINK_PORT_ADDED", "LINK_PORT_REMOVED" ]
- },
- "networkResource" : {
- "$ref" : "#/definitions/lcnVnfLcmOperationOccurrenceNotification_computeResource"
- },
- "metadata" : {
- "type" : "object",
- "description" : "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159. \n",
- "properties" : { }
- }
- },
- "description" : "This type provides information about added, deleted, modified and temporary VLs.\n",
- "example" : {
- "metadata" : "{}",
- "networkResource" : {
- "resourceId" : "resourceId",
- "vimConnectionId" : "vimConnectionId",
- "vimLevelResourceType" : "vimLevelResourceType",
- "resourceProviderId" : "resourceProviderId"
- },
- "changeType" : "ADDED",
- "virtualLinkDescId" : "virtualLinkDescId",
- "id" : "id"
- }
- }
- },
- "externalDocs" : {
- "description" : "ETSI GS NFV-SOL 003 V2.4.1",
- "url" : "http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.04.01_60/gs_NFV-SOL003v020401p.pdf"
- }
-} \ No newline at end of file
diff --git a/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFLifecycleOperationGranting-API.json b/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFLifecycleOperationGranting-API.json
deleted file mode 100644
index aab56ee2af..0000000000
--- a/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFLifecycleOperationGranting-API.json
+++ /dev/null
@@ -1,2774 +0,0 @@
-{
- "swagger": "2.0",
- "info": {
- "version": "1.1.1",
- "title": "SOL003 - VNF Lifecycle Operation Granting interface",
- "description": "SOL003 - VNF Lifecycle Operation Granting interface\n\nIMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence.\n\nIn clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes to the attribute-based filtering mechanism are being considered in v2.5.1 of this GS for inclusion in the corresponding future ETSI NFV OpenAPI design.\nPlease report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=\n",
- "license": {
- "name": "ETSI Forge copyright notice",
- "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
- }
- },
- "externalDocs": {
- "description": "ETSI GS NFV-SOL 003 V2.4.1",
- "url": "http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.04.01_60/gs_NFV-SOL003v020401p.pdf"
- },
- "basePath": "/grant/v1",
- "schemes": [
- "https"
- ],
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "paths": {
- "/grants": {
- "post": {
- "description": "Grant Lifecycle Operation\n\nThe POST method requests a grant for a particular VNF lifecycle operation.\n",
- "parameters": [
- {
- "name": "GrantRequest",
- "in": "body",
- "required": true,
- "schema": {
- "description": "This type represents a grant request.\n",
- "type": "object",
- "required": [
- "vnfInstanceId",
- "vnfLcmOpOccId",
- "vnfdId",
- "operation",
- "isAutomaticInvocation",
- "_links"
- ],
- "properties": {
- "vnfInstanceId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfLcmOpOccId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfdId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "flavourId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "operation": {
- "description": "Value | Description ------|------------ INSTANTIATE | Represents the \"Instantiate VNF\" LCM operation. SCALE | Represents the \"Scale VNF\" LCM operation. SCALE_TO_LEVEL | Represents the \"Scale VNF to Level\" LCM operation. CHANGE_FLAVOUR | Represents the \"Change VNF Flavour\" LCM operation. TERMINATE | Represents the \"Terminate VNF\" LCM operation. HEAL | Represents the \"Heal VNF\" LCM operation. OPERATE | Represents the \"Operate VNF\" LCM operation. CHANGE_EXT_CONN | Represents the \"Change external VNF connectivity\" LCM operation. MODIFY_INFO | Represents the \"Modify VNF Information\" LCM operation.\n",
- "type": "string",
- "enum": [
- "INSTANTIATE",
- "SCALE",
- "SCALE_TO_LEVEL",
- "CHANGE_FLAVOUR",
- "TERMINATE",
- "HEAL",
- "OPERATE",
- "CHANGE_EXT_CONN",
- "MODIFY_INFO"
- ]
- },
- "isAutomaticInvocation": {
- "description": "Set to true if this VNF LCM operation occurrence has been triggered by an automated procedure inside the VNFM (i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf triggered by auto-heal). Set to false otherwise.\n",
- "type": "boolean"
- },
- "instantiationLevelId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "addResources": {
- "description": "List of resource definitions in the VNFD for resources to be added by the LCM operation which is related to this grant request, with one entry per resource. If the granting request is for InstantiateVNF, either instantiationLevel or addResources shall be present.\n",
- "type": "array",
- "items": {
- "description": "This type provides information of an existing or proposed resource used by the VNF.\n",
- "type": "object",
- "required": [
- "id",
- "type"
- ],
- "properties": {
- "id": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "type": {
- "description": "Type of the resource definition referenced. Permitted values: * COMPUTE * VL * STORAGE * LINKPORT\n",
- "type": "string",
- "enum": [
- "COMPUTE",
- "VL",
- "STORAGE",
- "LINKPORT"
- ]
- },
- "vduId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "resourceTemplateId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "resource": {
- "required": [
- "vimConnectionId",
- "resourceId"
- ],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "tempResources": {
- "description": "List of resource definitions in the VNFD for resources to be temporarily instantiated during the runtime of the LCM operation which is related to this grant request, with one entry per resource. The NFVO will assume that the VNFM will be responsible to both allocate and release the temporary resource during the runtime of the LCM operation. This means, the resource can be allocated and consumed after the \"start\" notification for the LCM operation is sent by the VNFM, and the resource will be released before the \"result\" notification of the VNF LCM operation is sent by the VNFM.\n",
- "type": "array",
- "items": {
- "description": "This type provides information of an existing or proposed resource used by the VNF.\n",
- "type": "object",
- "required": [
- "id",
- "type"
- ],
- "properties": {
- "id": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "type": {
- "description": "Type of the resource definition referenced. Permitted values: * COMPUTE * VL * STORAGE * LINKPORT\n",
- "type": "string",
- "enum": [
- "COMPUTE",
- "VL",
- "STORAGE",
- "LINKPORT"
- ]
- },
- "vduId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "resourceTemplateId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "resource": {
- "required": [
- "vimConnectionId",
- "resourceId"
- ],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "removeResources": {
- "description": "Provides the definitions of resources to be removed by the LCM operation which is related to this grant request, with one entry per resource.\n",
- "type": "array",
- "items": {
- "description": "This type provides information of an existing or proposed resource used by the VNF.\n",
- "type": "object",
- "required": [
- "id",
- "type"
- ],
- "properties": {
- "id": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "type": {
- "description": "Type of the resource definition referenced. Permitted values: * COMPUTE * VL * STORAGE * LINKPORT\n",
- "type": "string",
- "enum": [
- "COMPUTE",
- "VL",
- "STORAGE",
- "LINKPORT"
- ]
- },
- "vduId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "resourceTemplateId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "resource": {
- "required": [
- "vimConnectionId",
- "resourceId"
- ],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "updateResources": {
- "description": "Provides the definitions of resources to be modified by the LCM operation which is related to this grant request, with one entry per resource.\n",
- "type": "array",
- "items": {
- "description": "This type provides information of an existing or proposed resource used by the VNF.\n",
- "type": "object",
- "required": [
- "id",
- "type"
- ],
- "properties": {
- "id": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "type": {
- "description": "Type of the resource definition referenced. Permitted values: * COMPUTE * VL * STORAGE * LINKPORT\n",
- "type": "string",
- "enum": [
- "COMPUTE",
- "VL",
- "STORAGE",
- "LINKPORT"
- ]
- },
- "vduId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "resourceTemplateId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "resource": {
- "required": [
- "vimConnectionId",
- "resourceId"
- ],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "placementConstraints": {
- "description": "Placement constraints that the VNFM may send to the NFVO in order to influence the resource placement decision. If sent, the NFVO shall take the constraints into consideration when making resource placement decisions, and shall reject the grant if they cannot be honoured. The affinity/anti-affinity rules defined in the VNFD , and the placement constraints in the GrantVnfLifecycleOperation as defined in this clause should be conflict-free. In case of conflicts, the placement constraints in the GrantVnfLifecycleOperation shall take precedence. Passing constraints allows the VNFM or the lifecycle management scripts to influence resource placement decisions by the NFVO to ensure VNF properties such as performance or fault tolerance.\n",
- "type": "array",
- "items": {
- "description": "This type provides information regarding a resource placement constraint. A set of such constraints may be sent by the VNFM to the NFVO to influence the resource placement decisions made by the NFVO as part of the granting process. A placement constraint defines a condition to the placement of new resources, considering other new resources as well as existing resources. EXAMPLE: The following rules influence the placement of a set of resources such that they are placed in the same Network Function Virtualisation Infrastructure Point of Presence (NFVI-PoP) but in different resource zones: {type=\"affinity\"; scope=\"NFVI_POP\"; {resource1,resource2}} {type=\"anti-affinity\"; scope=\"ZONE\"; {resource1,resource2}}\n",
- "type": "object",
- "required": [
- "affinityOrAntiAffinity",
- "scope",
- "resource"
- ],
- "properties": {
- "affinityOrAntiAffinity": {
- "description": "The type of the constraint. Permitted values: * AFFINITY * ANTI_AFFINITY\n",
- "type": "string",
- "enum": [
- "AFFINITY",
- "ANTI_AFFINITY"
- ]
- },
- "scope": {
- "description": "The scope of the placement constraint indicating the category of the \"place\" where the constraint applies. Permitted values: * NFVI_POP * ZONE * ZONE_GROUP * NFVI_NODE\n",
- "type": "string",
- "enum": [
- "NFVI_POP",
- "ZONE",
- "ZONE_GROUP",
- "NFVI_NODE"
- ]
- },
- "resource": {
- "description": "References to resources in the constraint rule.\n",
- "type": "array",
- "items": {
- "description": "This type references a resource either by its VIM-level identifier for existing resources, or by the identifier of a \"ResourceDefinition\" structure in the \"GrantRequest\" structure for new resources.\n",
- "type": "object",
- "required": [
- "idType",
- "resourceId"
- ],
- "properties": {
- "idType": {
- "description": "The type of the identifier. Permitted values: * RES_MGMT: Resource-management-level identifier; this identifier is managed by the VIM in the direct mode of VNF-related resource\n management, and is managed by the NFVO in the indirect mode)\n* GRANT: Reference to the identifier of a \"ResourceDefinition\" structure in the \"GrantRequest\" structure.\n",
- "type": "string",
- "enum": [
- "RES_MGMT",
- "GRANT"
- ]
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "vimConstraints": {
- "description": "Used by the VNFM to require that multiple resources are managed through the same VIM connection. If sent, the NFVO shall take the constraints into consideration when making VIM selection decisions, and shall reject the grant if they cannot be honoured. This attribute shall be supported if VNF-related Resource Management in direct mode is applicable. The applicability and further details of this attribute for indirect mode are left for future specification.\n",
- "type": "array",
- "items": {
- "description": "This type provides information regarding a VIM selection constraint. A set of such constraints may be sent by the VNFM to the NFVO to influence the VIM selection decisions made by the NFVO as part of the granting process.\n",
- "type": "object",
- "required": [
- "resource"
- ],
- "properties": {
- "sameResourceGroup": {
- "description": "If present and set to true, this signals that the constraint applies not only to the same VIM connection, but also to the same infrastructure resource group.\n",
- "type": "boolean"
- },
- "resource": {
- "description": "References to resources in the constraint rule. The NFVO shall ensure that all resources in this list are managed through the same VIM connection. If \"sameResourceGroup\" is set to true, the NFVO shall further ensure that all resources in this list are part of the same infrastructure resource group in that VIM connection.\n",
- "type": "array",
- "items": {
- "description": "This type references a resource either by its VIM-level identifier for existing resources, or by the identifier of a \"ResourceDefinition\" structure in the \"GrantRequest\" structure for new resources.\n",
- "type": "object",
- "required": [
- "idType",
- "resourceId"
- ],
- "properties": {
- "idType": {
- "description": "The type of the identifier. Permitted values: * RES_MGMT: Resource-management-level identifier; this identifier is managed by the VIM in the direct mode of VNF-related resource\n management, and is managed by the NFVO in the indirect mode)\n* GRANT: Reference to the identifier of a \"ResourceDefinition\" structure in the \"GrantRequest\" structure.\n",
- "type": "string",
- "enum": [
- "RES_MGMT",
- "GRANT"
- ]
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "additionalParams": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "_links": {
- "description": "Links to resources related to this request.\n",
- "type": "object",
- "required": [
- "vnfLcmOpOcc",
- "vnfInstance"
- ],
- "properties": {
- "vnfLcmOpOcc": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "vnfInstance": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- }
- }
- }
- }
- }
- },
- {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- },
- {
- "name": "Content-Type",
- "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- },
- {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "201": {
- "description": "Created\nThe grant was created successfully (synchronous mode). A representation of the created \"Individual grant\" resource shall be returned in the response body. The HTTP response shall include a \"Location\" HTTP header that indicates the URI of the \"Individual grant\" resource just created.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "Location": {
- "description": "The resource URI of the created VNF instance",
- "type": "string",
- "format": "url"
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "This type represents a grant.\n",
- "type": "object",
- "required": [
- "id",
- "vnfInstanceId",
- "vnfLcmOpOccId",
- "_links"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfInstanceId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfLcmOpOccId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnections": {
- "description": "Provides information regarding VIM connections that are approved to be used by the VNFM to allocate resources, and provides parameters of these VIM connections. The VNFM shall update the \" vimConnectionInfo\" attribute of the \"VnfInstance\" structure by adding unknown entries received in this attribute. This attribute is not intended for the modification of VimConnection entries passed earlier; for that, the VnfInfoModificationRequest structure shall be used. This attribute shall only be supported when VNF-related Resource Management in direct mode is applicable. In direct mode, this parameter shall be absent if the VIM information was configured to the VNFM in another way, present otherwise. This interface allows to signal the use of multiple VIMs per VNF. However, due to the partial support of this feature in the present release, it is recommended in the present document that the number of entries in the \"vims\" attribute in the Grant is not greater than 1.\n",
- "type": "array",
- "items": {
- "description": "This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This structure is used to convey VIM-related parameters over the Or-Vnfm interface. Additional parameters for a VIM may be configured into the VNFM by means outside the scope of the present document, and bound to the identifier of that VIM.\n",
- "type": "object",
- "required": [
- "id",
- "vimType"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimType": {
- "description": "Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003.\n",
- "type": "string"
- },
- "interfaceInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "accessInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "extra": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "zones": {
- "description": "Identifies resource zones where the resources are approved to be allocated by the VNFM.\n",
- "type": "array",
- "items": {
- "description": "This type provides information regarding a resource zone.\n",
- "type": "object",
- "required": [
- "id",
- "zoneId"
- ],
- "properties": {
- "id": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "zoneId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- }
- }
- },
- "zoneGroups": {
- "description": "Information about groups of resource zones that are related and that the NFVO has chosen to fulfil a zoneGroup constraint in the GrantVnfLifecycleOperation request. This information confirms that the NFVO has honoured the zoneGroup constraints that were passed as part of \"placementConstraints\" in the GrantRequest.\n",
- "type": "array",
- "items": {
- "description": "This type provides information regarding a resource zone group. A resource zone group is a group of one or more related resource zones which can be used in resource placement constraints. To fulfil such constraint, the NFVO may decide to place a resource into any zone that belongs to a particular group. NOTE: A resource zone group can be used to support overflow from one resource zone into another, in case a particular deployment supports only non-elastic resource zones.\n",
- "type": "object",
- "required": [
- "zoneId"
- ],
- "properties": {
- "zoneId": {
- "description": "References of identifiers of \"ZoneInfo\" structures, each of which provides information about a resource zone that belongs to this group.\n",
- "type": "array",
- "items": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- }
- }
- }
- }
- },
- "computeReservationId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "networkReservationId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "storageReservationId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "addResources": {
- "description": "List of resources that are approved to be added, with one entry per resource.\n",
- "type": "array",
- "items": {
- "description": "This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted.\n",
- "type": "object",
- "required": [
- "resourceDefinitionId"
- ],
- "properties": {
- "resourceDefinitionId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "zoneId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "resourceGroupId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- },
- "tempResources": {
- "description": "List of resources that are approved to be temporarily instantiated during the runtime of the lifecycle operation, with one entry per resource.\n",
- "type": "array",
- "items": {
- "description": "This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted.\n",
- "type": "object",
- "required": [
- "resourceDefinitionId"
- ],
- "properties": {
- "resourceDefinitionId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "zoneId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "resourceGroupId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- },
- "removeResources": {
- "description": "List of resources that are approved to be removed, with one entry per resource.\n",
- "type": "array",
- "items": {
- "description": "This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted.\n",
- "type": "object",
- "required": [
- "resourceDefinitionId"
- ],
- "properties": {
- "resourceDefinitionId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "zoneId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "resourceGroupId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- },
- "updateResources": {
- "description": "List of resources that are approved to be modified, with one entry per resource.\n",
- "type": "array",
- "items": {
- "description": "This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted.\n",
- "type": "object",
- "required": [
- "resourceDefinitionId"
- ],
- "properties": {
- "resourceDefinitionId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "zoneId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "resourceGroupId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- },
- "vimAssets": {
- "description": "Information about assets for the VNF that are managed by the NFVO in the VIM, such as software images and virtualised compute resource flavours. This attribute is not intended for the modification of vimAssets entries passed earlier. Modification of VIM assets during the lifetime of a VNF instance is not necessary, since it is expected that all applicable assets have been on boarded into the VIM before the VNF is instantiated.\n",
- "type": "object",
- "properties": {
- "computeResourceFlavours": {
- "description": "Mappings between virtual compute descriptors defined in the VNFD and compute resource flavours managed in the VIM.\n",
- "type": "array",
- "items": {
- "description": "If the VIM requires the use of virtual compute resource flavours during compute resource instantiation, it is assumed that such flavours are selected or created by the NFVO based on the information in the virtual compute descriptor defined in the VNFD. This type defines the mapping between a virtual compute descriptor in the VNFD and the corresponding compute resource flavour managed by the NFVO in the VIM.\n",
- "type": "object",
- "required": [
- "vnfdVirtualComputeDescId",
- "vimFlavourId"
- ],
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfdVirtualComputeDescId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "vimFlavourId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- },
- "softwareImages": {
- "description": "Mappings between software images defined in the VNFD and software images managed in the VIM.\n",
- "type": "array",
- "items": {
- "description": "This type contains a mapping between a software image definition the VNFD and the corresponding software image managed by the NFVO in the VIM which is needed during compute resource instantiation.\n",
- "type": "object",
- "required": [
- "vnfdSoftwareImageId",
- "vimSoftwareImageId"
- ],
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfdSoftwareImageId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "vimSoftwareImageId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "extVirtualLinks": {
- "description": "Information about external VLs to connect the VNF to. External and/or externally-managed internal VLs can be passed in VNF lifecycle management operation requests such as InstantiateVnf or ChangeVnfFlavor, and/or in the grant response. The NFVO may choose to override in the grant response external and/or externally-managed VL instances that have been passed previously in the associated VNF lifecycle management request, if the lifecycle management request has originated from the NFVO itself.\n",
- "type": "array",
- "items": {
- "description": "This type represents an external VL.\n",
- "type": "object",
- "required": [
- "id",
- "resourceId",
- "extCps"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "extCps": {
- "description": "External CPs of the VNF to be connected to this external VL.\n",
- "type": "array",
- "items": {
- "description": "This type represents configuration information for external CPs created from a CPD.\n",
- "type": "object",
- "required": [
- "cpdId"
- ],
- "properties": {
- "cpdId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "cpConfig": {
- "description": "List of instance data that need to be configured on the CP instances created from the respective CPD.\n",
- "type": "array",
- "items": {
- "description": "This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n",
- "type": "object",
- "properties": {
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "linkPortId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "cpProtocolData": {
- "description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": * The \"linkPortId\" and \"cpProtocolData\" attributes shall both be absent for the deletion of an existing external CP instance\n addressed by cpInstanceId. \n* At least one of these attributes shall be present for a to-be-created external CP instance or an existing external\n CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
- "type": "array",
- "items": {
- "description": "This type represents network protocol data.\n",
- "type": "object",
- "required": [
- "layerProtocol"
- ],
- "properties": {
- "layerProtocol": {
- "description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
- "type": "string",
- "enum": [
- "IP_OVER_ETHERNET"
- ]
- },
- "ipOverEthernet": {
- "description": "This type represents network address data for IP over Ethernet.\n",
- "type": "object",
- "properties": {
- "macAddress": {
- "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
- "type": "string",
- "format": "MAC"
- },
- "ipAddresses": {
- "description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "type": {
- "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
- "type": "string",
- "enum": [
- "IPV4",
- "IPV6"
- ]
- },
- "fixedAddresses": {
- "description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
- "type": "array",
- "items": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- },
- "numDynamicAddresses": {
- "description": "Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
- "type": "integer"
- },
- "addressRange": {
- "description": "An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n",
- "type": "object",
- "required": [
- "minAddress",
- "maxAddress"
- ],
- "properties": {
- "minAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- },
- "maxAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- },
- "subnetId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "extLinkPorts": {
- "description": "Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the VNFM shall create the link ports on the external VL.\n",
- "type": "array",
- "items": {
- "description": "This type represents an externally provided link port to be used to connect an external connection point to an external VL.\n",
- "type": "object",
- "required": [
- "id",
- "resourceHandle"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": [
- "vimConnectionId",
- "resourceId"
- ],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "extManagedVirtualLinks": {
- "description": "Information about internal VLs that are managed by other entities than the VNFM. The indication of externally-managed internal VLs is needed in case networks have been pre-configured for use with certain VNFs, for instance to ensure that these networks have certain properties such as security or acceleration features, or to address particular network topologies. The present document assumes that externally-managed internal VLs are managed by the NFVO and created towards the VIM. External and/or externally-managed internal VLs can be passed in VNF lifecycle management operation requests such as InstantiateVnf or ChangeVnfFlavor, and/or in the grant response. The NFVO may choose to override in the grant response external and/or externally-managed VL instances that have been passed previously in the associated VNF lifecycle management request, if the lifecycle management request has originated from the NFVO itself.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "id",
- "virtualLinkDescId",
- "resourceId"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "virtualLinkDescId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- },
- "additionalParams": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": [
- "self",
- "vnfLcmOpOcc",
- "vnfInstance"
- ],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "vnfLcmOpOcc": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "vnfInstance": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- }
- }
- }
- }
- }
- },
- "202": {
- "description": "Accepted\nThe request was accepted for processing, but the processing has not been completed. It is expected to take some time to create the grant (asynchronous mode). The response body shall be empty. The HTTP response shall include a \"Location\" HTTP header that indicates the URI of the \"Individual grant\" resource that will be created once the granting decision has been made.\n",
- "headers": {
- "Location": {
- "description": "The resource URI of the created VNF instance",
- "type": "string",
- "format": "url"
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- }
- },
- "400": {
- "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden\nThe grant was rejected. A ProblemDetails structure shall be included in the response to provide more details about the rejection in the \"details\" attribute.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "Method Not Allowed\nIf a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "Requested Range Not Satisfiable\nThis code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "422": {
- "description": "Unprocessable Entity\nIf the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem. NOTE 2: This error response code is only applicable for methods that have a request body.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/grants/{grantId}": {
- "parameters": [
- {
- "name": "grantId",
- "description": "Identifier of the grant. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request granting a new VNF lifecycle operation. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
- "in": "path",
- "type": "string",
- "required": true
- }
- ],
- "get": {
- "description": "Grant Lifecycle Operation\n\nThe GET method retrieves information about a specific grant by reading an individual grant resource.\n",
- "parameters": [
- {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- },
- {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK\nThe grant was read successfully. A representation of the \"individual grant\" resource shall be returned in the response body.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "This type represents a grant.\n",
- "type": "object",
- "required": [
- "id",
- "vnfInstanceId",
- "vnfLcmOpOccId",
- "_links"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfInstanceId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfLcmOpOccId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnections": {
- "description": "Provides information regarding VIM connections that are approved to be used by the VNFM to allocate resources, and provides parameters of these VIM connections. The VNFM shall update the \" vimConnectionInfo\" attribute of the \"VnfInstance\" structure by adding unknown entries received in this attribute. This attribute is not intended for the modification of VimConnection entries passed earlier; for that, the VnfInfoModificationRequest structure shall be used. This attribute shall only be supported when VNF-related Resource Management in direct mode is applicable. In direct mode, this parameter shall be absent if the VIM information was configured to the VNFM in another way, present otherwise. This interface allows to signal the use of multiple VIMs per VNF. However, due to the partial support of this feature in the present release, it is recommended in the present document that the number of entries in the \"vims\" attribute in the Grant is not greater than 1.\n",
- "type": "array",
- "items": {
- "description": "This type represents parameters to connect to a VIM for managing the resources of a VNF instance. This structure is used to convey VIM-related parameters over the Or-Vnfm interface. Additional parameters for a VIM may be configured into the VNFM by means outside the scope of the present document, and bound to the identifier of that VIM.\n",
- "type": "object",
- "required": [
- "id",
- "vimType"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimType": {
- "description": "Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM. The set of permitted values is expected to change over time as new types or versions of VIMs become available. The ETSI NFV registry of VIM-related information provides access to information about VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in Annex C of SOL003.\n",
- "type": "string"
- },
- "interfaceInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "accessInfo": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "extra": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "zones": {
- "description": "Identifies resource zones where the resources are approved to be allocated by the VNFM.\n",
- "type": "array",
- "items": {
- "description": "This type provides information regarding a resource zone.\n",
- "type": "object",
- "required": [
- "id",
- "zoneId"
- ],
- "properties": {
- "id": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "zoneId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- }
- }
- },
- "zoneGroups": {
- "description": "Information about groups of resource zones that are related and that the NFVO has chosen to fulfil a zoneGroup constraint in the GrantVnfLifecycleOperation request. This information confirms that the NFVO has honoured the zoneGroup constraints that were passed as part of \"placementConstraints\" in the GrantRequest.\n",
- "type": "array",
- "items": {
- "description": "This type provides information regarding a resource zone group. A resource zone group is a group of one or more related resource zones which can be used in resource placement constraints. To fulfil such constraint, the NFVO may decide to place a resource into any zone that belongs to a particular group. NOTE: A resource zone group can be used to support overflow from one resource zone into another, in case a particular deployment supports only non-elastic resource zones.\n",
- "type": "object",
- "required": [
- "zoneId"
- ],
- "properties": {
- "zoneId": {
- "description": "References of identifiers of \"ZoneInfo\" structures, each of which provides information about a resource zone that belongs to this group.\n",
- "type": "array",
- "items": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- }
- }
- }
- }
- },
- "computeReservationId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "networkReservationId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "storageReservationId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "addResources": {
- "description": "List of resources that are approved to be added, with one entry per resource.\n",
- "type": "array",
- "items": {
- "description": "This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted.\n",
- "type": "object",
- "required": [
- "resourceDefinitionId"
- ],
- "properties": {
- "resourceDefinitionId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "zoneId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "resourceGroupId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- },
- "tempResources": {
- "description": "List of resources that are approved to be temporarily instantiated during the runtime of the lifecycle operation, with one entry per resource.\n",
- "type": "array",
- "items": {
- "description": "This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted.\n",
- "type": "object",
- "required": [
- "resourceDefinitionId"
- ],
- "properties": {
- "resourceDefinitionId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "zoneId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "resourceGroupId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- },
- "removeResources": {
- "description": "List of resources that are approved to be removed, with one entry per resource.\n",
- "type": "array",
- "items": {
- "description": "This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted.\n",
- "type": "object",
- "required": [
- "resourceDefinitionId"
- ],
- "properties": {
- "resourceDefinitionId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "zoneId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "resourceGroupId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- },
- "updateResources": {
- "description": "List of resources that are approved to be modified, with one entry per resource.\n",
- "type": "array",
- "items": {
- "description": "This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted.\n",
- "type": "object",
- "required": [
- "resourceDefinitionId"
- ],
- "properties": {
- "resourceDefinitionId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "reservationId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "zoneId": {
- "description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
- "type": "string"
- },
- "resourceGroupId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- },
- "vimAssets": {
- "description": "Information about assets for the VNF that are managed by the NFVO in the VIM, such as software images and virtualised compute resource flavours. This attribute is not intended for the modification of vimAssets entries passed earlier. Modification of VIM assets during the lifetime of a VNF instance is not necessary, since it is expected that all applicable assets have been on boarded into the VIM before the VNF is instantiated.\n",
- "type": "object",
- "properties": {
- "computeResourceFlavours": {
- "description": "Mappings between virtual compute descriptors defined in the VNFD and compute resource flavours managed in the VIM.\n",
- "type": "array",
- "items": {
- "description": "If the VIM requires the use of virtual compute resource flavours during compute resource instantiation, it is assumed that such flavours are selected or created by the NFVO based on the information in the virtual compute descriptor defined in the VNFD. This type defines the mapping between a virtual compute descriptor in the VNFD and the corresponding compute resource flavour managed by the NFVO in the VIM.\n",
- "type": "object",
- "required": [
- "vnfdVirtualComputeDescId",
- "vimFlavourId"
- ],
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfdVirtualComputeDescId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "vimFlavourId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- },
- "softwareImages": {
- "description": "Mappings between software images defined in the VNFD and software images managed in the VIM.\n",
- "type": "array",
- "items": {
- "description": "This type contains a mapping between a software image definition the VNFD and the corresponding software image managed by the NFVO in the VIM which is needed during compute resource instantiation.\n",
- "type": "object",
- "required": [
- "vnfdSoftwareImageId",
- "vimSoftwareImageId"
- ],
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfdSoftwareImageId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "vimSoftwareImageId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "extVirtualLinks": {
- "description": "Information about external VLs to connect the VNF to. External and/or externally-managed internal VLs can be passed in VNF lifecycle management operation requests such as InstantiateVnf or ChangeVnfFlavor, and/or in the grant response. The NFVO may choose to override in the grant response external and/or externally-managed VL instances that have been passed previously in the associated VNF lifecycle management request, if the lifecycle management request has originated from the NFVO itself.\n",
- "type": "array",
- "items": {
- "description": "This type represents an external VL.\n",
- "type": "object",
- "required": [
- "id",
- "resourceId",
- "extCps"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "extCps": {
- "description": "External CPs of the VNF to be connected to this external VL.\n",
- "type": "array",
- "items": {
- "description": "This type represents configuration information for external CPs created from a CPD.\n",
- "type": "object",
- "required": [
- "cpdId"
- ],
- "properties": {
- "cpdId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "cpConfig": {
- "description": "List of instance data that need to be configured on the CP instances created from the respective CPD.\n",
- "type": "array",
- "items": {
- "description": "This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n",
- "type": "object",
- "properties": {
- "cpInstanceId": {
- "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
- "type": "string"
- },
- "linkPortId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "cpProtocolData": {
- "description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": * The \"linkPortId\" and \"cpProtocolData\" attributes shall both be absent for the deletion of an existing external CP instance\n addressed by cpInstanceId. \n* At least one of these attributes shall be present for a to-be-created external CP instance or an existing external\n CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
- "type": "array",
- "items": {
- "description": "This type represents network protocol data.\n",
- "type": "object",
- "required": [
- "layerProtocol"
- ],
- "properties": {
- "layerProtocol": {
- "description": "Identifier of layer(s) and protocol(s). This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
- "type": "string",
- "enum": [
- "IP_OVER_ETHERNET"
- ]
- },
- "ipOverEthernet": {
- "description": "This type represents network address data for IP over Ethernet.\n",
- "type": "object",
- "properties": {
- "macAddress": {
- "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
- "type": "string",
- "format": "MAC"
- },
- "ipAddresses": {
- "description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "type": {
- "description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
- "type": "string",
- "enum": [
- "IPV4",
- "IPV6"
- ]
- },
- "fixedAddresses": {
- "description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
- "type": "array",
- "items": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- },
- "numDynamicAddresses": {
- "description": "Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
- "type": "integer"
- },
- "addressRange": {
- "description": "An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n",
- "type": "object",
- "required": [
- "minAddress",
- "maxAddress"
- ],
- "properties": {
- "minAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- },
- "maxAddress": {
- "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
- "type": "string",
- "format": "IP"
- }
- }
- },
- "subnetId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "extLinkPorts": {
- "description": "Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the VNFM shall create the link ports on the external VL.\n",
- "type": "array",
- "items": {
- "description": "This type represents an externally provided link port to be used to connect an external connection point to an external VL.\n",
- "type": "object",
- "required": [
- "id",
- "resourceHandle"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceHandle": {
- "required": [
- "vimConnectionId",
- "resourceId"
- ],
- "type": "object",
- "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
- "properties": {
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- },
- "vimLevelResourceType": {
- "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "extManagedVirtualLinks": {
- "description": "Information about internal VLs that are managed by other entities than the VNFM. The indication of externally-managed internal VLs is needed in case networks have been pre-configured for use with certain VNFs, for instance to ensure that these networks have certain properties such as security or acceleration features, or to address particular network topologies. The present document assumes that externally-managed internal VLs are managed by the NFVO and created towards the VIM. External and/or externally-managed internal VLs can be passed in VNF lifecycle management operation requests such as InstantiateVnf or ChangeVnfFlavor, and/or in the grant response. The NFVO may choose to override in the grant response external and/or externally-managed VL instances that have been passed previously in the associated VNF lifecycle management request, if the lifecycle management request has originated from the NFVO itself.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "id",
- "virtualLinkDescId",
- "resourceId"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "virtualLinkDescId": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "vimConnectionId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceProviderId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "resourceId": {
- "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
- "type": "string"
- }
- }
- }
- },
- "additionalParams": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": [
- "self",
- "vnfLcmOpOcc",
- "vnfInstance"
- ],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "vnfLcmOpOcc": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- },
- "vnfInstance": {
- "description": "This type represents a link to a resource.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "URI of the referenced resource.\n",
- "type": "string",
- "format": "url"
- }
- }
- }
- }
- }
- }
- }
- },
- "202": {
- "description": "Accepted\nThe process of creating the grant is ongoing, no grant is available yet. The response body shall be empty.\n",
- "headers": {
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- }
- },
- "400": {
- "description": "Bad Request\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\n ---\n\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n ---\n\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code.The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden\nThe grant was rejected. A ProblemDetails structure shall be included in the response to provide more details about the rejection in the \"details\" attribute.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "Not Found\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "Method Not Allowed\nIf a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted in that case.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "Requested Range Not Satisfiable\nThis code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "422": {
- "description": "Unprocessable Entity\nIf the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem. NOTE 2: This error response code is only applicable for methods that have a request body.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond withthis response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "Service Unavailable\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- }
- }
-} \ No newline at end of file
diff --git a/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFPackageManagement-API.json b/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFPackageManagement-API.json
deleted file mode 100644
index 17d81f44c1..0000000000
--- a/adapters/mso-vnfm-adapter/mso-vnfm-adapter-ext-clients/src/main/resources/SOL003-VNFPackageManagement-API.json
+++ /dev/null
@@ -1,7352 +0,0 @@
-{
- "swagger": "2.0",
- "info": {
- "version": "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1",
- "title": "SOL003 - VNF Package Management interface",
- "description": "SOL003 - VNF Package Management interface\n\nIMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence.\n\nIn clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes to the attribute-based filtering mechanism are being considered in v2.5.1 of this GS for inclusion in the corresponding future ETSI NFV OpenAPI design.\nPlease report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=\n",
- "license": {
- "name": "ETSI Forge copyright notice",
- "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
- }
- },
- "externalDocs": {
- "description": "ETSI GS NFV-SOL 003 V2.5.1",
- "url": "https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf"
- },
- "basePath": "/vnfpkgm/v1",
- "schemes": [
- "https"
- ],
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "paths": {
- "/api-versions": {
- "parameters": [
- {
- "name": "Version",
- "description": "Version of the API requested to use when responding to this request.\n",
- "in": "header",
- "required": false,
- "type": "string"
- }
- ],
- "get": {
- "summary": "Retrieve API version information",
- "description": "The GET method reads API version information. This method shall follow the provisions specified in table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not supported.\n",
- "responses": {
- "200": {
- "description": "200 OK\nAPI version information was read successfully. The response body shall contain 4.4 API version information, as defined in clause 4.4.1.13.\n",
- "schema": {
- "description": "This type represents API version information. It shall comply with the provisions defined in table 4.4.1.13-1 (SOL003).\n",
- "type": "object",
- "required": [
- "uriPrefix",
- "apiVersions"
- ],
- "properties": {
- "uriPrefix": {
- "description": "Specifies the URI prefix for the API, in the following form {apiRoot}/{apiName}/{apiMajorVersion}/\n",
- "type": "string"
- },
- "apiVersions": {
- "description": "Version(s) supported for the API signaled by the uriPrefix attribute.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "version"
- ],
- "properties": {
- "version": {
- "description": "Identifies a supported version. The value of the version attribute shall be a version identifier as specified in clause 4.6.1.\n",
- "type": "string"
- },
- "isDeprecated": {
- "description": "If such information is available, this attribute indicates whether use of the version signaled by the version attribute is deprecated (true) or not (false). A deprecated version is still supported by the API producer but is recommended not to be used any longer. When a version is no longer supported, it does not appear in the response body.\n",
- "type": "boolean"
- },
- "retirementDate": {
- "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
- "type": "string",
- "format": "date-time"
- }
- }
- }
- }
- }
- },
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "Version": {
- "description": "The used API version.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- }
- },
- "400": {
- "description": "400 BAD REQUEST\n400 code can be returned in the following specified cases, the specific cause has to be proper specified in the \"ProblemDetails\" structure to be returned.\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\nThe use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "401 UNAUTHORIZED\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "403 FORBIDDEN\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "405 METHOD NOT ALLOWED\nIf a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "406 NOT ACCEPTABLE\nIf the \"Accept\" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "413": {
- "description": "413 PAYLOAD TOO LARGE\nIf the payload body of a request is larger than the amount of data the API producer is willing or able to process, it shall respond with this response code, following the provisions in IETF RFC 7231 for the use of the \"Retry-After\" HTTP header and for closing the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "414": {
- "description": "414 URI TOO LONG\nIf the request URI of a request is longer than the API producer is willing or able to process, it shall respond with this response code. This condition can e.g. be caused by passing long queries in the request URI of a GET request. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "416 RANGE NOT SATISFIABLE\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "422": {
- "description": "422 UNPROCESSABLE ENTITY\nIf the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nThis error response code is only applicable for methods that have a request body.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "429": {
- "description": "429 TOO MANY REQUESTS\nIf the API consumer has sent too many requests in a defined period of time and the API producer is able to detect that condition (\"rate limiting\"), the API producer shall respond with this response code, following the provisions in IETF RFC 6585 [17] for the use of the \"Retry-After\" HTTP header. The \"ProblemDetails\" structure shall be provided and shall include in the \"detail\" attribute more information about the source of the problem.\nThe period of time and allowed number of requests are configured within the API producer by means outside the scope of the present document.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "500 INTERNAL SERVER ERROR\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "503 SERVICE UNAVAILABLE\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "504": {
- "description": "504 GATEWAY TIMEOUT\nIf the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/vnf_packages": {
- "get": {
- "description": "Query VNF Package Info\n\nThe GET method queries the information of the VNF packages matching the filter.\n",
- "parameters": [
- {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- },
- {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- },
- {
- "name": "filter",
- "description": "Attribute-based filtering expression according to clause 4.3.2. The VNFM shall support receiving this parameter as part of the URI query string. The NFVO may supply this parameter. All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall be supported by the VNFM in the filter expression.\n",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "all_fields",
- "description": "Include all complex attributes in the response. See clause 4.3.3 for details. The VNFM shall support this parameter.\n",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "fields",
- "description": "Complex attributes to be included into the response. See clause 4.3.3 for details. The VNFM should support this parameter.\n",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "exclude_fields",
- "description": "Complex attributes to be excluded from the response. See clause 4.3.3 for details. The VNFM should support this parameter.\n",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "exclude_default",
- "description": "Indicates to exclude the following complex attributes from the response. See clause 4.3.3 for details. The VNFM shall support this parameter. The following attributes shall be excluded from the VnfPkgInfo structure in the response body if this parameter is provided, or none of the parameters \"all_fields,\" \"fields\", \"exclude_fields\", \"exclude_default\" are provided: -\tsoftwareImages -\tadditionalArtifacts -\tuserDefinedData.\n",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "nextpage_opaque_marker",
- "description": "Marker to obtain the next page of a paged response. Shall be supported by the VNFM if the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.\n",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "Version",
- "description": "Version of the API requested to use when responding to this request.\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "200 OK\nInformation about zero or more VNF packages was queried successfully. The response body shall contain in an array the VNF package info representations that match the attribute filter, i.e. zero or more VNF package representations as defined in clause 10.5.2.2. If the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "Link": {
- "description": "Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "type": "array",
- "items": {
- "description": "This type represents the information of an VNF package.\n",
- "type": "object",
- "required": [
- "id",
- "operationalState",
- "usageState",
- "_links"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfdId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfProvider": {
- "description": "Provider of the VNF package and the VNFD. This information is copied from the VNFD.\n",
- "type": "string"
- },
- "vnfProductName": {
- "description": "Name to identify the VNF product. Invariant for the VNF product lifetime. This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise.\n",
- "type": "string"
- },
- "vnfSoftwareVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfdVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "checksum": {
- "description": "This type represents the checksum of a VNF package or an artifact file.\n",
- "type": "object",
- "required": [
- "algorithm",
- "hash"
- ],
- "properties": {
- "algorithm": {
- "description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.\n",
- "type": "string"
- },
- "hash": {
- "description": "The hexadecimal value of the checksum.\n",
- "type": "string"
- }
- }
- },
- "softwareImages": {
- "description": "Information about VNF package artifacts that are software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector.\n",
- "type": "array",
- "items": {
- "description": "This type represents an artifact contained in a VNF package which represents a software image.\n",
- "type": "object",
- "required": [
- "id",
- "name",
- "provider",
- "version",
- "checksum",
- "containerFormat",
- "diskFormat",
- "createdAt",
- "minDisk",
- "minRam",
- "size",
- "imagePath"
- ],
- "properties": {
- "id": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "name": {
- "description": "Name of the software image.\n",
- "type": "string"
- },
- "provider": {
- "description": "Provider of the software image.\n",
- "type": "string"
- },
- "version": {
- "description": "A Version.\n",
- "type": "string"
- },
- "checksum": {
- "description": "This type represents the checksum of a VNF package or an artifact file.\n",
- "type": "object",
- "required": [
- "algorithm",
- "hash"
- ],
- "properties": {
- "algorithm": {
- "description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.\n",
- "type": "string"
- },
- "hash": {
- "description": "The hexadecimal value of the checksum.\n",
- "type": "string"
- }
- }
- },
- "containerFormat": {
- "description": "Container format indicates whether the software image is in a file format that also contains metadata about the actual software. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - BARE: the image does not have a container or metadata envelope - DOCKER: docker container format - OVA: OVF package in a tarfile - OVF: OVF container format The list of permitted values was taken from \"Container formats\" in http://docs.openstack.org/image-guide/image-formats.html\n",
- "type": "string",
- "enum": [
- "AKI",
- "AMI",
- "ARI",
- "BARE",
- "DOCKER",
- "OVA",
- "OVF"
- ]
- },
- "diskFormat": {
- "description": "Disk format of a software image is the format of the underlying disk image. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - ISO: an archive format for the data contents of an optical disc, such as CD-ROM\n- QCOW2: a common disk image format, which can expand dynamically and supports copy on write\n- RAW: an unstructured disk image format - VDI: a common disk image format - VHD: a common disk image format - VHDX: enhanced version of VHD format - VMDK: a common disk image format The list of permitted values was adapted from \"Disk formats\" in http://docs.openstack.org/image-guide/image-formats.html\n",
- "type": "string",
- "enum": [
- "AKI",
- "AMI",
- "ISO",
- "QCOW2",
- "RAW",
- "VDI",
- "VHD",
- "VHDX",
- "VMDK"
- ]
- },
- "createdAt": {
- "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
- "type": "string",
- "format": "date-time"
- },
- "minDisk": {
- "description": "The minimal disk for this software image in bytes.\n",
- "type": "integer"
- },
- "minRam": {
- "description": "The minimal RAM for this software image in bytes.\n",
- "type": "integer"
- },
- "size": {
- "description": "Size of this software image in bytes.\n",
- "type": "integer"
- },
- "userMetadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "imagePath": {
- "description": "Path in the VNF package, which identifies the image artifact and also allows to access a copy of the image artifact.\n",
- "type": "string"
- }
- }
- }
- },
- "additionalArtifacts": {
- "description": "Information about VNF package artifacts contained in the VNF package that are not software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present if the VNF package contains additional artifacts.\n",
- "type": "array",
- "items": {
- "description": "This type represents an artifact other than a software image which is contained in a VNF package.\n",
- "type": "object",
- "required": [
- "artifactPath",
- "checksum"
- ],
- "properties": {
- "artifactPath": {
- "description": "Path in the VNF package, which identifies the artifact and also allows to access a copy of the artifact.\n",
- "type": "string"
- },
- "checksum": {
- "description": "This type represents the checksum of a VNF package or an artifact file.\n",
- "type": "object",
- "required": [
- "algorithm",
- "hash"
- ],
- "properties": {
- "algorithm": {
- "description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.\n",
- "type": "string"
- },
- "hash": {
- "description": "The hexadecimal value of the checksum.\n",
- "type": "string"
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "onboardingState": {
- "description": "CREATED: The VNF package resource has been created. UPLOADING: The associated VNF package content is being uploaded. PROCESSING: The associated VNF package content is being processed, e.g., validation.\nONBOARDED: The associated VNF package content has been successfully on-boarded.\n",
- "type": "string",
- "enum": [
- "CREATED",
- "UPLOADING",
- "PROCESSING",
- "ONBOARDED"
- ]
- },
- "operationalState": {
- "description": "- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances.\n- DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package\n is re-enabled).\n",
- "type": "string",
- "enum": [
- "ENABLED",
- "DISABLED"
- ]
- },
- "usageState":
- {
- "description": "- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package.\n",
- "type": "string",
- "enum": [
- "IN_USE",
- "NOT_IN_USE"
- ]
- },
- "userDefinedData": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": [
- "self",
- "packageContent"
- ],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource using an absolute URI. It shall comply with the provisions defined in table 4.4.1.3-1.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- }
- }
- },
- "vnfd": {
- "description": "This type represents a link to a resource using an absolute URI. It shall comply with the provisions defined in table 4.4.1.3-1.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- }
- }
- },
- "packageContent": {
- "description": "This type represents a link to a resource using an absolute URI. It shall comply with the provisions defined in table 4.4.1.3-1.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "400 BAD REQUEST\n400 code can be returned in the following specified cases, the specific cause has to be proper specified in the \"ProblemDetails\" structure to be returned.\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\nThe use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "401 UNAUTHORIZED\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "403 FORBIDDEN\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "406 NOT ACCEPTABLE\nIf the \"Accept\" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "416 RANGE NOT SATISFIABLE\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "500 INTERNAL SERVER ERROR\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "503 SERVICE UNAVAILABLE\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/vnf_packages/{vnfPkgId}": {
- "parameters": [
- {
- "name": "vnfPkgId",
- "description": "Identifier of the VNF package. The identifier is allocated by the NFVO. This identifier can be retrieved from the \"vnfPkgId\" attribute in the VnfPackageOnboardingNotification or VnfPackageChangeNotification.\n",
- "in": "path",
- "type": "string",
- "required": true
- }
- ],
- "get": {
- "description": "Query VNF Package Info\n\nThe GET method reads the information of an individual VNF package.\n",
- "parameters": [
- {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- },
- {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- },
- {
- "name": "Version",
- "description": "Version of the API requested to use when responding to this request.\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "200 OK\nInformation of the selected VNF packages.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "This type represents the information of an VNF package.\n",
- "type": "object",
- "required": [
- "id",
- "operationalState",
- "usageState",
- "_links"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfdId": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "vnfProvider": {
- "description": "Provider of the VNF package and the VNFD. This information is copied from the VNFD.\n",
- "type": "string"
- },
- "vnfProductName": {
- "description": "Name to identify the VNF product. Invariant for the VNF product lifetime. This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise.\n",
- "type": "string"
- },
- "vnfSoftwareVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfdVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "checksum": {
- "description": "This type represents the checksum of a VNF package or an artifact file.\n",
- "type": "object",
- "required": [
- "algorithm",
- "hash"
- ],
- "properties": {
- "algorithm": {
- "description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.\n",
- "type": "string"
- },
- "hash": {
- "description": "The hexadecimal value of the checksum.\n",
- "type": "string"
- }
- }
- },
- "softwareImages": {
- "description": "Information about VNF package artifacts that are software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector.\n",
- "type": "array",
- "items": {
- "description": "This type represents an artifact contained in a VNF package which represents a software image.\n",
- "type": "object",
- "required": [
- "id",
- "name",
- "provider",
- "version",
- "checksum",
- "containerFormat",
- "diskFormat",
- "createdAt",
- "minDisk",
- "minRam",
- "size",
- "imagePath"
- ],
- "properties": {
- "id": {
- "description": "An identifier that is unique within a VNF descriptor.\n",
- "type": "string"
- },
- "name": {
- "description": "Name of the software image.\n",
- "type": "string"
- },
- "provider": {
- "description": "Provider of the software image.\n",
- "type": "string"
- },
- "version": {
- "description": "A Version.\n",
- "type": "string"
- },
- "checksum": {
- "description": "This type represents the checksum of a VNF package or an artifact file.\n",
- "type": "object",
- "required": [
- "algorithm",
- "hash"
- ],
- "properties": {
- "algorithm": {
- "description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.\n",
- "type": "string"
- },
- "hash": {
- "description": "The hexadecimal value of the checksum.\n",
- "type": "string"
- }
- }
- },
- "containerFormat": {
- "description": "Container format indicates whether the software image is in a file format that also contains metadata about the actual software. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - BARE: the image does not have a container or metadata envelope - DOCKER: docker container format - OVA: OVF package in a tarfile - OVF: OVF container format The list of permitted values was taken from \"Container formats\" in http://docs.openstack.org/image-guide/image-formats.html\n",
- "type": "string",
- "enum": [
- "AKI",
- "AMI",
- "ARI",
- "BARE",
- "DOCKER",
- "OVA",
- "OVF"
- ]
- },
- "diskFormat": {
- "description": "Disk format of a software image is the format of the underlying disk image. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - ISO: an archive format for the data contents of an optical disc, such as CD-ROM\n- QCOW2: a common disk image format, which can expand dynamically and supports copy on write\n- RAW: an unstructured disk image format - VDI: a common disk image format - VHD: a common disk image format - VHDX: enhanced version of VHD format - VMDK: a common disk image format The list of permitted values was adapted from \"Disk formats\" in http://docs.openstack.org/image-guide/image-formats.html\n",
- "type": "string",
- "enum": [
- "AKI",
- "AMI",
- "ISO",
- "QCOW2",
- "RAW",
- "VDI",
- "VHD",
- "VHDX",
- "VMDK"
- ]
- },
- "createdAt": {
- "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
- "type": "string",
- "format": "date-time"
- },
- "minDisk": {
- "description": "The minimal disk for this software image in bytes.\n",
- "type": "integer"
- },
- "minRam": {
- "description": "The minimal RAM for this software image in bytes.\n",
- "type": "integer"
- },
- "size": {
- "description": "Size of this software image in bytes.\n",
- "type": "integer"
- },
- "userMetadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "imagePath": {
- "description": "Path in the VNF package, which identifies the image artifact and also allows to access a copy of the image artifact.\n",
- "type": "string"
- }
- }
- }
- },
- "additionalArtifacts": {
- "description": "Information about VNF package artifacts contained in the VNF package that are not software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present if the VNF package contains additional artifacts.\n",
- "type": "array",
- "items": {
- "description": "This type represents an artifact other than a software image which is contained in a VNF package.\n",
- "type": "object",
- "required": [
- "artifactPath",
- "checksum"
- ],
- "properties": {
- "artifactPath": {
- "description": "Path in the VNF package, which identifies the artifact and also allows to access a copy of the artifact.\n",
- "type": "string"
- },
- "checksum": {
- "description": "This type represents the checksum of a VNF package or an artifact file.\n",
- "type": "object",
- "required": [
- "algorithm",
- "hash"
- ],
- "properties": {
- "algorithm": {
- "description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.\n",
- "type": "string"
- },
- "hash": {
- "description": "The hexadecimal value of the checksum.\n",
- "type": "string"
- }
- }
- },
- "metadata": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- }
- }
- }
- },
- "onboardingState": {
- "description": "CREATED: The VNF package resource has been created. UPLOADING: The associated VNF package content is being uploaded. PROCESSING: The associated VNF package content is being processed, e.g., validation.\nONBOARDED: The associated VNF package content has been successfully on-boarded.\n",
- "type": "string",
- "enum": [
- "CREATED",
- "UPLOADING",
- "PROCESSING",
- "ONBOARDED"
- ]
- },
- "operationalState": {
- "description": "- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances.\n- DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package\n is re-enabled).\n",
- "type": "string",
- "enum": [
- "ENABLED",
- "DISABLED"
- ]
- },
- "usageState":
- {
- "description": "- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package.\n",
- "type": "string",
- "enum": [
- "IN_USE",
- "NOT_IN_USE"
- ]
- },
- "userDefinedData": {
- "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
- "type": "object"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": [
- "self",
- "packageContent"
- ],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource using an absolute URI. It shall comply with the provisions defined in table 4.4.1.3-1.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- }
- }
- },
- "vnfd": {
- "description": "This type represents a link to a resource using an absolute URI. It shall comply with the provisions defined in table 4.4.1.3-1.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- }
- }
- },
- "packageContent": {
- "description": "This type represents a link to a resource using an absolute URI. It shall comply with the provisions defined in table 4.4.1.3-1.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "400 BAD REQUEST\n400 code can be returned in the following specified cases, the specific cause has to be proper specified in the \"ProblemDetails\" structure to be returned.\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\nThe use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "401 UNAUTHORIZED\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "403 FORBIDDEN\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "406 NOT ACCEPTABLE\nIf the \"Accept\" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "416 RANGE NOT SATISFIABLE\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "500 INTERNAL SERVER ERROR\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "503 SERVICE UNAVAILABLE\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/vnf_packages/{vnfPkgId}/vnfd": {
- "parameters": [
- {
- "name": "vnfPkgId",
- "description": "Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO. This identifier can be retrieved from the \"vnfPkgId\" attribute in the VnfPackageOnboardingNotification or VnfPackageChangeNotification.\n",
- "in": "path",
- "type": "string",
- "required": true
- }
- ],
- "get": {
- "description": "Query VNF Package Info\n\nThe GET method reads the content of the VNFD within a VNF package. The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the form of multiple files, a ZIP file embedding these files shall be returned. If the VNFD is implemented as a single file, either that file or a ZIP file embedding that file shall be returned. The selection of the format is controlled by the \"Accept\" HTTP header passed in the GET request. * If the \"Accept\" header contains only \"text/plain\" and the VNFD is implemented as a single file, the file shall be returned;\n otherwise, an error message shall be returned.\n* If the \"Accept\" header contains only \"application/zip\", the single file or the multiple files that make up the VNFD shall be returned\n embedded in a ZIP file.\n* If the \"Accept\" header contains both \"text/plain\" and \"application/zip\", it is up to the NFVO to choose the format to\n return for a single-file VNFD; for a multi-file VNFD, a ZIP file\n shall be returned.\nThe default format of the ZIP file shall be the one specified in ETSI GS NFV-SOL 004 where only the YAML files representing the VNFD, and information needed to navigate the ZIP file and to identify the file that is the entry point for parsing the VNFD (such as TOSCA-meta or manifest files or naming conventions) are included.\n",
- "parameters": [
- {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Permitted values: \"text/plain\" and/or \"application/zip\" Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string",
- "enum": [
- "text/plain",
- "application/zip",
- "text/plain+application/zip"
- ]
- },
- {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- },
- {
- "name": "Version",
- "description": "Version of the API requested to use when responding to this request.\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "200 OK\nOn success, the content of the VNFD is returned. The payload body shall contain a copy of the file representing the VNFD or a ZIP file that contains the file or multiple files representing the VNFD, as specified above. The \"Content-Type\" HTTP header shall be set according to the format of the returned file, i.e. to \"text/plain\" for a YAML file or to \"application/zip\" for a ZIP file.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "enum": [
- "text/plain",
- "application/zip"
- ],
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- }
- },
- "400": {
- "description": "400 BAD REQUEST\n400 code can be returned in the following specified cases, the specific cause has to be proper specified in the \"ProblemDetails\" structure to be returned.\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\nThe use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "401 UNAUTHORIZED\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "403 FORBIDDEN\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "Not Acceptable\nIf the \"Accept\" header does not contain at least one name of a content type for which the NFVO can provide a representation of the VNFD, the NFVO shall respond with this response code. The \"ProblemDetails\" structure may be included with the \"detail\" attribute providing more information about the error.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "409": {
- "description": "Conflict\nError: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that \"onboardingState\" of the VNF package has a value different from \"ONBOARDED\". The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute shall convey more information about the error.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "416 RANGE NOT SATISFIABLE\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "500 INTERNAL SERVER ERROR\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "503 SERVICE UNAVAILABLE\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/vnf_packages/{vnfPkgId}/package_content": {
- "parameters": [
- {
- "name": "vnfPkgId",
- "description": "Identifier of the VNF package. The identifier is allocated by the NFVO. This identifier can be retrieved from the \"vnfPkgId\" attribute in the VnfPackageOnboardingNotification or VnfPackageChangeNotification.\n",
- "in": "path",
- "type": "string",
- "required": true
- }
- ],
- "get": {
- "description": "Fetch VNF Package\n\nThe GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO.\n",
- "parameters": [
- {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response.\n",
- "in": "header",
- "required": true,
- "type": "string",
- "enum": [
- "text/plain",
- "application/zip"
- ]
- },
- {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- },
- {
- "name": "Range",
- "description": "The request may contain a \"Range\" HTTP header to obtain single range of bytes from the VNF package file. This can be used to continue an aborted transmission. If the NFVO does not support range requests, it should return the whole file with a 200 OK response instead.\n",
- "in": "header",
- "type": "string"
- },
- {
- "name": "Version",
- "description": "Version of the API requested to use when responding to this request.\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "200 OK\nOn success, a copy of the VNF package file is returned. The response body shall include a copy of the VNF package file. The \"Content-Type HTTP\" header shall be set according to the type of the file, i.e. to \"application/zip\" for a VNF Package as defined in ETSI GS NFV-SOL 004.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- }
- },
- "206": {
- "description": "206 PARTIAL CONTENT\nOn success, if the NFVO supports range requests, a single consecutive byte range from the content of the VNF package file is returned. The response body shall contain the requested part of the VNF package file. The \"Content-Range\" HTTP header shall be provided according to IETF RFC 7233. The \"Content-Type\" HTTP header shall be set as defined above for the \"200 OK\" response.\n",
- "headers": {
- "Content-Range": {
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- }
- },
- "400": {
- "description": "400 BAD REQUEST\n400 code can be returned in the following specified cases, the specific cause has to be proper specified in the \"ProblemDetails\" structure to be returned.\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\nThe use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "401 UNAUTHORIZED\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "403 FORBIDDEN\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "406 NOT ACCEPTABLE\nIf the \"Accept\" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "409": {
- "description": "Conflict\nError: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that \"onboardingState\" of the VNF package has a value different from \"ONBOARDED\". The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute shall convey more information about the error.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "Requested Range Not Satisfiable\nThe byte range passed in the \"Range\" header did not match any available byte range in the VNF package file (e.g. \"access after end of file\"). The response body may contain a ProblemDetails structure.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "500 INTERNAL SERVER ERROR\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "503 SERVICE UNAVAILABLE\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}": {
- "parameters": [
- {
- "name": "artifactPath",
- "description": "Sequence of one or more path segments representing the path of the artifact within the VNF package. EXAMPLE: foo/bar/run.sh This identifier can be retrieved from the \"artifactPath\" attribute of the applicable \"additionalArtifacts\" entry in the body of the response to a GET request querying the \"Individual VNF package\" or the \"VNF packages\" resource.\n",
- "in": "path",
- "type": "string",
- "required": true
- },
- {
- "name": "vnfPkgId",
- "description": "Identifier of the VNF package. The identifier is allocated by the NFVO. This identifier can be retrieved from the \"vnfPkgId\" attribute in the VnfPackageOnboardingNotification or VnfPackageChangeNotification.\n",
- "in": "path",
- "type": "string",
- "required": true
- }
- ],
- "get": {
- "description": "Fetch VNF Package Artifacts\n\nThe GET method fetches the content of an artifact within a VNF package.\n",
- "parameters": [
- {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response.\n",
- "in": "header",
- "required": true,
- "type": "string"
- },
- {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- },
- {
- "name": "Range",
- "description": "The request may contain a \"Range\" HTTP header to obtain single range of bytes from the VNF package file. This can be used to continue an aborted transmission. If the NFVO does not support range requests, it should return the whole file with a 200 OK response instead.\n",
- "in": "header",
- "type": "string"
- },
- {
- "name": "Version",
- "description": "Version of the API requested to use when responding to this request.\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "200 OK\nOn success, the content of the artifact is returned. The payload body shall contain a copy of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004. The \"Content-Type\" HTTP header shall be set according to the content type of the artifact file. If the content type cannot be determined, the header shall be set to the value \"application/octet-stream\".\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response. The \"Content-Type\" HTTP header shall be set according to the content type of the artifact file. If the content type cannot be determined, the header shall be set to the value \"application/octet-stream\".\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- }
- },
- "206": {
- "description": "206 PARTIAL CONTENT\nOn success, if the NFVO supports range requests, a single consecutive byte range from the content of the VNF package file is returned. The response body shall contain the requested part of the VNF package file. The \"Content-Range\" HTTP header shall be provided according to IETF RFC 7233. The \"Content-Type\" HTTP header shall be set as defined above for the \"200 OK\" response.\n",
- "headers": {
- "Content-Range": {
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- }
- },
- "400": {
- "description": "400 BAD REQUEST\n400 code can be returned in the following specified cases, the specific cause has to be proper specified in the \"ProblemDetails\" structure to be returned.\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\nThe use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "401 UNAUTHORIZED\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "403 FORBIDDEN\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "406 NOT ACCEPTABLE\nIf the \"Accept\" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "409": {
- "description": "Conflict\nError: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that \"onboardingState\" of the VNF package has a value different from \"ONBOARDED\". The response body shall contain a ProblemDetails structure, in which the \"detail\" attribute shall convey more information about the error.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "Requested Range Not Satisfiable\nThe byte range passed in the \"Range\" header did not match any available byte range in the VNF package file (e.g. \"access after end of file\"). The response body may contain a ProblemDetails structure.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "500 INTERNAL SERVER ERROR\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "503 SERVICE UNAVAILABLE\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/subscriptions": {
- "post": {
- "description": "Subscribe\n\nThe POST method creates a new subscription. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide duplicates of notifications to the VNFM, and might make sense only in very rare use cases. Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the same filter and callbackUri already exists (in which case it shall return the “201 Created” response code), or may decide to not create a duplicate subscription resource (in which case it shall return a “303 See Other” response code referencing the existing subscription resource with the same filter and callbackUri).\n",
- "parameters": [
- {
- "name": "PkgmSubscriptionRequest",
- "description": "Representation of the created subscription resource. The HTTP response shall include a \"Location\" HTTP header that points to the created subscription resource.\n",
- "in": "body",
- "required": true,
- "schema": {
- "description": "This type represents a subscription request related to VNF package management notifications about VNF package on-boarding or changes.\n",
- "type": "object",
- "required": [
- "callbackUri"
- ],
- "properties": {
- "filter": {
- "description": "This type represents a subscription filter related to notifications related to VNF package management. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n",
- "type": "object",
- "properties": {
- "notificationTypes": {
- "description": "Match particular notification types. Permitted values: - VnfPackageOnboardingNotification - VnfPackageChangeNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "VnfPackageOnboardingNotification",
- "VnfPackageChangeNotification"
- ]
- }
- },
- "vnfProductsFromProviders": {
- "description": "If present, match VNF packages that contain VNF products from certain providers. The attributes \"vnfProductsFromProviders\", \"vnfdId\" and \"vnfPkgId\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "vnfProvider"
- ],
- "properties": {
- "vnfProvider": {
- "description": "Name of the VNF provider to match.\n",
- "type": "string"
- },
- "vnfProducts": {
- "description": "If present, match VNF packages that contain VNF products with certain product names, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "vnfProductName"
- ],
- "properties": {
- "vnfProductName": {
- "description": "Name of the VNF product to match.\n",
- "type": "string"
- },
- "versions": {
- "description": "If present, match VNF packages that contain VNF products with certain versions and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "vnfSoftwareVersion"
- ],
- "properties": {
- "vnfSoftwareVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfdVersions": {
- "description": "If present, match VNF packages that contain VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "description": "A Version.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "vnfdId": {
- "description": "Match VNF packages with a VNFD identifier listed in the attribute. The attributes \"vnfProductsFromProviders\", \"vnfdId\" and \"vnfPkgId\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "vnfPkgId": {
- "description": "Match VNF packages with a package identifier listed in the attribute. May be present if the \"notificationTypes\" attribute contains the value \"VnfPackageChangeNotification\", and shall be absent otherwise. The attributes \"vnfProductsFromProviders\", \"vnfdId\" and \"vnfPkgId\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "operationalState":
- {
- "description": "- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances.\n- DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package\n is re-enabled).\n",
- "type": "array",
- "items":
- {
- "type": "string",
- "enum": [
- "ENABLED",
- "DISABLED"
- ]
- }
- },
- "usageState":
- {
- "description": "- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package.\n",
- "type": "array",
- "items":
- {
- "type": "string",
- "enum": [
- "IN_USE",
- "NOT_IN_USE"
- ]
- }
- }
- }
- },
- "callbackUri": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- },
- "authentication": {
- "type": "object",
- "required": [
- "authType"
- ],
- "properties": {
- "authType": {
- "description": "Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification. Permitted values: * BASIC: In every HTTP request to the notification endpoint, use HTTP Basic authentication with the client credentials. \n* OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer token, obtained\n using the client credentials grant type.\n* TLS_CERT: Every HTTP request to the notification endpoint is sent over a mutually authenticated TLS session, i.e. not only the\n server is authenticated, but also the client is authenticated\n during the TLS tunnel setup.\n",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "BASIC",
- "OAUTH2_CLIENT_CREDENTIALS",
- "TLS_CERT"
- ]
- }
- },
- "paramsBasic": {
- "description": "Parameters for authentication/authorization using BASIC. Shall be present if authType is \"BASIC\" and the contained information has not been provisioned out of band. Shall be absent otherwise.\n",
- "type": "object",
- "properties": {
- "userName": {
- "description": "Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n",
- "type": "string"
- },
- "password": {
- "description": "Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n",
- "type": "string"
- }
- }
- },
- "paramsOauth2ClientCredentials": {
- "description": "Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is \"OAUTH2_CLIENT_CREDENTIALS\" and the contained information has not been provisioned out of band. Shall be absent otherwise.\n",
- "type": "object",
- "properties": {
- "clientId": {
- "description": "Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process.\n",
- "type": "string"
- },
- "clientPassword": {
- "description": "Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process.\n",
- "type": "string"
- },
- "tokenEndpoint": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- },
- {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- },
- {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- },
- {
- "name": "Content-Type",
- "description": "The MIME type of the body of the request. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- },
- {
- "name": "Version",
- "description": "Version of the API requested to use when responding to this request.\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "201": {
- "description": "201 CREATED\nRepresentation of the created subscription resource. The HTTP response shall include a \"Location\" HTTP header that points to the created subscription resource.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "Location": {
- "description": "The resource URI of the created VNF instance",
- "type": "string",
- "format": "url"
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "type": "array",
- "items": {
- "description": "This type represents a subscription related to notifications about VNF package management.\n",
- "type": "object",
- "required": [
- "id",
- "callbackUri",
- "_links"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "filter": {
- "description": "This type represents a subscription filter related to notifications related to VNF package management. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n",
- "type": "object",
- "properties": {
- "notificationTypes": {
- "description": "Match particular notification types. Permitted values: - VnfPackageOnboardingNotification - VnfPackageChangeNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "VnfPackageOnboardingNotification",
- "VnfPackageChangeNotification"
- ]
- }
- },
- "vnfProductsFromProviders": {
- "description": "If present, match VNF packages that contain VNF products from certain providers. The attributes \"vnfProductsFromProviders\", \"vnfdId\" and \"vnfPkgId\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "vnfProvider"
- ],
- "properties": {
- "vnfProvider": {
- "description": "Name of the VNF provider to match.\n",
- "type": "string"
- },
- "vnfProducts": {
- "description": "If present, match VNF packages that contain VNF products with certain product names, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "vnfProductName"
- ],
- "properties": {
- "vnfProductName": {
- "description": "Name of the VNF product to match.\n",
- "type": "string"
- },
- "versions": {
- "description": "If present, match VNF packages that contain VNF products with certain versions and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "vnfSoftwareVersion"
- ],
- "properties": {
- "vnfSoftwareVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfdVersions": {
- "description": "If present, match VNF packages that contain VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "description": "A Version.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "vnfdId": {
- "description": "Match VNF packages with a VNFD identifier listed in the attribute. The attributes \"vnfProductsFromProviders\", \"vnfdId\" and \"vnfPkgId\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "vnfPkgId": {
- "description": "Match VNF packages with a package identifier listed in the attribute. May be present if the \"notificationTypes\" attribute contains the value \"VnfPackageChangeNotification\", and shall be absent otherwise. The attributes \"vnfProductsFromProviders\", \"vnfdId\" and \"vnfPkgId\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "operationalState":
- {
- "description": "- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances.\n- DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package\n is re-enabled).\n",
- "type": "array",
- "items":
- {
- "type": "string",
- "enum": [
- "ENABLED",
- "DISABLED"
- ]
- }
- },
- "usageState":
- {
- "description": "- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package.\n",
- "type": "array",
- "items":
- {
- "type": "string",
- "enum": [
- "IN_USE",
- "NOT_IN_USE"
- ]
- }
- } }
- },
- "callbackUri": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": [
- "self"
- ],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource using an absolute URI. It shall comply with the provisions defined in table 4.4.1.3-1.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "303": {
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- }
- },
- "400": {
- "description": "400 BAD REQUEST\n400 code can be returned in the following specified cases, the specific cause has to be proper specified in the \"ProblemDetails\" structure to be returned.\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\nThe use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "401 UNAUTHORIZED\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "403 FORBIDDEN\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "406 NOT ACCEPTABLE\nIf the \"Accept\" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "416 RANGE NOT SATISFIABLE\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "500 INTERNAL SERVER ERROR\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "503 SERVICE UNAVAILABLE\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- },
- "get": {
- "description": "Query Subscription Information\n\nThe GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations.\n",
- "parameters": [
- {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- },
- {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- },
- {
- "name": "filter",
- "description": "Attribute-based filtering expression according to clause 4.3.2. The VNFM shall support receiving this parameter as part of the URI query string. The NFVO may supply this parameter. All attribute names that appear in the PkgmSubscription and in data types referenced from it shall be supported by the VNFM in the filter expression.\n",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "nextpage_opaque_marker",
- "description": "Marker to obtain the next page of a paged response. Shall be supported by the VNFM if the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.\n",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "Version",
- "description": "Version of the API requested to use when responding to this request.\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "200 OK\nThe list of subscriptions was queried successfully. The representations body shall contain in an array the representations of all active subscriptions of the functional block that invokes the method , i.e. zero or more representations of VNF package Management subscriptions as defined in clause 10.5.2.4. If the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "Link": {
- "description": "Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- }
- },
- "schema": {
- "type": "array",
- "items": {
- "description": "This type represents a subscription related to notifications about VNF package management.\n",
- "type": "object",
- "required": [
- "id",
- "callbackUri",
- "_links"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "filter": {
- "description": "This type represents a subscription filter related to notifications related to VNF package management. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n",
- "type": "object",
- "properties": {
- "notificationTypes": {
- "description": "Match particular notification types. Permitted values: - VnfPackageOnboardingNotification - VnfPackageChangeNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "VnfPackageOnboardingNotification",
- "VnfPackageChangeNotification"
- ]
- }
- },
- "vnfProductsFromProviders": {
- "description": "If present, match VNF packages that contain VNF products from certain providers. The attributes \"vnfProductsFromProviders\", \"vnfdId\" and \"vnfPkgId\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "vnfProvider"
- ],
- "properties": {
- "vnfProvider": {
- "description": "Name of the VNF provider to match.\n",
- "type": "string"
- },
- "vnfProducts": {
- "description": "If present, match VNF packages that contain VNF products with certain product names, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "vnfProductName"
- ],
- "properties": {
- "vnfProductName": {
- "description": "Name of the VNF product to match.\n",
- "type": "string"
- },
- "versions": {
- "description": "If present, match VNF packages that contain VNF products with certain versions and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "vnfSoftwareVersion"
- ],
- "properties": {
- "vnfSoftwareVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfdVersions": {
- "description": "If present, match VNF packages that contain VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "description": "A Version.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "vnfdId": {
- "description": "Match VNF packages with a VNFD identifier listed in the attribute. The attributes \"vnfProductsFromProviders\", \"vnfdId\" and \"vnfPkgId\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "vnfPkgId": {
- "description": "Match VNF packages with a package identifier listed in the attribute. May be present if the \"notificationTypes\" attribute contains the value \"VnfPackageChangeNotification\", and shall be absent otherwise. The attributes \"vnfProductsFromProviders\", \"vnfdId\" and \"vnfPkgId\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "operationalState": {
- "description": "- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances.\n- DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package\n is re-enabled).\n",
- "type": "string",
- "enum": [
- "ENABLED",
- "DISABLED"
- ]
- },
- "usageState": {
- "description": "- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package.\n"
- }
- }
- },
- "callbackUri": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": [
- "self"
- ],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource using an absolute URI. It shall comply with the provisions defined in table 4.4.1.3-1.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "400 BAD REQUEST\n400 code can be returned in the following specified cases, the specific cause has to be proper specified in the \"ProblemDetails\" structure to be returned.\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\nThe use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "401 UNAUTHORIZED\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "403 FORBIDDEN\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "406 NOT ACCEPTABLE\nIf the \"Accept\" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "416 RANGE NOT SATISFIABLE\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "500 INTERNAL SERVER ERROR\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "503 SERVICE UNAVAILABLE\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}": {
- "parameters": [
- {
- "name": "subscriptionId",
- "description": "Identifier of this subscription. This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the \"id\" attribute in the payload body of that response.\n",
- "in": "path",
- "type": "string",
- "required": true
- }
- ],
- "get": {
- "description": "Query Subscription Information\n\nThe GET method reads an individual subscription.\n",
- "parameters": [
- {
- "name": "Accept",
- "description": "Content-Types that are acceptable for the response. Reference: IETF RFC 7231\n",
- "in": "header",
- "required": true,
- "type": "string"
- },
- {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- },
- {
- "name": "Version",
- "description": "Version of the API requested to use when responding to this request.\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "200 OK\nRepresentation of the subscription resource.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "This type represents a subscription related to notifications about VNF package management.\n",
- "type": "object",
- "required": [
- "id",
- "callbackUri",
- "_links"
- ],
- "properties": {
- "id": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- },
- "filter": {
- "description": "This type represents a subscription filter related to notifications related to VNF package management. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical \"and\" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical \"or\" between the values of one filter attribute).\n",
- "type": "object",
- "properties": {
- "notificationTypes": {
- "description": "Match particular notification types. Permitted values: - VnfPackageOnboardingNotification - VnfPackageChangeNotification The permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "VnfPackageOnboardingNotification",
- "VnfPackageChangeNotification"
- ]
- }
- },
- "vnfProductsFromProviders": {
- "description": "If present, match VNF packages that contain VNF products from certain providers. The attributes \"vnfProductsFromProviders\", \"vnfdId\" and \"vnfPkgId\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "vnfProvider"
- ],
- "properties": {
- "vnfProvider": {
- "description": "Name of the VNF provider to match.\n",
- "type": "string"
- },
- "vnfProducts": {
- "description": "If present, match VNF packages that contain VNF products with certain product names, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "vnfProductName"
- ],
- "properties": {
- "vnfProductName": {
- "description": "Name of the VNF product to match.\n",
- "type": "string"
- },
- "versions": {
- "description": "If present, match VNF packages that contain VNF products with certain versions and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "vnfSoftwareVersion"
- ],
- "properties": {
- "vnfSoftwareVersion": {
- "description": "A Version.\n",
- "type": "string"
- },
- "vnfdVersions": {
- "description": "If present, match VNF packages that contain VNF products with certain VNFD versions, a certain software version and a certain product name, from one particular provider.\n",
- "type": "array",
- "items": {
- "description": "A Version.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "vnfdId": {
- "description": "Match VNF packages with a VNFD identifier listed in the attribute. The attributes \"vnfProductsFromProviders\", \"vnfdId\" and \"vnfPkgId\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "vnfPkgId": {
- "description": "Match VNF packages with a package identifier listed in the attribute. May be present if the \"notificationTypes\" attribute contains the value \"VnfPackageChangeNotification\", and shall be absent otherwise. The attributes \"vnfProductsFromProviders\", \"vnfdId\" and \"vnfPkgId\" are alternatives to reference to particular VNF packages in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n",
- "type": "array",
- "items": {
- "description": "An identifier with the intention of being globally unique.\n",
- "type": "string"
- }
- },
- "operationalState": {
- "description": "- ENABLED: The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances.\n- DISABLED: The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package\n is re-enabled).\n",
- "type": "string",
- "enum": [
- "ENABLED",
- "DISABLED"
- ]
- },
- "usageState": {
- "description": "- IN_USE: VNF instances instantiated from this VNF package exist. - NOT_IN_USE: No existing VNF instance is instantiated from this VNF package.\n"
- }
- }
- },
- "callbackUri": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- },
- "_links": {
- "description": "Links to resources related to this resource.\n",
- "type": "object",
- "required": [
- "self"
- ],
- "properties": {
- "self": {
- "description": "This type represents a link to a resource using an absolute URI. It shall comply with the provisions defined in table 4.4.1.3-1.\n",
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "String formatted according to IETF RFC 3986.\n",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "400 BAD REQUEST\n400 code can be returned in the following specified cases, the specific cause has to be proper specified in the \"ProblemDetails\" structure to be returned.\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\nThe use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "401 UNAUTHORIZED\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "403 FORBIDDEN\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "406 NOT ACCEPTABLE\nIf the \"Accept\" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "416 RANGE NOT SATISFIABLE\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "500 INTERNAL SERVER ERROR\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "503 SERVICE UNAVAILABLE\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- },
- "delete": {
- "description": "Terminate subscription\n\nThe DELETE method terminates an individual subscription.\n",
- "parameters": [
- {
- "name": "Authorization",
- "description": "The authorization token for the request. Reference: IETF RFC 7235\n",
- "in": "header",
- "required": false,
- "type": "string"
- },
- {
- "name": "Version",
- "description": "Version of the API requested to use when responding to this request.\n",
- "in": "header",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "204": {
- "description": "204 NO CONTENT\nThe subscription resource was deleted successfully.\n",
- "headers": {
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- }
- },
- "400": {
- "description": "400 BAD REQUEST\n400 code can be returned in the following specified cases, the specific cause has to be proper specified in the \"ProblemDetails\" structure to be returned.\nIf the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and should include in the \"detail\" attribute more information about the source of the problem.\nIf there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\nIf the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\nThe use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "401": {
- "description": "401 UNAUTHORIZED\nIf the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "403": {
- "description": "403 FORBIDDEN\nIf the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided. It should include in the \"detail\" attribute information about the source of the problem, and may indicate how to solve it.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "404": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "405": {
- "description": "404 NOT FOUND\nIf the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The \"ProblemDetails\" structure may be provided, including in the \"detail\" attribute information about the source of the problem, e.g. a wrong resource URI variable.\nThis response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "406": {
- "description": "406 NOT ACCEPTABLE\nIf the \"Accept\" header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "416": {
- "description": "416 RANGE NOT SATISFIABLE\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "500": {
- "description": "500 INTERNAL SERVER ERROR\nIf there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\"), the API producer shall respond with this response code. The \"ProblemDetails\" structure shall be provided, and shall include in the \"detail\" attribute more information about the source of the problem.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- },
- "503": {
- "description": "503 SERVICE UNAVAILABLE\nIf the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the \"Retry-After\" HTTP header and for the alternative to refuse the connection. The \"ProblemDetails\" structure may be omitted.\n",
- "headers": {
- "Content-Type": {
- "description": "The MIME type of the body of the response.",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- },
- "WWW-Authenticate": {
- "description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 0
- },
- "Version": {
- "description": "Version of the API used in the response.\n",
- "type": "string",
- "maximum": 1,
- "minimum": 1
- }
- },
- "schema": {
- "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
- "type": "object",
- "required": [
- "status",
- "detail"
- ],
- "properties": {
- "type": {
- "description": "A URI reference according to IETF RFC 3986 [5] 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\".\n",
- "type": "string",
- "format": "URI"
- },
- "title": {
- "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
- "type": "string"
- },
- "status": {
- "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
- "type": "integer"
- },
- "detail": {
- "description": "A human-readable explanation specific to this occurrence of the problem.\n",
- "type": "string"
- },
- "instance": {
- "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
- "type": "string",
- "format": "URI"
- }
- }
- }
- }
- }
- }
- }
- }
-} \ No newline at end of file