{ "openapi" : "3.1.0", "info" : { "contact" : { "email" : "onap-discuss@lists.onap.org", "name" : "ONAP Community", "url" : "https://www.onap.org/" }, "description" : "Shows all resources and endpoints which CDS BP processor currently provides with sample requests/responses, parameter description and other information.", "license" : { "name" : "Apache 2.0", "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" }, "termsOfService" : "https://www.onap.org/", "title" : "CDS Blueprint Processor API Reference", "version" : "1.11.0-SNAPSHOT" }, "servers" : [ { "url" : "", "description" : "Generated server url" } ], "security" : [ { "basicAuth" : [ ] } ], "tags" : [ { "description" : "Interaction with CBA which are available in CDS", "name" : "Execution Service Catalog" }, { "description" : "Manages data types in CDS", "name" : "Model Type Catalog" }, { "description" : "Interaction with stored configurations", "name" : "Resource configuration" }, { "description" : "Interaction with resolved templates", "name" : "Resource Template" }, { "description" : "Interaction with stored dictionaries", "name" : "Resource Dictionary" }, { "description" : "Interaction with resolved resources", "name" : "Resources" }, { "description" : "Manages all blueprint models which are available in CDS", "name" : "Blueprint Model Catalog" } ], "paths" : { "/api/v1/blueprint-model" : { "get" : { "description" : "Lists all meta-data of blueprint models which are saved in CDS.", "operationId" : "BlueprintModelController_allBlueprintModel_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } }, "description" : "OK" }, "500" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } }, "description" : "Internal Server Error" } }, "summary" : "List all Blueprint Models", "tags" : [ "Blueprint Model Catalog" ] }, "post" : { "description" : "Saves a blueprint model by the given CBA zip file input. There is no validation of the attached CBA happening when this API is called.", "operationId" : "BlueprintModelController_saveBlueprint_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "file" : { "type" : "string", "format" : "binary", "description" : "CBA file to be uploaded (example: cba.zip)" } }, "required" : [ "file" ] } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "blueprintModel" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } } }, "description" : "OK" }, "500" : { "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "blueprintModel" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } } }, "description" : "Internal Server Error" } }, "summary" : "Save a Blueprint Model", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/bootstrap" : { "post" : { "description" : "Loads all Model Types, Resource Dictionaries and Blueprint Models which are included in CDS by default. Before starting to work with CDS, bootstrap should be called to load all the basic models that each orginization might support. Parameter values can be set as `false` to skip loading e.g. the Resource Dictionaries but this is not recommended.", "operationId" : "BlueprintModelController_bootstrap_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BootstrapRequest" } } }, "description" : "Specifies which elements to load", "required" : true }, "responses" : { "200" : { "content" : { }, "description" : "OK" }, "500" : { "content" : { }, "description" : "Internal Server Error" } }, "summary" : "Bootstrap CDS", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/by-name/{name}/version/{version}" : { "get" : { "description" : "Get Meta-Data of a Blueprint Model by its name and version.", "operationId" : "BlueprintModelController_getBlueprintByNameAndVersion_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "Name of the blueprint model", "example" : "pnf_netconf", "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the blueprint model", "example" : "1.0.0", "in" : "path", "name" : "version", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "blueprintModel" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } } }, "description" : "OK" }, "404" : { "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "blueprintModel" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } } }, "description" : "Not Found" } }, "summary" : "Get a Blueprint Model by Name and Version", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/download/by-name/{name}/version/{version}" : { "get" : { "description" : "Gets the CBA of a blueprint model by its name and version. Response can be saved to a file to download the CBA.", "operationId" : "BlueprintModelController_downloadBlueprintByNameAndVersion_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "Name of the blueprint model", "example" : "pnf_netconf", "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the blueprint model", "example" : "1.0.0", "in" : "path", "name" : "version", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" }, "404" : { "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "Not Found" } }, "summary" : "Download a Blueprint Model", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/download/{id}" : { "get" : { "description" : "Gets the CBA of a blueprint model by its ID. Response can be saved to a file to download the CBA.", "operationId" : "BlueprintModelController_downloadBluePrint_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "ID of the blueprint model to download", "example" : "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" }, "404" : { "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "Not Found" } }, "summary" : "Download a Blueprint Model by ID", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/enrich" : { "post" : { "description" : "Enriches the attached CBA and returns the enriched CBA zip file in the response. The enrichment process will complete the package by providing all the definition of types used.", "operationId" : "BlueprintModelController_enrichBlueprint_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "file" : { "type" : "string", "format" : "binary", "description" : "CBA zip file to be uploaded (example: cba_unenriched.zip)" } }, "required" : [ "file" ] } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "summary" : "Enrich a Blueprint Model", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/enrichandpublish" : { "post" : { "description" : "Enriches the attached CBA, validates it and saves it in CDS if validation was successful.", "operationId" : "BlueprintModelController_enrichAndPubishlueprint_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "file" : { "type" : "string", "format" : "binary", "description" : "Unenriched CBA zip file to be uploaded (example: cba_unenriched.zip)" } }, "required" : [ "file" ] } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "blueprintModel" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } } }, "description" : "OK" }, "503" : { "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "blueprintModel" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } } }, "description" : "Service Unavailable" } }, "summary" : "Enrich and publish a Blueprint Model", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/meta-data/{keyword}" : { "get" : { "description" : "Lists all blueprint models by a matching keyword in any of the meta-data of the blueprint models. Blueprint models are just returned if a whole keyword is matching, not just parts of it. Not case-sensitive. Used by CDS UI.", "operationId" : "BlueprintModelController_allBlueprintModelMetaData_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "Keyword to search for in blueprint model meta-data", "example" : "pnf_netconf", "in" : "path", "name" : "keyword", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } }, "description" : "OK" } }, "summary" : "Search for Blueprints by a Keyword", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/name/{name}/version/{version}" : { "delete" : { "description" : "Deletes a blueprint model identified by its name and version from CDS.", "operationId" : "BlueprintModelController_deleteBlueprintByName_DELETE.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "Name of the blueprint model", "example" : "pnf_netconf", "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the blueprint model", "example" : "1.0.0", "in" : "path", "name" : "version", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { }, "description" : "OK" } }, "summary" : "Delete a Blueprint Model by Name", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/paged" : { "get" : { "description" : "Lists all blueprint models which are saved in CDS in an ordered mode.", "operationId" : "BlueprintModelController_allBlueprintModelPaged_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "Maximum number of returned blueprint models", "in" : "query", "name" : "limit", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 20 } }, { "description" : "Offset", "in" : "query", "name" : "offset", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Order of returned blueprint models", "in" : "query", "name" : "sort", "required" : false, "schema" : { "type" : "string", "default" : "DATE", "enum" : [ "DATE", "NAME", "VERSION" ] } }, { "description" : "Ascend or descend ordering", "in" : "query", "name" : "sortType", "required" : false, "schema" : { "type" : "string", "default" : "ASC" } }, { "description" : "Filter by published status (true or false)", "in" : "query", "name" : "published", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageBlueprintModelSearch" } } }, "description" : "OK" } }, "summary" : "Get Blueprints ordered", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/paged/meta-data/{keyword}" : { "get" : { "description" : "Lists all blueprint models by a matching keyword in any of the meta-data of the blueprint models in an ordered mode. Blueprint models are just returned if a whole keyword is matching, not just parts of it. Not case-sensitive. Used by CDS UI.", "operationId" : "BlueprintModelController_allBlueprintModelMetaDataPaged_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "Keyword to search for in blueprint model meta-data", "example" : "pnf_netconf", "in" : "path", "name" : "keyword", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Maximum number of returned blueprint models", "in" : "query", "name" : "limit", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 20 } }, { "description" : "Offset", "in" : "query", "name" : "offset", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Order of returned blueprint models", "in" : "query", "name" : "sort", "required" : false, "schema" : { "type" : "string", "default" : "DATE", "enum" : [ "DATE", "NAME", "VERSION" ] } }, { "description" : "Ascend or descend ordering", "in" : "query", "name" : "sortType", "required" : false, "schema" : { "type" : "string", "default" : "ASC" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageBlueprintModelSearch" } } }, "description" : "OK" } }, "summary" : "Search for Blueprints by a Keyword in an ordered mode", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/publish" : { "post" : { "description" : "Validates the attached CBA file and saves it in CDS if validation was successful. CBA needs to be already enriched.", "operationId" : "BlueprintModelController_publishBlueprint_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "file" : { "type" : "string", "format" : "binary", "description" : "Enriched CBA zip file to be uploaded (example: cba_enriched.zip)" } }, "required" : [ "file" ] } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "blueprintModel" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } } }, "description" : "OK" } }, "summary" : "Publish a Blueprint Model", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/search/{tags}" : { "get" : { "description" : "Searches for all blueprint models which contain the specified input parameter in their tags. Blueprint models which contain just parts of the searched word in their tags are also returned.", "operationId" : "BlueprintModelController_searchBlueprintModels_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "Tag to search for", "example" : "test", "in" : "path", "name" : "tags", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } }, "description" : "OK" } }, "summary" : "Search for a Blueprint by Tag", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/workflow-spec" : { "post" : { "description" : "Get the workflow of a blueprint identified by Blueprint and workflow name. Inputs, outputs and data types of workflow is returned.", "operationId" : "BlueprintModelController_workflowSpec_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkFlowSpecRequest" } } }, "description" : "Blueprint and workflow identification", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Get Workflow Specification", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/workflows/blueprint-name/{name}/version/{version}" : { "get" : { "description" : "Get all available workflows of a Blueprint identified by its name and version.", "operationId" : "BlueprintModelController_getWorkflowList_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "Name of the blueprint model", "example" : "pnf_netconf", "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the blueprint model", "example" : "1.0.0", "in" : "path", "name" : "version", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Get Workflows of a Blueprint", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/blueprint-model/{id}" : { "delete" : { "description" : "Delete a blueprint model by its ID. ID is the internally created ID of blueprint, not the name of blueprint.", "operationId" : "BlueprintModelController_deleteBlueprint_DELETE.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "ID of the blueprint model to delete", "example" : "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { }, "description" : "OK" }, "404" : { "content" : { }, "description" : "RESOURCE_NOT_FOUND" } }, "summary" : "Delete a Blueprint Model by ID", "tags" : [ "Blueprint Model Catalog" ] }, "get" : { "description" : "Get meta-data of a blueprint model by its internally created ID.", "operationId" : "BlueprintModelController_getBlueprintModel_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "ID of the blueprint model to search for", "example" : "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "blueprintModel" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } } }, "description" : "OK" }, "404" : { "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "blueprintModel" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } } } } }, "description" : "Not Found" } }, "summary" : "Get a Blueprint Model by ID", "tags" : [ "Blueprint Model Catalog" ] } }, "/api/v1/configs" : { "get" : { "description" : "Retrieve a config snapshot, identified by its Resource Id and Type. An extra 'format' parameter can be passed to tell what content-type is expected.", "operationId" : "ResourceConfigSnapshotController_get_GET.org.onap.ccsdk.cds.blueprintsprocessor.configs.api", "parameters" : [ { "description" : "Resource Type associated of the resource configuration snapshot", "example" : "PNF", "in" : "query", "name" : "resourceType", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Resource Id associated of the resource configuration snapshot", "example" : 1, "in" : "query", "name" : "resourceId", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Status of the snapshot being retrieved", "in" : "query", "name" : "status", "required" : false, "schema" : { "type" : "string", "default" : "RUNNING" } }, { "description" : "Expected format of the snapshot being retrieved", "in" : "query", "name" : "format", "required" : false, "schema" : { "type" : "string", "default" : "text/plain" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "string" } }, "application/xml" : { "schema" : { "type" : "string" } }, "text/plain" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Retrieve a resource configuration snapshot", "tags" : [ "Resource configuration" ] } }, "/api/v1/configs/allByID" : { "get" : { "description" : "Retrieve all config snapshots, identified by its Resource Id, ordered by most recently created/modified date. ", "operationId" : "ResourceConfigSnapshotController_getAllByID_GET.org.onap.ccsdk.cds.blueprintsprocessor.configs.api", "parameters" : [ { "description" : "Resource Id associated of the resource configuration snapshots", "example" : 1, "in" : "query", "name" : "resourceId", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Status of the snapshot being retrieved", "in" : "query", "name" : "status", "required" : false, "schema" : { "type" : "string", "default" : "ANY" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceConfigSnapshot" } } } }, "description" : "OK" } }, "summary" : "Retrieve all resource configuration snapshots identified by a given resource_id", "tags" : [ "Resource configuration" ] } }, "/api/v1/configs/allByType" : { "get" : { "description" : "Retrieve all config snapshots matching a specified Resource Type, ordered by most recently created/modified date. ", "operationId" : "ResourceConfigSnapshotController_getAllByType_GET.org.onap.ccsdk.cds.blueprintsprocessor.configs.api", "parameters" : [ { "description" : "Resource Type associated of the resource configuration snapshot", "example" : "PNF", "in" : "query", "name" : "resourceType", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Status of the snapshot being retrieved", "in" : "query", "name" : "status", "required" : false, "schema" : { "type" : "string", "default" : "ANY" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceConfigSnapshot" } } } }, "description" : "OK" } }, "summary" : "Retrieve all resource configuration snapshots for a given resource type", "tags" : [ "Resource configuration" ] } }, "/api/v1/configs/{resourceType}/{resourceId}" : { "delete" : { "description" : "Delete a resource configuration snapshot, identified by its resourceId and resourceType, and optionally its status, either RUNNING or CANDIDATE.", "operationId" : "ResourceConfigSnapshotController_deleteWithResourceIdAndResourceType_DELETE.org.onap.ccsdk.cds.blueprintsprocessor.configs.api_1", "parameters" : [ { "description" : "Resource Type associated with the resolution.", "in" : "path", "name" : "resourceType", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Resource Id associated with the resolution.", "in" : "path", "name" : "resourceId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { }, "description" : "OK" } }, "summary" : "Delete a resource configuration snapshot identified by resourceId, resourceType, status.", "tags" : [ "Resource configuration" ] } }, "/api/v1/configs/{resourceType}/{resourceId}/{status}" : { "delete" : { "description" : "Delete a resource configuration snapshot, identified by its resourceId and resourceType, and optionally its status, either RUNNING or CANDIDATE.", "operationId" : "ResourceConfigSnapshotController_deleteWithResourceIdAndResourceType_DELETE.org.onap.ccsdk.cds.blueprintsprocessor.configs.api", "parameters" : [ { "description" : "Resource Type associated with the resolution.", "in" : "path", "name" : "resourceType", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Resource Id associated with the resolution.", "in" : "path", "name" : "resourceId", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Status of the snapshot being deleted.", "in" : "path", "name" : "status", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { }, "description" : "OK" } }, "summary" : "Delete a resource configuration snapshot identified by resourceId, resourceType, status.", "tags" : [ "Resource configuration" ] }, "post" : { "description" : "Store a resource configuration snapshot, identified by its resourceId and resourceType, and optionally its status, either RUNNING or CANDIDATE.", "operationId" : "ResourceConfigSnapshotController_postWithResourceIdAndResourceType_POST.org.onap.ccsdk.cds.blueprintsprocessor.configs.api", "parameters" : [ { "description" : "Resource Type associated with the resolution", "example" : "PNF", "in" : "path", "name" : "resourceType", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Resource Id associated with the resolution", "example" : 1, "in" : "path", "name" : "resourceId", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Status of the snapshot being retrieved", "in" : "path", "name" : "status", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "string", "example" : "config_snapshot" } } }, "description" : "Config snapshot to store", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourceConfigSnapshot" } } }, "description" : "OK" } }, "summary" : "Store a resource configuration snapshot identified by resourceId, resourceType, status", "tags" : [ "Resource configuration" ] } }, "/api/v1/dictionary" : { "post" : { "description" : "Save a resource dictionary by dictionary provided.", "operationId" : "ResourceDictionaryController_saveResourceDictionary_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourceDictionary" } } }, "description" : "Resource dictionary to store", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourceDictionary" } } }, "description" : "OK" } }, "summary" : "Save a resource dictionary", "tags" : [ "Resource Dictionary" ] } }, "/api/v1/dictionary/by-names" : { "post" : { "description" : "Search for a resource dictionary by names provided.", "operationId" : "ResourceDictionaryController_searchResourceDictionaryByNames_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } }, "description" : "List of names", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceDictionary" } } } }, "description" : "OK" } }, "summary" : "Search for a resource dictionary", "tags" : [ "Resource Dictionary" ] } }, "/api/v1/dictionary/definition" : { "post" : { "description" : "Save a resource dictionary by provided resource definition json.", "operationId" : "ResourceDictionaryController_saveResourceDictionary_1_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourceDefinition" } } }, "description" : "Resource definition to generate Resource Dictionary", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourceDictionary" } } }, "description" : "OK" } }, "summary" : "Save a resource dictionary", "tags" : [ "Resource Dictionary" ] } }, "/api/v1/dictionary/definition-bulk" : { "post" : { "description" : "Save multiple resource dictionaries by provided resource definition json array.", "operationId" : "ResourceDictionaryController_saveAllResourceDictionary_1_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceDefinition" } } } }, "description" : "Resource definition json array to generate Resource Dictionaries", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceDictionary" } } } }, "description" : "OK" } }, "summary" : "Save multiple resource dictionaries", "tags" : [ "Resource Dictionary" ] } }, "/api/v1/dictionary/paged" : { "get" : { "description" : "Lists all blueprint Dictionary which are saved in CDS in an ordered mode.", "operationId" : "BlueprintModelController_allBlueprintDictionaryPaged_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "Maximum number of returned blueprint dictionary", "in" : "query", "name" : "limit", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 20 } }, { "description" : "Offset", "in" : "query", "name" : "offset", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Order of returned blueprint dictionary", "in" : "query", "name" : "sort", "required" : false, "schema" : { "type" : "string", "default" : "DATE", "enum" : [ "DATE" ] } }, { "description" : "Ascend or descend ordering", "in" : "query", "name" : "sortType", "required" : false, "schema" : { "type" : "string", "default" : "ASC" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResourceDictionary" } } }, "description" : "OK" } }, "summary" : "Get Blueprints Dictionary ordered", "tags" : [ "Resource Dictionary" ] } }, "/api/v1/dictionary/resource_dictionary_group" : { "get" : { "description" : "Retrieve all resource dictionary groups.", "operationId" : "ResourceDictionaryController_getResourceDictionaryDistinct_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } }, "description" : "OK" } }, "summary" : "Retrieve all resource dictionary groups", "tags" : [ "Resource Dictionary" ] } }, "/api/v1/dictionary/search/{tags}" : { "get" : { "description" : "Search for a resource dictionary by tags provided.", "operationId" : "ResourceDictionaryController_searchResourceDictionaryByTags_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "Tags list", "example" : "status", "in" : "path", "name" : "tags", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceDictionary" } } } }, "description" : "OK" } }, "summary" : "Search for a resource dictionary", "tags" : [ "Resource Dictionary" ] } }, "/api/v1/dictionary/source-mapping" : { "get" : { "description" : "Search for a source mapping.", "operationId" : "ResourceDictionaryController_getResourceSourceMapping_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourceSourceMapping" } } }, "description" : "OK" } }, "summary" : "Search for a source mapping", "tags" : [ "Resource Dictionary" ] } }, "/api/v1/dictionary/{name}" : { "delete" : { "description" : "Remove a resource dictionary by name provided.", "operationId" : "ResourceDictionaryController_deleteResourceDictionaryByName_DELETE.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "Name of the resource", "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { }, "description" : "OK" } }, "summary" : "Remove a resource dictionary", "tags" : [ "Resource Dictionary" ] }, "get" : { "description" : "Retrieve a resource dictionary by name provided.", "operationId" : "ResourceDictionaryController_getResourceDictionaryByName_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "description" : "Name of the resource", "example" : "hostname", "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResourceDictionary" } } }, "description" : "OK" } }, "summary" : "Retrieve a resource dictionary", "tags" : [ "Resource Dictionary" ] } }, "/api/v1/execution-service/process" : { "post" : { "description" : "Execute the appropriate CBA's action based on the ExecutionServiceInput object passed as input.", "operationId" : "ExecutionServiceController_process_POST.org.onap.ccsdk.cds.blueprintsprocessor.selfservice.api", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExecutionServiceInput" } } }, "description" : "ExecutionServiceInput payload.", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExecutionServiceOutput" } } }, "description" : "OK" } }, "summary" : "Execute a CBA workflow (action)", "tags" : [ "Execution Service Catalog" ] } }, "/api/v1/model-type" : { "post" : { "description" : "Save a model type by model type definition provided.", "operationId" : "ModelTypeController_saveModelType_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ModelType" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ModelType" } } }, "description" : "OK" } }, "summary" : "Save a model type", "tags" : [ "Model Type Catalog" ] } }, "/api/v1/model-type/by-definition/{definitionType}" : { "get" : { "description" : "Retrieve a list of model types by definition type provided.", "operationId" : "ModelTypeController_getModelTypeByDefinitionType_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "in" : "path", "name" : "definitionType", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ModelType" } } } }, "description" : "OK" } }, "summary" : "Retrieve a list of model types", "tags" : [ "Model Type Catalog" ] } }, "/api/v1/model-type/search/{tags}" : { "get" : { "description" : "Retrieve a list of model types by tags provided.", "operationId" : "ModelTypeController_searchModelTypes_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "in" : "path", "name" : "tags", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ModelType" } } } }, "description" : "OK" } }, "summary" : "Retrieve a list of model types", "tags" : [ "Model Type Catalog" ] } }, "/api/v1/model-type/{name}" : { "delete" : { "description" : "Remove a model type by name provided.", "operationId" : "ModelTypeController_deleteModelTypeByName_DELETE.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { }, "description" : "OK" } }, "summary" : "Remove a model type", "tags" : [ "Model Type Catalog" ] }, "get" : { "description" : "Retrieve a model type by name provided.", "operationId" : "ModelTypeController_getModelTypeByName_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", "parameters" : [ { "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ModelType" } } }, "description" : "OK" } }, "summary" : "Retrieve a model type", "tags" : [ "Model Type Catalog" ] } }, "/api/v1/resources" : { "delete" : { "description" : "Delete all the resources associated to a resolution-key using blueprint metadata, artifact name and the resolution-key.", "operationId" : "ResourceController_deleteResolutions_DELETE.org.onap.ccsdk.cds.blueprintsprocessor.resource.api", "parameters" : [ { "description" : "Name of the CBA", "in" : "query", "name" : "bpName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the CBA", "in" : "query", "name" : "bpVersion", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Artifact name for which to retrieve a resolved resource", "in" : "query", "name" : "artifactName", "required" : true, "schema" : { "type" : "string", "default" : "" } }, { "description" : "Resolution Key associated with the resolution", "in" : "query", "name" : "resolutionKey", "required" : false, "schema" : { "type" : "string" } }, { "description" : "resourceType associated with the resolution, must be used with resourceId", "in" : "query", "name" : "resourceType", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Resolution Key associated with the resolution, must be used with resourceType", "in" : "query", "name" : "resourceId", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Only delete last N occurrences", "in" : "query", "name" : "lastN", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeleteResponse" } } }, "description" : "OK" } }, "summary" : "Delete resources using resolution key", "tags" : [ "Resources" ] }, "get" : { "description" : "Retrieve all stored resolved resources using the blueprint name, blueprint version, artifact name and the resolution-key.", "operationId" : "ResourceController_getAllFromResolutionKeyOrFromResourceTypeAndId_GET.org.onap.ccsdk.cds.blueprintsprocessor.resource.api", "parameters" : [ { "description" : "Name of the CBA", "in" : "query", "name" : "bpName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the CBA", "in" : "query", "name" : "bpVersion", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Artifact name for which to retrieve a resolved resource", "in" : "query", "name" : "artifactName", "required" : true, "schema" : { "type" : "string", "default" : "" } }, { "description" : "Resolution Key associated with the resolution", "in" : "query", "name" : "resolutionKey", "required" : false, "schema" : { "type" : "string", "default" : "" } }, { "description" : "Resource Type associated with the resolution", "in" : "query", "name" : "resourceType", "required" : false, "schema" : { "type" : "string", "default" : "" } }, { "description" : "Resource Id associated with the resolution", "in" : "query", "name" : "resourceId", "required" : false, "schema" : { "type" : "string", "default" : "" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceResolution" } } } }, "description" : "OK" } }, "summary" : "Get all resolved resources using the resolution key", "tags" : [ "Resources" ] } }, "/api/v1/resources/occurrences" : { "get" : { "description" : "With optional 'occurrence' options, subset of stored resolved resources can be retrieved using the blueprint name, blueprint version, artifact name and the resolution-key.", "operationId" : "ResourceController_getOccurrences_GET.org.onap.ccsdk.cds.blueprintsprocessor.resource.api", "parameters" : [ { "description" : "Name of the CBA.", "in" : "query", "name" : "bpName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the CBA.", "in" : "query", "name" : "bpVersion", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Artifact name for which to retrieve a resolved resource.", "in" : "query", "name" : "artifactName", "required" : true, "schema" : { "type" : "string", "default" : "" } }, { "description" : "Resolution Key associated with the resolution.", "in" : "query", "name" : "resolutionKey", "required" : true, "schema" : { "type" : "string", "default" : "" } }, { "description" : "Number of earlier N occurrences of the resolutions.", "in" : "query", "name" : "firstN", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Number of latest N occurrences of the resolutions.", "in" : "query", "name" : "lastN", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "For Range option - 'begin' is the start occurrence of range of the resolutions.", "in" : "query", "name" : "begin", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "For Range option - 'end' is the end occurrence of the range of the resolutions.", "in" : "query", "name" : "end", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceResolution" } } } } }, "description" : "OK" } }, "summary" : "Get the map of resolved resources with 'occurrence' as the keys to the resolved resources", "tags" : [ "Resources" ] } }, "/api/v1/resources/resource" : { "get" : { "description" : "Retrieve a stored resource value using the blueprint metadata, artifact name, resolution-key along with the name of the resource value to retrieve.", "operationId" : "ResourceController_getOneFromResolutionKey_GET.org.onap.ccsdk.cds.blueprintsprocessor.resource.api", "parameters" : [ { "description" : "Name of the CBA", "in" : "query", "name" : "bpName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the CBA", "in" : "query", "name" : "bpVersion", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Artifact name for which to retrieve a resolved resource", "in" : "query", "name" : "artifactName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Resolution Key associated with the resolution", "in" : "query", "name" : "resolutionKey", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Name of the resource to retrieve", "in" : "query", "name" : "name", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "OK" } }, "summary" : "Fetch a resource value using resolution key", "tags" : [ "Resources" ] } }, "/api/v1/template" : { "delete" : { "operationId" : "TemplateController_deleteTemplates_DELETE.org.onap.ccsdk.cds.blueprintsprocessor.resource.api", "parameters" : [ { "description" : "Name of the CBA", "in" : "query", "name" : "bpName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the CBA", "in" : "query", "name" : "bpVersion", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Artifact name", "in" : "query", "name" : "artifactName", "required" : true, "schema" : { "type" : "string", "default" : "" } }, { "description" : "Resolution Key associated with the template", "in" : "query", "name" : "resolutionKey", "required" : false, "schema" : { "type" : "string" } }, { "description" : "resourceType associated with the template, must be used with resourceId", "in" : "query", "name" : "resourceType", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Resolution Key associated with the template, must be used with resourceType", "in" : "query", "name" : "resourceId", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Only delete last N occurrences", "in" : "query", "name" : "lastN", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeleteResponse" } } }, "description" : "OK" } }, "tags" : [ "Resource Template" ] }, "get" : { "description" : "Retrieve a config template for a given CBA's action, identified by its blueprint name, blueprint version, artifact name and resolution key. An extra 'format' parameter can be passed to tell what content-type to expect in return", "operationId" : "TemplateController_get_GET.org.onap.ccsdk.cds.blueprintsprocessor.resource.api", "parameters" : [ { "description" : "Name of the CBA", "in" : "query", "name" : "bpName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the CBA", "in" : "query", "name" : "bpVersion", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Artifact name for which to retrieve a resolved resource", "in" : "query", "name" : "artifactName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Resolution Key associated with the resolution", "in" : "query", "name" : "resolutionKey", "required" : false, "schema" : { "type" : "string", "default" : "" } }, { "description" : "Resource Type associated with the resolution", "in" : "query", "name" : "resourceType", "required" : false, "schema" : { "type" : "string", "default" : "" } }, { "description" : "Resource Id associated with the resolution", "in" : "query", "name" : "resourceId", "required" : false, "schema" : { "type" : "string", "default" : "" } }, { "description" : "Expected format of the template being retrieved", "in" : "query", "name" : "format", "required" : true, "schema" : { "type" : "string", "default" : "text/plain" } }, { "description" : "Occurrence of the template resolution (1-n)", "in" : "query", "name" : "occurrence", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "string" } }, "application/xml" : { "schema" : { "type" : "string" } }, "text/plain" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Retrieve a resolved template", "tags" : [ "Resource Template" ] } }, "/api/v1/template/occurrences" : { "get" : { "description" : "With optional 'occurrence' options, subset of stored resolved templates can be retrieved using the blueprint name, blueprint version, artifact name and the resolution-key.", "operationId" : "TemplateController_getOccurrences_GET.org.onap.ccsdk.cds.blueprintsprocessor.resource.api", "parameters" : [ { "description" : "Name of the CBA.", "in" : "query", "name" : "bpName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the CBA.", "in" : "query", "name" : "bpVersion", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Artifact name for which to retrieve a resolved resource.", "in" : "query", "name" : "artifactName", "required" : true, "schema" : { "type" : "string", "default" : "" } }, { "description" : "Resolution Key associated with the resolution.", "in" : "query", "name" : "resolutionKey", "required" : true, "schema" : { "type" : "string", "default" : "" } }, { "description" : "Number of earlier N occurrences of the templates.", "in" : "query", "name" : "firstN", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Number of latest N occurrences of the templates.", "in" : "query", "name" : "lastN", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "For Range option - 'begin' is the start occurrence of range of the templates.", "in" : "query", "name" : "begin", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "For Range option - 'end' is the end occurrence of the range of the templates.", "in" : "query", "name" : "end", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TemplateResolution" } } } } }, "description" : "OK" } }, "summary" : "Get the map of resolved templates with 'occurrence' as the keys to the resolved templates", "tags" : [ "Resource Template" ] } }, "/api/v1/template/{bpName}/{bpVersion}/{artifactName}/{resolutionKey}" : { "post" : { "description" : "Store a template for a given CBA's action, identified by its blueprint name, blueprint version, artifact name and resolution key.", "operationId" : "TemplateController_postWithResolutionKey_POST.org.onap.ccsdk.cds.blueprintsprocessor.resource.api", "parameters" : [ { "description" : "Name of the CBA", "in" : "path", "name" : "bpName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the CBA", "in" : "path", "name" : "bpVersion", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Artifact name for which to retrieve a resolved resource", "in" : "path", "name" : "artifactName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Resolution Key associated with the resolution", "in" : "path", "name" : "resolutionKey", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "string" } } }, "description" : "Template to store", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TemplateResolution" } } }, "description" : "OK" } }, "summary" : "Store a resolved template w/ resolution-key", "tags" : [ "Resource Template" ] } }, "/api/v1/template/{bpName}/{bpVersion}/{artifactName}/{resourceType}/{resourceId}" : { "post" : { "description" : "Store a template for a given CBA's action, identified by its blueprint name, blueprint version, artifact name, resourceId and resourceType.", "operationId" : "TemplateController_postWithResourceIdAndResourceType_POST.org.onap.ccsdk.cds.blueprintsprocessor.resource.api", "parameters" : [ { "description" : "Name of the CBA", "in" : "path", "name" : "bpName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Version of the CBA", "in" : "path", "name" : "bpVersion", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Artifact name for which to retrieve a resolved resource", "in" : "path", "name" : "artifactName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Resource Type associated with the resolution", "in" : "path", "name" : "resourceType", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Resource Id associated with the resolution", "in" : "path", "name" : "resourceId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "string" } } }, "description" : "Template to store", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TemplateResolution" } } }, "description" : "OK" } }, "summary" : "Store a resolved template w/ resourceId and resourceType", "tags" : [ "Resource Template" ] } } }, "components" : { "schemas" : { "ActionIdentifiers" : { "type" : "object", "properties" : { "actionName" : { "type" : "string", "description" : "Name of the workflow to execute." }, "blueprintName" : { "type" : "string", "description" : "Name of the CBA." }, "blueprintVersion" : { "type" : "string", "description" : "Version of the CBA." }, "mode" : { "type" : "string", "description" : "Async processing is only supported for gRPC client.", "enum" : [ "sync", "async" ] } }, "required" : [ "actionName", "mode" ] }, "ArtifactDefinition" : { "type" : "object", "properties" : { "deploy_Path" : { "type" : "string" }, "description" : { "type" : "string" }, "file" : { "type" : "string" }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/JsonNode" } }, "repository" : { "type" : "string" }, "type" : { "type" : "string" } }, "required" : [ "file", "type" ] }, "BlueprintModelSearch" : { "type" : "object", "properties" : { "artifactDescription" : { "type" : "string", "description" : "Artifact Description, usually empty" }, "artifactName" : { "type" : "string", "description" : "Artifact Name, defined in Metadata", "example" : "pnf_netconf" }, "artifactType" : { "type" : "string", "description" : "Artifact Type, usually null", "example" : "SDNC_MODEL" }, "artifactUUId" : { "type" : "string", "description" : "Artifact UUID, usually null" }, "artifactVersion" : { "type" : "string", "description" : "Artifact Version, usually 1.0.0", "example" : "1.0.0" }, "createdDate" : { "type" : "string", "format" : "date-time", "description" : "Datetime of the creation of CBA in CDS", "example" : "2020-11-19T10:34:56.000Z" }, "id" : { "type" : "string", "description" : "ID of Blueprint model, is automatically created by CDS", "example" : "658f9a48-7f54-41ba-ae18-c69f26f3dc94" }, "internalVersion" : { "type" : "integer", "format" : "int32", "description" : "Internal Version of CBA, usually null" }, "published" : { "type" : "string", "description" : "Artifact Name, defined in Metadata", "example" : "pnf_netconf" }, "tags" : { "type" : "string", "description" : "Tags to identify the CBA, defined in Metadata", "example" : "test" }, "updatedBy" : { "type" : "string", "description" : "Name of publisher, defined in Metadata", "example" : "Deutsche Telekom AG" } }, "required" : [ "artifactName", "artifactVersion", "createdDate", "id", "published", "tags", "updatedBy" ] }, "BootstrapRequest" : { "type" : "object", "properties" : { "loadCBA" : { "type" : "boolean", "description" : "Specifies if default blueprint models should be loaded", "example" : true }, "loadModelType" : { "type" : "boolean", "description" : "Specifies if default model types should be loaded", "example" : true }, "loadResourceDictionary" : { "type" : "boolean", "description" : "Specifies if default data dictionaries should be loaded", "example" : true } }, "required" : [ "loadCBA", "loadModelType", "loadResourceDictionary" ] }, "CapabilityAssignment" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/JsonNode" } }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/JsonNode" } } } }, "CommonHeader" : { "type" : "object", "properties" : { "originatorId" : { "type" : "string", "description" : "Identify the system/person triggering the request." }, "requestId" : { "type" : "string", "description" : "Uniquely identify a request." }, "subRequestId" : { "type" : "string", "description" : "Allow for fine-grain request identifier" }, "timestamp" : { "type" : "string", "format" : "date-time", "description" : "Date of the execution", "example" : "2012-04-23T18:25:43.511Z" } }, "required" : [ "originatorId", "requestId", "subRequestId", "timestamp" ] }, "ConstraintClause" : { "type" : "object", "properties" : { "equal" : { "$ref" : "#/components/schemas/JsonNode" }, "greater_or_equal" : { "$ref" : "#/components/schemas/JsonNode" }, "greater_than" : { "$ref" : "#/components/schemas/JsonNode" }, "in_range" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JsonNode" } }, "length" : { "$ref" : "#/components/schemas/JsonNode" }, "less_or_equal" : { "$ref" : "#/components/schemas/JsonNode" }, "less_than" : { "$ref" : "#/components/schemas/JsonNode" }, "max_length" : { "$ref" : "#/components/schemas/JsonNode" }, "min_length" : { "$ref" : "#/components/schemas/JsonNode" }, "pattern" : { "type" : "string" }, "schema" : { "type" : "string" }, "valid_values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JsonNode" } } } }, "DeleteResponse" : { "type" : "object", "properties" : { "deletedEntries" : { "type" : "integer", "format" : "int32" } }, "required" : [ "deletedEntries" ] }, "EntrySchema" : { "type" : "object", "properties" : { "constraints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConstraintClause" } }, "type" : { "type" : "string" } }, "required" : [ "type" ] }, "ExecutionServiceInput" : { "type" : "object", "properties" : { "actionIdentifiers" : { "$ref" : "#/components/schemas/ActionIdentifiers", "description" : "Provide information about the action to execute." }, "commonHeader" : { "$ref" : "#/components/schemas/CommonHeader", "description" : "Headers providing request context." }, "payload" : { "type" : "object", "description" : "Contain the information to be passed as input to the action.The payload is constituted of two section: the workflow input which is the higher level block (xxx-request) and the input for resource resolution located within the xxx-request block, contained within xxx-properties" } }, "required" : [ "actionIdentifiers", "commonHeader", "payload" ] }, "ExecutionServiceOutput" : { "type" : "object", "properties" : { "actionIdentifiers" : { "$ref" : "#/components/schemas/ActionIdentifiers", "description" : "Provide information about the action to execute." }, "commonHeader" : { "$ref" : "#/components/schemas/CommonHeader", "description" : "Headers providing request context." }, "payload" : { "type" : "object", "description" : "Contain the information to be passed as input to the action.The payload is constituted of two section: the workflow input which is the higher level block (xxx-request) and the input for resource resolution located within the xxx-request block, contained within xxx-properties" }, "status" : { "$ref" : "#/components/schemas/Status", "description" : "Status of the request." } }, "required" : [ "actionIdentifiers", "commonHeader", "payload", "status" ] }, "Implementation" : { "type" : "object", "properties" : { "dependencies" : { "type" : "array", "items" : { "type" : "string" } }, "lock" : { "$ref" : "#/components/schemas/LockAssignment" }, "operation_host" : { "type" : "string" }, "primary" : { "type" : "string" }, "timeout" : { "type" : "integer", "format" : "int32" } }, "required" : [ "operation_host", "timeout" ] }, "InterfaceAssignment" : { "type" : "object", "properties" : { "inputs" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/JsonNode" } }, "operations" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/OperationAssignment" } } } }, "JsonNode" : { }, "LockAssignment" : { "type" : "object", "properties" : { "acquireTimeout" : { "$ref" : "#/components/schemas/JsonNode" }, "key" : { "$ref" : "#/components/schemas/JsonNode" } }, "required" : [ "acquireTimeout", "key" ] }, "ModelType" : { "type" : "object", "properties" : { "creationDate" : { "type" : "string", "format" : "date-time" }, "definition" : { "$ref" : "#/components/schemas/JsonNode" }, "definitionType" : { "type" : "string" }, "derivedFrom" : { "type" : "string" }, "description" : { "type" : "string" }, "modelName" : { "type" : "string" }, "tags" : { "type" : "string" }, "updatedBy" : { "type" : "string" }, "version" : { "type" : "string" } }, "required" : [ "definition", "definitionType", "derivedFrom", "description", "modelName", "tags", "updatedBy", "version" ] }, "NodeFilterDefinition" : { "type" : "object", "properties" : { "capabilities" : { "type" : "array", "items" : { "type" : "string" } }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/PropertyDefinition" } } } }, "NodeTemplate" : { "type" : "object", "properties" : { "artifacts" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ArtifactDefinition" } }, "attributes" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/JsonNode" } }, "capabilities" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CapabilityAssignment" } }, "copy" : { "type" : "string" }, "description" : { "type" : "string" }, "directives" : { "type" : "array", "items" : { "type" : "string" } }, "interfaces" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/InterfaceAssignment" } }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "node_filter" : { "$ref" : "#/components/schemas/NodeFilterDefinition" }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/JsonNode" } }, "requirements" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/RequirementAssignment" } }, "type" : { "type" : "string" } }, "required" : [ "type" ] }, "OperationAssignment" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "implementation" : { "$ref" : "#/components/schemas/Implementation" }, "inputs" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/JsonNode" } }, "outputs" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/JsonNode" } } } }, "PageBlueprintModelSearch" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BlueprintModelSearch" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "$ref" : "#/components/schemas/SortObject" }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageResourceDictionary" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceDictionary" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "$ref" : "#/components/schemas/SortObject" }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageableObject" : { "type" : "object", "properties" : { "offset" : { "type" : "integer", "format" : "int64" }, "pageNumber" : { "type" : "integer", "format" : "int32" }, "pageSize" : { "type" : "integer", "format" : "int32" }, "paged" : { "type" : "boolean" }, "sort" : { "$ref" : "#/components/schemas/SortObject" }, "unpaged" : { "type" : "boolean" } } }, "PropertyDefinition" : { "type" : "object", "properties" : { "constraints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConstraintClause" } }, "default" : { "$ref" : "#/components/schemas/JsonNode" }, "description" : { "type" : "string" }, "entry_schema" : { "$ref" : "#/components/schemas/EntrySchema" }, "external-schema" : { "type" : "string" }, "input-param" : { "type" : "boolean" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "required" : { "type" : "boolean" }, "status" : { "type" : "string" }, "type" : { "type" : "string" }, "value" : { "$ref" : "#/components/schemas/JsonNode", "description" : "Property Value, It may be Expression or Json type values" } }, "required" : [ "type" ] }, "RequirementAssignment" : { "type" : "object", "properties" : { "capability" : { "type" : "string" }, "node" : { "type" : "string" }, "relationship" : { "type" : "string" } } }, "ResourceConfigSnapshot" : { "type" : "object", "properties" : { "config_snapshot" : { "type" : "string", "description" : "Snapshot of the resource as retrieved from resource.", "example" : "config_snapshot" }, "createdDate" : { "type" : "string", "format" : "date-time", "description" : "Creation date of the snapshot." }, "id" : { "type" : "string" }, "resourceId" : { "type" : "string", "description" : "ID associated with the resource type in the inventory system.", "example" : 1 }, "resourceType" : { "type" : "string", "description" : "Resource type.", "example" : "ServiceInstance" }, "status" : { "type" : "string", "description" : "Status of the snapshot, either running or candidate.", "enum" : [ "RUNNING", "CANDIDATE" ] } }, "required" : [ "config_snapshot", "createdDate", "resourceId", "resourceType", "status" ] }, "ResourceDefinition" : { "type" : "object", "properties" : { "group" : { "type" : "string", "description" : "Group", "example" : "default" }, "name" : { "type" : "string", "description" : "Name", "example" : "default-source" }, "property" : { "$ref" : "#/components/schemas/PropertyDefinition", "description" : "Property" }, "sources" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/NodeTemplate" }, "description" : "Sources", "example" : "sources" }, "tags" : { "type" : "string" }, "updated-by" : { "type" : "string", "description" : "Updated by", "example" : "example@onap.com" } }, "required" : [ "group", "name", "property", "sources", "updated-by" ] }, "ResourceDictionary" : { "type" : "object", "properties" : { "creationDate" : { "type" : "string", "format" : "date-time" }, "dataType" : { "type" : "string", "description" : "Data type", "example" : "string" }, "definition" : { "$ref" : "#/components/schemas/ResourceDefinition", "description" : "Definition" }, "description" : { "type" : "string", "description" : "Description", "example" : "demo_artifacts_version" }, "entrySchema" : { "type" : "string", "description" : "Entry schema", "example" : "dt-license-key" }, "name" : { "type" : "string", "description" : "Name", "example" : "sample-db-source" }, "resourceDictionaryGroup" : { "type" : "string", "description" : "Resource dictionary group", "example" : "default" }, "tags" : { "type" : "string", "description" : "Tags", "example" : "hostname" }, "updatedBy" : { "type" : "string", "description" : "Updated by", "example" : "username" } }, "required" : [ "dataType", "definition", "description", "entrySchema", "name", "resourceDictionaryGroup", "tags", "updatedBy" ] }, "ResourceResolution" : { "type" : "object", "properties" : { "artifactName" : { "type" : "string", "description" : "Artifact name for which to retrieve a resolved resource." }, "blueprintName" : { "type" : "string", "description" : "Name of the CBA." }, "blueprintVersion" : { "type" : "string", "description" : "Version of the CBA." }, "createdDate" : { "type" : "string", "format" : "date-time", "description" : "Creation date of the resolution." }, "dictionaryName" : { "type" : "string", "description" : "Name of the data dictionary used for the resolution." }, "dictionarySource" : { "type" : "string", "description" : "Source associated with the data dictionary used for the resolution." }, "dictionaryVersion" : { "type" : "integer", "format" : "int32", "description" : "Version of the data dictionary used for the resolution." }, "id" : { "type" : "string" }, "name" : { "type" : "string", "description" : "Name of the resource." }, "occurrence" : { "type" : "integer", "format" : "int32", "description" : "If resolution occurred multiple time, this field provides the index." }, "resolutionKey" : { "type" : "string", "description" : "Resolution Key uniquely identifying the resolution of a given artifact within a CBA." }, "resourceId" : { "type" : "string", "description" : "ID associated with the resolution type in the inventory system." }, "resourceType" : { "type" : "string", "description" : "Resolution type.", "example" : "ServiceInstance" }, "status" : { "type" : "string", "description" : "Whether success of failure." }, "value" : { "type" : "string", "description" : "Value of the resolution." } }, "required" : [ "artifactName", "blueprintName", "blueprintVersion", "createdDate", "dictionaryName", "dictionarySource", "dictionaryVersion", "name", "occurrence", "resolutionKey", "resourceId", "resourceType", "status", "value" ] }, "ResourceSourceMapping" : { "type" : "object", "properties" : { "resourceSourceMappings" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "required" : [ "resourceSourceMappings" ] }, "SortObject" : { "type" : "object", "properties" : { "empty" : { "type" : "boolean" }, "sorted" : { "type" : "boolean" }, "unsorted" : { "type" : "boolean" } } }, "Status" : { "type" : "object", "properties" : { "code" : { "type" : "integer", "format" : "int32", "description" : "HTTP status code equivalent." }, "errorMessage" : { "type" : "string", "description" : "Error message when system failed" }, "eventType" : { "type" : "string", "description" : "Type of the event being emitted by CDS." }, "message" : { "type" : "string", "description" : "Message providing request status" }, "timestamp" : { "type" : "string", "format" : "date-time", "description" : "Time when the execution ended.", "example" : "2012-04-23T18:25:43.511Z" } }, "required" : [ "code", "eventType", "message", "timestamp" ] }, "TemplateResolution" : { "type" : "object", "properties" : { "artifactName" : { "type" : "string", "description" : "Artifact name for which to retrieve a resolved resource." }, "blueprintName" : { "type" : "string", "description" : "Name of the CBA." }, "blueprintVersion" : { "type" : "string", "description" : "Version of the CBA." }, "createdDate" : { "type" : "string", "format" : "date-time", "description" : "Creation date of the resolution." }, "id" : { "type" : "string" }, "occurrence" : { "type" : "integer", "format" : "int32", "description" : "If resolution occurred multiple time, this field provides the index." }, "resolutionKey" : { "type" : "string", "description" : "Resolution Key uniquely identifying the resolution of a given artifact within a CBA." }, "resourceId" : { "type" : "string", "description" : "ID associated with the resolution type in the inventory system." }, "resourceType" : { "type" : "string", "description" : "Resolution type.", "example" : "ServiceInstance" }, "result" : { "type" : "string", "description" : "Rendered template." } }, "required" : [ "artifactName", "blueprintName", "blueprintVersion", "createdDate", "occurrence", "resolutionKey", "resourceId", "resourceType", "result" ] }, "WorkFlowSpecRequest" : { "type" : "object", "properties" : { "blueprintName" : { "type" : "string", "description" : "Name of the BLueprint", "example" : "pnf_netconf" }, "returnContent" : { "type" : "string" }, "specType" : { "type" : "string" }, "version" : { "type" : "string" }, "workflowName" : { "type" : "string", "description" : "Name of the Workflow", "example" : "config-assign" } }, "required" : [ "blueprintName", "returnContent", "specType", "version", "workflowName" ] } }, "securitySchemes" : { "basicAuth" : { "scheme" : "basic", "type" : "http" } } } }