diff options
Diffstat (limited to 'docs/api-reference')
| -rw-r--r-- | docs/api-reference/bp-processor.rst | 4 | ||||
| -rw-r--r-- | docs/api-reference/media/bp-processor.postman_collection.json | 881 | ||||
| -rw-r--r-- | docs/api-reference/media/cds-bp-processor-api-swagger.json | 2948 |
3 files changed, 2987 insertions, 846 deletions
diff --git a/docs/api-reference/bp-processor.rst b/docs/api-reference/bp-processor.rst index ea8880174..c4694c0bd 100644 --- a/docs/api-reference/bp-processor.rst +++ b/docs/api-reference/bp-processor.rst @@ -13,10 +13,10 @@ which is automatically created during CDS build process by Swagger Maven Plugin. also included. Endpoints can also be described using this template :download:`api-doc-template.rst <api-doc-template.rst>` but this is not the prefered way to describe the CDS API. -Authentification +Authorization ----------------- -Use Basic athentification with `ccsdkapps` as a username and password, in Header ``Authorization: Basic Y2NzZGthcHBzOmNjc2RrYXBwcw==``. +Use Basic authorization with `ccsdkapps` as a username and password, in Header ``Authorization: Basic Y2NzZGthcHBzOmNjc2RrYXBwcw==``. Download ------------ diff --git a/docs/api-reference/media/bp-processor.postman_collection.json b/docs/api-reference/media/bp-processor.postman_collection.json index 0e62117b7..2aabe1393 100644 --- a/docs/api-reference/media/bp-processor.postman_collection.json +++ b/docs/api-reference/media/bp-processor.postman_collection.json @@ -7,7 +7,7 @@ }, "item": [ { - "name": "Blueprint Model Catalog API", + "name": "Blueprint Model Catalog", "item": [ { "name": "List all Blueprint Models", @@ -2780,6 +2780,885 @@ "protocolProfileBehavior": {} }, { + "name": "Resource configuration", + "item": [ + { + "name": "Retrieve a resource configuration snapshot", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/configs", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "configs" + ] + }, + "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." + }, + "response": [] + }, + { + "name": "Retrieve all resource configuration snapshots identified by a given resource_id", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/configs/allByID", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "configs", + "allByID" + ] + }, + "description": "Retrieve all config snapshots, identified by its Resource Id, ordered by most recently created/modified date." + }, + "response": [] + }, + { + "name": "Retrieve all resource configuration snapshots for a given resource type", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/configs/allByType", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "configs", + "allByType" + ] + }, + "description": "Retrieve all config snapshots matching a specified Resource Type, ordered by most recently created/modified date." + }, + "response": [] + }, + { + "name": "Store a resource configuration snapshot identified by resourceId, resourceType, status", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "POST", + "header": [], + "body": { + "mode": "formdata", + "formdata": [] + }, + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/configs/PNF/1/RUNNING", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "configs", + "PNF", + "1", + "RUNNING" + ] + }, + "description": "Store a resource configuration snapshot, identified by its resourceId and resourceType, and optionally its status, either RUNNING or CANDIDATE." + }, + "response": [] + } + ], + "description": "Interaction with stored configurations", + "protocolProfileBehavior": {} + }, + { + "name": "Resource dictionary", + "item": [ + { + "name": "Save a resource dictionary", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\r\n \"name\": \"test-source\",\r\n \"dataType\": \"string\",\r\n \"entrySchema\": null,\r\n \"resourceDictionaryGroup\": \"default\",\r\n \"definition\": {\r\n \"tags\": \"oam-local-ipv4-address\",\r\n \"name\": \"test-source\",\r\n \"property\": {\r\n \"description\": \"test\",\r\n \"required\": null,\r\n \"type\": \"string\",\r\n \"status\": null,\r\n \"constraints\": null,\r\n \"metadata\": null,\r\n \"value\": null,\r\n \"input-param\": null,\r\n \"default\": null,\r\n \"entry_schema\": null,\r\n \"external-schema\": null\r\n },\r\n \"group\": \"default\",\r\n \"updated-by\": \"sample@onap.com\",\r\n \"sources\": {\r\n \"sdnc\": {\r\n \"description\": null,\r\n \"type\": \"source-rest\",\r\n \"metadata\": null,\r\n \"directives\": null,\r\n \"properties\": {\r\n \"type\": \"JSON\",\r\n \"endpoint-selector\": \"\",\r\n \"url-path\": \"test\",\r\n \"path\": \"/v4-assigned-ip-list/0/v4-ip-prefix\",\r\n \"input-key-mapping\": {\r\n \"service-instance-id\": \"service-instance-id\",\r\n \"network-role\": \"network-role\",\r\n \"v4-ip-type\": \"v4-ip-type\",\r\n \"vm-type\": \"vm-type\"\r\n },\r\n \"output-key-mapping\": {\r\n \"oam-local-ipv4-address\": \"v4-ip-prefix\"\r\n },\r\n \"key-dependencies\": [\r\n \"service-instance-id\",\r\n \"network-role\",\r\n \"v4-ip-type\",\r\n \"vm-type\"\r\n ]\r\n },\r\n \"attributes\": null,\r\n \"capabilities\": null,\r\n \"requirements\": null,\r\n \"interfaces\": null,\r\n \"artifacts\": null,\r\n \"copy\": null,\r\n \"node_filter\": null\r\n }\r\n }\r\n },\r\n \"description\": \"test\",\r\n \"tags\": \"oam-local-ipv4-address\",\r\n \"updatedBy\": \"sample@onap.com\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/dictionary", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "dictionary" + ] + }, + "description": "Save a resource dictionary by dictionary provided." + }, + "response": [] + }, + { + "name": "Search for a resource dictionary", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\r\n \"pub_key\",\r\n \"hostname\"\r\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/dictionary/by-names", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "dictionary", + "by-names" + ] + }, + "description": "Search for a resource dictionary by names provided." + }, + "response": [] + }, + { + "name": "Save a resource dictionary", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\r\n \"tags\": \"v4-ip-type, tosca.datatypes.Root, data_type\",\r\n \"name\": \"test-source\",\r\n \"group\":\"test\",\r\n \"property\" :{\r\n \"description\": \"test\",\r\n \"type\": \"string\"\r\n },\r\n \"updated-by\": \"sample@onap.com\",\r\n \"sources\": {\r\n \"default\": {\r\n \"type\": \"source-default\",\r\n \"properties\": {\r\n }\r\n }\r\n }\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/dictionary/api/v1/dictionary/definition", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "dictionary", + "api", + "v1", + "dictionary", + "definition" + ] + }, + "description": "Save a resource dictionary by dictionary provided." + }, + "response": [] + }, + { + "name": "Retrieve all resource dictionary groups", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/dictionary/resource_dictionary_group", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "dictionary", + "resource_dictionary_group" + ] + }, + "description": "Retrieve all config snapshots matching a specified Resource Type, ordered by most recently created/modified date." + }, + "response": [] + }, + { + "name": "Search for a resource dictionary", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/dictionary/search/hostname", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "dictionary", + "search", + "hostname" + ] + }, + "description": "Retrieve all config snapshots matching a specified Resource Type, ordered by most recently created/modified date." + }, + "response": [] + }, + { + "name": "Search for a source mapping", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/dictionary/search/hostname", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "dictionary", + "search", + "hostname" + ] + }, + "description": "Search for a source mapping." + }, + "response": [] + }, + { + "name": "Retrieve a resource dictionary", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/dictionary/active-streams", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "dictionary", + "active-streams" + ] + }, + "description": "Retrieve a resource dictionary by name provided." + }, + "response": [] + }, + { + "name": "Remove a resource dictionary", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "DELETE", + "header": [], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/dictionary/active-streams", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "dictionary", + "active-streams" + ] + }, + "description": "Remove a resource dictionary by name provided." + }, + "response": [] + } + ], + "description": "Interaction with stored dictionaries", + "protocolProfileBehavior": {} + }, + { + "name": "Resource template", + "item": [ + { + "name": "Store a resolved template w/ resolution-key", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "PAYLOAD DATA", + "options": { + "raw": { + "language": "text" + } + } + }, + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/template/baseconfiguration/1.0.0/activate/7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "template", + "baseconfiguration", + "1.0.0", + "activate", + "7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08" + ] + }, + "description": "Store a template for a given CBA's action, identified by its blueprint name, blueprint version, artifact name and resolution key." + }, + "response": [] + }, + { + "name": "Store a resolved template w/ resourceId and resourceType", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "PAYLOAD DATA", + "options": { + "raw": { + "language": "text" + } + } + }, + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/template/baseconfiguration/1.0.0/activate/test/1", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "template", + "baseconfiguration", + "1.0.0", + "activate", + "test", + "1" + ] + }, + "description": "Store a template for a given CBA's action, identified by its blueprint name, blueprint version, artifact name, resourceId and resourceType." + }, + "response": [] + } + ], + "description": "Interaction with resolved templates", + "protocolProfileBehavior": {} + }, + { + "name": "Resources", + "item": [ + { + "name": "Get all resolved resources using the resolution key", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/resources?bpVersion=1.0.0&artifactName=activate&bpName=baseconfiguration&resolutionKey=7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "resources" + ], + "query": [ + { + "key": "bpVersion", + "value": "1.0.0" + }, + { + "key": "artifactName", + "value": "activate" + }, + { + "key": "bpName", + "value": "baseconfiguration" + }, + { + "key": "resolutionKey", + "value": "7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08" + } + ] + }, + "description": "Retrieve all config snapshots matching a specified Resource Type, ordered by most recently created/modified date." + }, + "response": [] + }, + { + "name": "Delete resources using resolution key", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "DELETE", + "header": [], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/resources?bpVersion=1.0.0&artifactName=activate&bpName=baseconfiguration&resolutionKey=7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "resources" + ], + "query": [ + { + "key": "bpVersion", + "value": "1.0.0" + }, + { + "key": "artifactName", + "value": "activate" + }, + { + "key": "bpName", + "value": "baseconfiguration" + }, + { + "key": "resolutionKey", + "value": "7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08" + } + ] + }, + "description": "Delete all the resources associated to a resolution-key using blueprint metadata, artifact name and the resolution-key." + }, + "response": [] + }, + { + "name": "Fetch a resource value using resolution key", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "showPassword", + "value": false, + "type": "boolean" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/resources/api/v1/resources/resource?bpVersion=1.0.0&artifactName=activate&bpName=baseconfiguration&resolutionKey=7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08&name=test", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "resources", + "api", + "v1", + "resources", + "resource" + ], + "query": [ + { + "key": "bpVersion", + "value": "1.0.0" + }, + { + "key": "artifactName", + "value": "activate" + }, + { + "key": "bpName", + "value": "baseconfiguration" + }, + { + "key": "resolutionKey", + "value": "7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08" + }, + { + "key": "name", + "value": "test" + } + ] + }, + "description": "Retrieve a stored resource value using the blueprint metadata, artifact name, resolution-key along with the name of the resource value to retrieve." + }, + "response": [] + } + ], + "description": "Interaction with resolved resources", + "protocolProfileBehavior": {} + }, + { "name": "List all endpoints", "request": { "auth": { diff --git a/docs/api-reference/media/cds-bp-processor-api-swagger.json b/docs/api-reference/media/cds-bp-processor-api-swagger.json index af3ed94e6..c7f24262e 100644 --- a/docs/api-reference/media/cds-bp-processor-api-swagger.json +++ b/docs/api-reference/media/cds-bp-processor-api-swagger.json @@ -1,844 +1,2106 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "Shows all resources and endpoints which CDS BP processor currently provides with sample requests/responses, parameter description and other information.", - "version" : "v1", - "title" : "CDS Blueprint Processor API Reference", - "termsOfService" : "https://www.onap.org/", - "contact" : { - "name" : "ONAP Community", - "url" : "https://www.onap.org/", - "email" : "onap-discuss@lists.onap.org" - }, - "license" : { - "name" : "Apache 2.0", - "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "host" : "localhost:8080", - "tags" : [ { - "name" : "Blueprint Model Catalog API", - "description" : "Manages all blueprint models which are available in CDS" - } ], - "schemes" : [ "http" ], - "paths" : { - "/api/v1/blueprint-model" : { - "get" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "List all Blueprint Models", - "description" : "Lists all meta-data of blueprint models which are saved in CDS.", - "operationId" : "BlueprintModelController_allBlueprintModel_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", - "produces" : [ "application/json" ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BlueprintModelSearch" - } - } - }, - "500" : { - "description" : "Internal Server Error" - } - } - }, - "post" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Save a Blueprint Model", - "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", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "file", - "description" : "CBA file to be uploaded (example: cba.zip)", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FilePart" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/BlueprintModelSearch" - } - }, - "500" : { - "description" : "Internal Server Error" - } - } - } - }, - "/api/v1/blueprint-model/bootstrap" : { - "post" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Bootstrap CDS", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Specifies which elements to load", - "required" : true, - "schema" : { - "$ref" : "#/definitions/BootstrapRequest" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "500" : { - "description" : "Internal Server Error" - } - } - } - }, - "/api/v1/blueprint-model/by-name/{name}/version/{version}" : { - "get" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Get a Blueprint Model by Name and Version", - "description" : "Get Meta-Data of a Blueprint Model by its name and version.", - "operationId" : "BlueprintModelController_getBlueprintByNameAndVersion_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "name", - "in" : "path", - "description" : "Name of the blueprint model", - "required" : true, - "type" : "string", - "x-example" : "pnf_netconf" - }, { - "name" : "version", - "in" : "path", - "description" : "Version of the blueprint model", - "required" : true, - "type" : "string", - "x-example" : "1.0.0" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/BlueprintModelSearch" - } - }, - "404" : { - "description" : "Not Found" - } - } - } - }, - "/api/v1/blueprint-model/download/by-name/{name}/version/{version}" : { - "get" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Download a Blueprint Model", - "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", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "name", - "in" : "path", - "description" : "Name of the blueprint model", - "required" : true, - "type" : "string", - "x-example" : "pnf_netconf" - }, { - "name" : "version", - "in" : "path", - "description" : "Version of the blueprint model", - "required" : true, - "type" : "string", - "x-example" : "1.0.0" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "404" : { - "description" : "Not Found" - } - } - } - }, - "/api/v1/blueprint-model/download/{id}" : { - "get" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Download a Blueprint Model by ID", - "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", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "ID of the blueprint model to download", - "required" : true, - "type" : "string", - "x-example" : "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "404" : { - "description" : "Not Found" - } - } - } - }, - "/api/v1/blueprint-model/enrich" : { - "post" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Enrich a Blueprint Model", - "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", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "file", - "description" : "CBA zip file to be uploaded (example: cba_unenriched.zip)", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FilePart" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "object" - } - } - } - } - }, - "/api/v1/blueprint-model/enrichandpublish" : { - "post" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Enrich and publish a Blueprint Model", - "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", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "file", - "description" : "Unenriched CBA zip file to be uploaded (example: cba_unenriched.zip)", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FilePart" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/BlueprintModelSearch" - } - }, - "503" : { - "description" : "Service Unavailable" - } - } - } - }, - "/api/v1/blueprint-model/meta-data/{keyword}" : { - "get" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Search for Blueprints by a Keyword", - "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", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "keyword", - "in" : "path", - "description" : "Keyword to search for in blueprint model meta-data", - "required" : true, - "type" : "string", - "x-example" : "pnf_netconf" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BlueprintModelSearch" - } - } - } - } - } - }, - "/api/v1/blueprint-model/name/{name}/version/{version}" : { - "delete" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Delete a Blueprint Model by Name", - "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" : [ { - "name" : "name", - "in" : "path", - "description" : "Name of the blueprint model", - "required" : true, - "type" : "string", - "x-example" : "pnf_netconf" - }, { - "name" : "version", - "in" : "path", - "description" : "Version of the blueprint model", - "required" : true, - "type" : "string", - "x-example" : "1.0.0" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "object" - } - } - } - } - }, - "/api/v1/blueprint-model/paged" : { - "get" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Get Blueprints ordered", - "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", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "limit", - "in" : "query", - "description" : "Maximum number of returned blueprint models", - "required" : false, - "type" : "integer", - "default" : 20, - "format" : "int32" - }, { - "name" : "offset", - "in" : "query", - "description" : "Offset", - "required" : false, - "type" : "integer", - "default" : 0, - "format" : "int32" - }, { - "name" : "sort", - "in" : "query", - "description" : "Order of returned blueprint models", - "required" : false, - "type" : "string", - "default" : "DATE", - "enum" : [ "DATE", "NAME", "VERSION" ] - }, { - "name" : "sortType", - "in" : "query", - "description" : "Ascend or descend ordering", - "required" : false, - "type" : "string", - "default" : "ASC" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PageBlueprintModelSearch" - } - } - } - } - }, - "/api/v1/blueprint-model/paged/meta-data/{keyword}" : { - "get" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Search for Blueprints by a Keyword in an ordered mode", - "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", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "keyword", - "in" : "path", - "description" : "Keyword to search for in blueprint model meta-data", - "required" : true, - "type" : "string", - "x-example" : "pnf_netconf" - }, { - "name" : "limit", - "in" : "query", - "description" : "Maximum number of returned blueprint models", - "required" : false, - "type" : "integer", - "default" : 20, - "format" : "int32" - }, { - "name" : "offset", - "in" : "query", - "description" : "Offset", - "required" : false, - "type" : "integer", - "default" : 0, - "format" : "int32" - }, { - "name" : "sort", - "in" : "query", - "description" : "Order of returned blueprint models", - "required" : false, - "type" : "string", - "default" : "DATE", - "enum" : [ "DATE", "NAME", "VERSION" ] - }, { - "name" : "sortType", - "in" : "query", - "description" : "Ascend or descend ordering", - "required" : false, - "type" : "string", - "default" : "ASC" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/PageBlueprintModelSearch" - } - } - } - } - }, - "/api/v1/blueprint-model/publish" : { - "post" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Publish a Blueprint Model", - "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", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "file", - "description" : "Enriched CBA zip file to be uploaded (example: cba_enriched.zip)", - "required" : true, - "schema" : { - "$ref" : "#/definitions/FilePart" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/BlueprintModelSearch" - } - } - } - } - }, - "/api/v1/blueprint-model/search/{tags}" : { - "get" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Search for a Blueprint by Tag", - "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", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "tags", - "in" : "path", - "description" : "Tag to search for", - "required" : true, - "type" : "string", - "x-example" : "test" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BlueprintModelSearch" - } - } - } - } - } - }, - "/api/v1/blueprint-model/workflow-spec" : { - "post" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Get Workflow Specification", - "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", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "description" : "Blueprint and workflow identification", - "required" : true, - "schema" : { - "$ref" : "#/definitions/WorkFlowSpecRequest" - } - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "object" - } - } - } - } - }, - "/api/v1/blueprint-model/workflows/blueprint-name/{name}/version/{version}" : { - "get" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Get Workflows of a Blueprint", - "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", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "name", - "in" : "path", - "description" : "Name of the blueprint model", - "required" : true, - "type" : "string", - "x-example" : "pnf_netconf" - }, { - "name" : "version", - "in" : "path", - "description" : "Version of the blueprint model", - "required" : true, - "type" : "string", - "x-example" : "1.0.0" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "object" - } - } - } - } - }, - "/api/v1/blueprint-model/{id}" : { - "get" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Get a Blueprint Model by ID", - "description" : "Get meta-data of a blueprint model by its internally created ID.", - "operationId" : "BlueprintModelController_getBlueprintModel_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "id", - "in" : "path", - "description" : "ID of the blueprint model to search for", - "required" : true, - "type" : "string", - "x-example" : "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "$ref" : "#/definitions/BlueprintModelSearch" - } - }, - "404" : { - "description" : "Not Found" - } - } - }, - "delete" : { - "tags" : [ "Blueprint Model Catalog API" ], - "summary" : "Delete a Blueprint Model by ID", - "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" : [ { - "name" : "id", - "in" : "path", - "description" : "ID of the blueprint model to delete", - "required" : true, - "type" : "string", - "x-example" : "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4" - } ], - "responses" : { - "200" : { - "description" : "OK", - "schema" : { - "type" : "object" - } - }, - "404" : { - "description" : "RESOURCE_NOT_FOUND" - } - } - } - } - }, - "securityDefinitions" : { - "Basic Auth" : { - "type" : "basic" - } - }, - "definitions" : { - "BlueprintModelSearch" : { - "type" : "object", - "required" : [ "artifactName", "artifactVersion", "createdDate", "id", "published", "tags", "updatedBy" ], - "properties" : { - "id" : { - "type" : "string", - "example" : "658f9a48-7f54-41ba-ae18-c69f26f3dc94", - "description" : "ID of Blueprint model, is automatically created by CDS" - }, - "artifactUUId" : { - "type" : "string", - "example" : null, - "description" : "Artifact UUID, usually null" - }, - "artifactType" : { - "type" : "string", - "example" : "SDNC_MODEL", - "description" : "Artifact Type, usually null" - }, - "artifactVersion" : { - "type" : "string", - "example" : "1.0.0", - "description" : "Artifact Version, usually 1.0.0" - }, - "artifactDescription" : { - "type" : "string", - "example" : "", - "description" : "Artifact Description, usually empty" - }, - "internalVersion" : { - "type" : "integer", - "format" : "int32", - "example" : null, - "description" : "Internal Version of CBA, usually null" - }, - "createdDate" : { - "type" : "string", - "format" : "date-time", - "example" : "2020-11-19T10:34:56.000Z", - "description" : "Datetime of the creation of CBA in CDS" - }, - "artifactName" : { - "type" : "string", - "example" : "pnf_netconf", - "description" : "Artifact Name, defined in Metadata" - }, - "published" : { - "type" : "string", - "example" : "pnf_netconf", - "description" : "Artifact Name, defined in Metadata" - }, - "updatedBy" : { - "type" : "string", - "example" : "Deutsche Telekom AG", - "description" : "Name of publisher, defined in Metadata" - }, - "tags" : { - "type" : "string", - "example" : "test", - "description" : "Tags to identify the CBA, defined in Metadata" - } - } - }, - "BootstrapRequest" : { - "type" : "object", - "required" : [ "loadCBA", "loadModelType", "loadResourceDictionary" ], - "properties" : { - "loadModelType" : { - "type" : "boolean", - "example" : true, - "description" : "Specifies if default model types should be loaded" - }, - "loadResourceDictionary" : { - "type" : "boolean", - "example" : true, - "description" : "Specifies if default data dictionaries should be loaded" - }, - "loadCBA" : { - "type" : "boolean", - "example" : true, - "description" : "Specifies if default blueprint models should be loaded" - } - } - }, - "FilePart" : { - "type" : "object" - }, - "Page" : { - "type" : "object", - "properties" : { - "totalPages" : { - "type" : "integer", - "format" : "int32" - }, - "totalElements" : { - "type" : "integer", - "format" : "int64" - }, - "size" : { - "type" : "integer", - "format" : "int32" - }, - "content" : { - "type" : "array", - "items" : { - "type" : "object" - } - }, - "number" : { - "type" : "integer", - "format" : "int32" - }, - "sort" : { - "$ref" : "#/definitions/Sort" - }, - "last" : { - "type" : "boolean" - }, - "numberOfElements" : { - "type" : "integer", - "format" : "int32" - }, - "pageable" : { - "$ref" : "#/definitions/Pageable" - }, - "first" : { - "type" : "boolean" - }, - "empty" : { - "type" : "boolean" - } - } - }, - "PageBlueprintModelSearch" : { - "type" : "object", - "properties" : { - "totalPages" : { - "type" : "integer", - "format" : "int32" - }, - "totalElements" : { - "type" : "integer", - "format" : "int64" - }, - "size" : { - "type" : "integer", - "format" : "int32" - }, - "content" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/BlueprintModelSearch" - } - }, - "number" : { - "type" : "integer", - "format" : "int32" - }, - "sort" : { - "$ref" : "#/definitions/Sort" - }, - "last" : { - "type" : "boolean" - }, - "numberOfElements" : { - "type" : "integer", - "format" : "int32" - }, - "pageable" : { - "$ref" : "#/definitions/Pageable" - }, - "first" : { - "type" : "boolean" - }, - "empty" : { - "type" : "boolean" - } - } - }, - "Pageable" : { - "type" : "object", - "properties" : { - "offset" : { - "type" : "integer", - "format" : "int64" - }, - "sort" : { - "$ref" : "#/definitions/Sort" - }, - "paged" : { - "type" : "boolean" - }, - "unpaged" : { - "type" : "boolean" - }, - "pageNumber" : { - "type" : "integer", - "format" : "int32" - }, - "pageSize" : { - "type" : "integer", - "format" : "int32" - } - } - }, - "Sort" : { - "type" : "object", - "properties" : { - "unsorted" : { - "type" : "boolean" - }, - "sorted" : { - "type" : "boolean" - }, - "empty" : { - "type" : "boolean" - } - } - }, - "WorkFlowSpecRequest" : { - "type" : "object", - "required" : [ "blueprintName", "workflowName" ], - "properties" : { - "blueprintName" : { - "type" : "string", - "example" : "pnf_netconf", - "description" : "Name of the BLueprint" - }, - "version" : { - "type" : "string" - }, - "returnContent" : { - "type" : "string" - }, - "workflowName" : { - "type" : "string", - "example" : "config-assign", - "description" : "Name of the Workflow" - }, - "specType" : { - "type" : "string" - } - } - } - } +{
+ "swagger" : "2.0",
+ "info" : {
+ "description" : "Shows all resources and endpoints which CDS BP processor currently provides with sample requests/responses, parameter description and other information.",
+ "version" : "v1",
+ "title" : "CDS Blueprint Processor API Reference",
+ "termsOfService" : "https://www.onap.org/",
+ "contact" : {
+ "name" : "ONAP Community",
+ "url" : "https://www.onap.org/",
+ "email" : "onap-discuss@lists.onap.org"
+ },
+ "license" : {
+ "name" : "Apache 2.0",
+ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
+ }
+ },
+ "host" : "localhost:8080",
+ "tags" : [ {
+ "name" : "Blueprint Model Catalog",
+ "description" : "Manages all blueprint models which are available in CDS"
+ }, {
+ "name" : "Resource configuration",
+ "description" : "Interaction with stored configurations"
+ }, {
+ "name" : "Resource dictionary",
+ "description" : "Interaction with stored dictionaries"
+ }, {
+ "name" : "Resource template",
+ "description" : "Interaction with resolved templates"
+ }, {
+ "name" : "Resources",
+ "description" : "Interaction with resolved resources"
+ } ],
+ "schemes" : [ "http" ],
+ "paths" : {
+ "/api/v1/blueprint-model" : {
+ "get" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "List all Blueprint Models",
+ "description" : "Lists all meta-data of blueprint models which are saved in CDS.",
+ "operationId" : "BlueprintModelController_allBlueprintModel_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/BlueprintModelSearch"
+ }
+ }
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Save a Blueprint Model",
+ "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",
+ "consumes" : [ "multipart/form-data" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "file",
+ "description" : "CBA file to be uploaded (example: cba.zip)",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/FilePart"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/BlueprintModelSearch"
+ }
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/bootstrap" : {
+ "post" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Bootstrap CDS",
+ "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",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Specifies which elements to load",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/BootstrapRequest"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "type" : "object"
+ }
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/by-name/{name}/version/{version}" : {
+ "get" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Get a Blueprint Model by Name and Version",
+ "description" : "Get Meta-Data of a Blueprint Model by its name and version.",
+ "operationId" : "BlueprintModelController_getBlueprintByNameAndVersion_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "name",
+ "in" : "path",
+ "description" : "Name of the blueprint model",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "pnf_netconf"
+ }, {
+ "name" : "version",
+ "in" : "path",
+ "description" : "Version of the blueprint model",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "1.0.0"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/BlueprintModelSearch"
+ }
+ },
+ "404" : {
+ "description" : "Not Found"
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/download/by-name/{name}/version/{version}" : {
+ "get" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Download a Blueprint Model",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "name",
+ "in" : "path",
+ "description" : "Name of the blueprint model",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "pnf_netconf"
+ }, {
+ "name" : "version",
+ "in" : "path",
+ "description" : "Version of the blueprint model",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "1.0.0"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "type" : "object"
+ }
+ },
+ "404" : {
+ "description" : "Not Found"
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/download/{id}" : {
+ "get" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Download a Blueprint Model by ID",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "id",
+ "in" : "path",
+ "description" : "ID of the blueprint model to download",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "type" : "object"
+ }
+ },
+ "404" : {
+ "description" : "Not Found"
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/enrich" : {
+ "post" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Enrich a Blueprint Model",
+ "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",
+ "consumes" : [ "multipart/form-data" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "file",
+ "description" : "CBA zip file to be uploaded (example: cba_unenriched.zip)",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/FilePart"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/enrichandpublish" : {
+ "post" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Enrich and publish a Blueprint Model",
+ "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",
+ "consumes" : [ "multipart/form-data" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "file",
+ "description" : "Unenriched CBA zip file to be uploaded (example: cba_unenriched.zip)",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/FilePart"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/BlueprintModelSearch"
+ }
+ },
+ "503" : {
+ "description" : "Service Unavailable"
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/meta-data/{keyword}" : {
+ "get" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Search for Blueprints by a Keyword",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "keyword",
+ "in" : "path",
+ "description" : "Keyword to search for in blueprint model meta-data",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "pnf_netconf"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/BlueprintModelSearch"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/name/{name}/version/{version}" : {
+ "delete" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Delete a Blueprint Model by Name",
+ "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" : [ {
+ "name" : "name",
+ "in" : "path",
+ "description" : "Name of the blueprint model",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "pnf_netconf"
+ }, {
+ "name" : "version",
+ "in" : "path",
+ "description" : "Version of the blueprint model",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "1.0.0"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/paged" : {
+ "get" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Get Blueprints ordered",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "limit",
+ "in" : "query",
+ "description" : "Maximum number of returned blueprint models",
+ "required" : false,
+ "type" : "integer",
+ "default" : 20,
+ "format" : "int32"
+ }, {
+ "name" : "offset",
+ "in" : "query",
+ "description" : "Offset",
+ "required" : false,
+ "type" : "integer",
+ "default" : 0,
+ "format" : "int32"
+ }, {
+ "name" : "sort",
+ "in" : "query",
+ "description" : "Order of returned blueprint models",
+ "required" : false,
+ "type" : "string",
+ "default" : "DATE",
+ "enum" : [ "DATE", "NAME", "VERSION" ]
+ }, {
+ "name" : "sortType",
+ "in" : "query",
+ "description" : "Ascend or descend ordering",
+ "required" : false,
+ "type" : "string",
+ "default" : "ASC"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/PageBlueprintModelSearch"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/paged/meta-data/{keyword}" : {
+ "get" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Search for Blueprints by a Keyword in an ordered mode",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "keyword",
+ "in" : "path",
+ "description" : "Keyword to search for in blueprint model meta-data",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "pnf_netconf"
+ }, {
+ "name" : "limit",
+ "in" : "query",
+ "description" : "Maximum number of returned blueprint models",
+ "required" : false,
+ "type" : "integer",
+ "default" : 20,
+ "format" : "int32"
+ }, {
+ "name" : "offset",
+ "in" : "query",
+ "description" : "Offset",
+ "required" : false,
+ "type" : "integer",
+ "default" : 0,
+ "format" : "int32"
+ }, {
+ "name" : "sort",
+ "in" : "query",
+ "description" : "Order of returned blueprint models",
+ "required" : false,
+ "type" : "string",
+ "default" : "DATE",
+ "enum" : [ "DATE", "NAME", "VERSION" ]
+ }, {
+ "name" : "sortType",
+ "in" : "query",
+ "description" : "Ascend or descend ordering",
+ "required" : false,
+ "type" : "string",
+ "default" : "ASC"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/PageBlueprintModelSearch"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/publish" : {
+ "post" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Publish a Blueprint Model",
+ "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",
+ "consumes" : [ "multipart/form-data" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "file",
+ "description" : "Enriched CBA zip file to be uploaded (example: cba_enriched.zip)",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/FilePart"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/BlueprintModelSearch"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/search/{tags}" : {
+ "get" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Search for a Blueprint by Tag",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tags",
+ "in" : "path",
+ "description" : "Tag to search for",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "test"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/BlueprintModelSearch"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/workflow-spec" : {
+ "post" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Get Workflow Specification",
+ "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",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Blueprint and workflow identification",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/WorkFlowSpecRequest"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/workflows/blueprint-name/{name}/version/{version}" : {
+ "get" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Get Workflows of a Blueprint",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "name",
+ "in" : "path",
+ "description" : "Name of the blueprint model",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "pnf_netconf"
+ }, {
+ "name" : "version",
+ "in" : "path",
+ "description" : "Version of the blueprint model",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "1.0.0"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/blueprint-model/{id}" : {
+ "get" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Get a Blueprint Model by ID",
+ "description" : "Get meta-data of a blueprint model by its internally created ID.",
+ "operationId" : "BlueprintModelController_getBlueprintModel_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "id",
+ "in" : "path",
+ "description" : "ID of the blueprint model to search for",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/BlueprintModelSearch"
+ }
+ },
+ "404" : {
+ "description" : "Not Found"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "Blueprint Model Catalog" ],
+ "summary" : "Delete a Blueprint Model by ID",
+ "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" : [ {
+ "name" : "id",
+ "in" : "path",
+ "description" : "ID of the blueprint model to delete",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "type" : "object"
+ }
+ },
+ "404" : {
+ "description" : "RESOURCE_NOT_FOUND"
+ }
+ }
+ }
+ },
+ "/api/v1/configs" : {
+ "get" : {
+ "tags" : [ "Resource configuration" ],
+ "summary" : "Retrieve a resource configuration snapshot",
+ "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",
+ "produces" : [ "text/plain", "application/json", "application/xml" ],
+ "parameters" : [ {
+ "name" : "resourceType",
+ "in" : "query",
+ "description" : "Resource Type associated of the resource configuration snapshot",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "\"PNF\""
+ }, {
+ "name" : "resourceId",
+ "in" : "query",
+ "description" : "Resource Id associated of the resource configuration snapshot",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "\"1\""
+ }, {
+ "name" : "status",
+ "in" : "query",
+ "description" : "Status of the snapshot being retrieved",
+ "required" : false,
+ "type" : "string",
+ "default" : "RUNNING"
+ }, {
+ "name" : "format",
+ "in" : "query",
+ "description" : "Expected format of the snapshot being retrieved",
+ "required" : false,
+ "type" : "string",
+ "default" : "text/plain"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/configs/allByID" : {
+ "get" : {
+ "tags" : [ "Resource configuration" ],
+ "summary" : "Retrieve all resource configuration snapshots identified by a given resource_id",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "resourceId",
+ "in" : "query",
+ "description" : "Resource Id associated of the resource configuration snapshots",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "\"1\""
+ }, {
+ "name" : "status",
+ "in" : "query",
+ "description" : "Status of the snapshot being retrieved",
+ "required" : false,
+ "type" : "string",
+ "default" : "ANY"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/ResourceConfigSnapshot"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/configs/allByType" : {
+ "get" : {
+ "tags" : [ "Resource configuration" ],
+ "summary" : "Retrieve all resource configuration snapshots for a given resource type",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "resourceType",
+ "in" : "query",
+ "description" : "Resource Type associated of the resource configuration snapshot",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "\"PNF\""
+ }, {
+ "name" : "status",
+ "in" : "query",
+ "description" : "Status of the snapshot being retrieved",
+ "required" : false,
+ "type" : "string",
+ "default" : "ANY"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/ResourceConfigSnapshot"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/configs/{resourceType}/{resourceId}/{status}" : {
+ "post" : {
+ "tags" : [ "Resource configuration" ],
+ "summary" : "Store a resource configuration snapshot identified by resourceId, resourceType, status",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "resourceType",
+ "in" : "path",
+ "description" : "Resource Type associated with the resolution",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "\"PNF\""
+ }, {
+ "name" : "resourceId",
+ "in" : "path",
+ "description" : "Resource Id associated with the resolution",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "\"1\""
+ }, {
+ "name" : "status",
+ "in" : "path",
+ "description" : "Status of the snapshot being retrieved",
+ "required" : true,
+ "type" : "string",
+ "default" : "RUNNING"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Config snapshot to store",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/ResourceConfigSnapshot"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/dictionary" : {
+ "post" : {
+ "tags" : [ "Resource dictionary" ],
+ "summary" : "Save a resource dictionary",
+ "description" : "Save a resource dictionary by dictionary provided.",
+ "operationId" : "ResourceDictionaryController_saveResourceDictionary_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Resource dictionary to store",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/ResourceDictionary"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/ResourceDictionary"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/dictionary/by-names" : {
+ "post" : {
+ "tags" : [ "Resource dictionary" ],
+ "summary" : "Search for a resource dictionary",
+ "description" : "Search for a resource dictionary by names provided.",
+ "operationId" : "ResourceDictionaryController_searchResourceDictionaryByNames_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "body",
+ "description" : "List of names",
+ "required" : true,
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/ResourceDictionary"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/dictionary/definition" : {
+ "post" : {
+ "tags" : [ "Resource dictionary" ],
+ "summary" : "Save a resource dictionary",
+ "description" : "Save a resource dictionary by resource definition provided.",
+ "operationId" : "ResourceDictionaryController_saveResourceDictionary_1_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Resource definition to generate",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/definitions/ResourceDefinition"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/ResourceDefinition"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/dictionary/resource_dictionary_group" : {
+ "get" : {
+ "tags" : [ "Resource dictionary" ],
+ "summary" : "Retrieve all resource dictionary groups",
+ "description" : "Retrieve all resource dictionary groups.",
+ "operationId" : "ResourceDictionaryController_getResourceDictionaryDistinct_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/dictionary/search/{tags}" : {
+ "get" : {
+ "tags" : [ "Resource dictionary" ],
+ "summary" : "Search for a resource dictionary",
+ "description" : "Search for a resource dictionary by tags provided.",
+ "operationId" : "ResourceDictionaryController_searchResourceDictionaryByTags_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "tags",
+ "in" : "path",
+ "description" : "Tags list",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "\"status\""
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/ResourceDictionary"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/dictionary/source-mapping" : {
+ "get" : {
+ "tags" : [ "Resource dictionary" ],
+ "summary" : "Search for a source mapping",
+ "description" : "Search for a source mapping.",
+ "operationId" : "ResourceDictionaryController_getResourceSourceMapping_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/ResourceSourceMapping"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/dictionary/{name}" : {
+ "get" : {
+ "tags" : [ "Resource dictionary" ],
+ "summary" : "Retrieve a resource dictionary",
+ "description" : "Retrieve a resource dictionary by name provided.",
+ "operationId" : "ResourceDictionaryController_getResourceDictionaryByName_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "name",
+ "in" : "path",
+ "description" : "Name of the resource",
+ "required" : true,
+ "type" : "string",
+ "x-example" : "\"hostname\""
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/ResourceDictionary"
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "Resource dictionary" ],
+ "summary" : "Remove a resource dictionary",
+ "description" : "Remove a resource dictionary by name provided.",
+ "operationId" : "ResourceDictionaryController_deleteResourceDictionaryByName_DELETE.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
+ "parameters" : [ {
+ "name" : "name",
+ "in" : "path",
+ "description" : "Name of the resource",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "object"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/resources" : {
+ "get" : {
+ "tags" : [ "Resources" ],
+ "summary" : "Get all resolved resources using the resolution key",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "bpName",
+ "in" : "query",
+ "description" : "Name of the CBA",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bpVersion",
+ "in" : "query",
+ "description" : "Version of the CBA",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "artifactName",
+ "in" : "query",
+ "description" : "Artifact name for which to retrieve a resolved resource",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "resolutionKey",
+ "in" : "query",
+ "description" : "Resolution Key associated with the resolution",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "resourceType",
+ "in" : "query",
+ "description" : "Resource Type associated with the resolution",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "resourceId",
+ "in" : "query",
+ "description" : "Resource Id associated with the resolution",
+ "required" : false,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/ResourceResolution"
+ }
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "Resources" ],
+ "summary" : "Delete resources using resolution key",
+ "description" : "Delete all the resources associated to a resolution-key using blueprint metadata, artifact name and the resolution-key.",
+ "operationId" : "ResourceController_deleteByBlueprintNameAndBlueprintVersionAndArtifactNameAndResolutionKey_DELETE.org.onap.ccsdk.cds.blueprintsprocessor.resource.api",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "bpName",
+ "in" : "query",
+ "description" : "Name of the CBA",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bpVersion",
+ "in" : "query",
+ "description" : "Version of the CBA",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "artifactName",
+ "in" : "query",
+ "description" : "Artifact name for which to retrieve a resolved resource",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "resolutionKey",
+ "in" : "query",
+ "description" : "Resolution Key associated with the resolution",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/Unit"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/resources/resource" : {
+ "get" : {
+ "tags" : [ "Resources" ],
+ "summary" : "Fetch a resource value using resolution key",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "bpName",
+ "in" : "query",
+ "description" : "Name of the CBA",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bpVersion",
+ "in" : "query",
+ "description" : "Version of the CBA",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "artifactName",
+ "in" : "query",
+ "description" : "Artifact name for which to retrieve a resolved resource",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "resolutionKey",
+ "in" : "query",
+ "description" : "Resolution Key associated with the resolution",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "name",
+ "in" : "query",
+ "description" : "Name of the resource to retrieve",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/ResourceResolution"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/template/{bpName}/{bpVersion}/{artifactName}/{resolutionKey}" : {
+ "post" : {
+ "tags" : [ "Resource template" ],
+ "summary" : "Store a resolved template w/ resolution-key",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "bpName",
+ "in" : "path",
+ "description" : "Name of the CBA",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bpVersion",
+ "in" : "path",
+ "description" : "Version of the CBA",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "artifactName",
+ "in" : "path",
+ "description" : "Artifact name for which to retrieve a resolved resource",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "resolutionKey",
+ "in" : "path",
+ "description" : "Resolution Key associated with the resolution",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Template to store",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/TemplateResolution"
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/template/{bpName}/{bpVersion}/{artifactName}/{resourceType}/{resourceId}" : {
+ "post" : {
+ "tags" : [ "Resource template" ],
+ "summary" : "Store a resolved template w/ resourceId and resourceType",
+ "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",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "bpName",
+ "in" : "path",
+ "description" : "Name of the CBA",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "bpVersion",
+ "in" : "path",
+ "description" : "Version of the CBA",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "artifactName",
+ "in" : "path",
+ "description" : "Artifact name for which to retrieve a resolved resource",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "resourceType",
+ "in" : "path",
+ "description" : "Resource Type associated with the resolution",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "resourceId",
+ "in" : "path",
+ "description" : "Resource Id associated with the resolution",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Template to store",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/TemplateResolution"
+ }
+ }
+ }
+ }
+ }
+ },
+ "securityDefinitions" : {
+ "Basic Auth" : {
+ "type" : "basic"
+ }
+ },
+ "definitions" : {
+ "ArtifactDefinition" : {
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "type" : "string"
+ },
+ "file" : {
+ "type" : "string"
+ },
+ "repository" : {
+ "type" : "string"
+ },
+ "description" : {
+ "type" : "string"
+ },
+ "properties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/JsonNode"
+ }
+ },
+ "deploy_Path" : {
+ "type" : "string"
+ }
+ }
+ },
+ "BlueprintModelSearch" : {
+ "type" : "object",
+ "required" : [ "artifactName", "artifactVersion", "createdDate", "id", "published", "tags", "updatedBy" ],
+ "properties" : {
+ "id" : {
+ "type" : "string",
+ "example" : "658f9a48-7f54-41ba-ae18-c69f26f3dc94",
+ "description" : "ID of Blueprint model, is automatically created by CDS"
+ },
+ "artifactUUId" : {
+ "type" : "string",
+ "example" : null,
+ "description" : "Artifact UUID, usually null"
+ },
+ "artifactType" : {
+ "type" : "string",
+ "example" : "SDNC_MODEL",
+ "description" : "Artifact Type, usually null"
+ },
+ "artifactVersion" : {
+ "type" : "string",
+ "example" : "1.0.0",
+ "description" : "Artifact Version, usually 1.0.0"
+ },
+ "artifactDescription" : {
+ "type" : "string",
+ "example" : "",
+ "description" : "Artifact Description, usually empty"
+ },
+ "internalVersion" : {
+ "type" : "integer",
+ "format" : "int32",
+ "example" : null,
+ "description" : "Internal Version of CBA, usually null"
+ },
+ "createdDate" : {
+ "type" : "string",
+ "format" : "date-time",
+ "example" : "2020-11-19T10:34:56.000Z",
+ "description" : "Datetime of the creation of CBA in CDS"
+ },
+ "artifactName" : {
+ "type" : "string",
+ "example" : "pnf_netconf",
+ "description" : "Artifact Name, defined in Metadata"
+ },
+ "published" : {
+ "type" : "string",
+ "example" : "pnf_netconf",
+ "description" : "Artifact Name, defined in Metadata"
+ },
+ "updatedBy" : {
+ "type" : "string",
+ "example" : "Deutsche Telekom AG",
+ "description" : "Name of publisher, defined in Metadata"
+ },
+ "tags" : {
+ "type" : "string",
+ "example" : "test",
+ "description" : "Tags to identify the CBA, defined in Metadata"
+ }
+ }
+ },
+ "BootstrapRequest" : {
+ "type" : "object",
+ "required" : [ "loadCBA", "loadModelType", "loadResourceDictionary" ],
+ "properties" : {
+ "loadModelType" : {
+ "type" : "boolean",
+ "example" : true,
+ "description" : "Specifies if default model types should be loaded"
+ },
+ "loadResourceDictionary" : {
+ "type" : "boolean",
+ "example" : true,
+ "description" : "Specifies if default data dictionaries should be loaded"
+ },
+ "loadCBA" : {
+ "type" : "boolean",
+ "example" : true,
+ "description" : "Specifies if default blueprint models should be loaded"
+ }
+ }
+ },
+ "CapabilityAssignment" : {
+ "type" : "object",
+ "properties" : {
+ "attributes" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/JsonNode"
+ }
+ },
+ "properties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/JsonNode"
+ }
+ }
+ }
+ },
+ "ConstraintClause" : {
+ "type" : "object",
+ "properties" : {
+ "equal" : {
+ "$ref" : "#/definitions/JsonNode"
+ },
+ "length" : {
+ "$ref" : "#/definitions/JsonNode"
+ },
+ "pattern" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "type" : "string"
+ },
+ "greater_than" : {
+ "$ref" : "#/definitions/JsonNode"
+ },
+ "greater_or_equal" : {
+ "$ref" : "#/definitions/JsonNode"
+ },
+ "less_than" : {
+ "$ref" : "#/definitions/JsonNode"
+ },
+ "less_or_equal" : {
+ "$ref" : "#/definitions/JsonNode"
+ },
+ "in_range" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/JsonNode"
+ }
+ },
+ "valid_values" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/JsonNode"
+ }
+ },
+ "min_length" : {
+ "$ref" : "#/definitions/JsonNode"
+ },
+ "max_length" : {
+ "$ref" : "#/definitions/JsonNode"
+ }
+ }
+ },
+ "EntrySchema" : {
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "type" : "string"
+ },
+ "constraints" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/ConstraintClause"
+ }
+ }
+ }
+ },
+ "FilePart" : {
+ "type" : "object"
+ },
+ "Implementation" : {
+ "type" : "object",
+ "properties" : {
+ "primary" : {
+ "type" : "string"
+ },
+ "dependencies" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "timeout" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "lock" : {
+ "$ref" : "#/definitions/LockAssignment"
+ },
+ "operation_host" : {
+ "type" : "string"
+ }
+ }
+ },
+ "InterfaceAssignment" : {
+ "type" : "object",
+ "properties" : {
+ "operations" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/OperationAssignment"
+ }
+ },
+ "inputs" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/JsonNode"
+ }
+ }
+ }
+ },
+ "JsonNode" : {
+ "type" : "object",
+ "properties" : {
+ "valueNode" : {
+ "type" : "boolean"
+ },
+ "containerNode" : {
+ "type" : "boolean"
+ },
+ "missingNode" : {
+ "type" : "boolean"
+ },
+ "array" : {
+ "type" : "boolean"
+ },
+ "object" : {
+ "type" : "boolean"
+ },
+ "nodeType" : {
+ "type" : "string",
+ "enum" : [ "ARRAY", "BINARY", "BOOLEAN", "MISSING", "NULL", "NUMBER", "OBJECT", "POJO", "STRING" ]
+ },
+ "pojo" : {
+ "type" : "boolean"
+ },
+ "number" : {
+ "type" : "boolean"
+ },
+ "integralNumber" : {
+ "type" : "boolean"
+ },
+ "floatingPointNumber" : {
+ "type" : "boolean"
+ },
+ "short" : {
+ "type" : "boolean"
+ },
+ "int" : {
+ "type" : "boolean"
+ },
+ "long" : {
+ "type" : "boolean"
+ },
+ "float" : {
+ "type" : "boolean"
+ },
+ "double" : {
+ "type" : "boolean"
+ },
+ "bigDecimal" : {
+ "type" : "boolean"
+ },
+ "bigInteger" : {
+ "type" : "boolean"
+ },
+ "textual" : {
+ "type" : "boolean"
+ },
+ "boolean" : {
+ "type" : "boolean"
+ },
+ "null" : {
+ "type" : "boolean"
+ },
+ "binary" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "LockAssignment" : {
+ "type" : "object",
+ "properties" : {
+ "key" : {
+ "$ref" : "#/definitions/JsonNode"
+ },
+ "acquireTimeout" : {
+ "$ref" : "#/definitions/JsonNode"
+ }
+ }
+ },
+ "NodeFilterDefinition" : {
+ "type" : "object",
+ "properties" : {
+ "properties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/PropertyDefinition"
+ }
+ },
+ "capabilities" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "NodeTemplate" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "metadata" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "directives" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "properties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/JsonNode"
+ }
+ },
+ "attributes" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/JsonNode"
+ }
+ },
+ "capabilities" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/CapabilityAssignment"
+ }
+ },
+ "requirements" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/RequirementAssignment"
+ }
+ },
+ "interfaces" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/InterfaceAssignment"
+ }
+ },
+ "artifacts" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/ArtifactDefinition"
+ }
+ },
+ "copy" : {
+ "type" : "string"
+ },
+ "node_filter" : {
+ "$ref" : "#/definitions/NodeFilterDefinition"
+ }
+ }
+ },
+ "OperationAssignment" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "type" : "string"
+ },
+ "implementation" : {
+ "$ref" : "#/definitions/Implementation"
+ },
+ "inputs" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/JsonNode"
+ }
+ },
+ "outputs" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/JsonNode"
+ }
+ }
+ }
+ },
+ "Page" : {
+ "type" : "object",
+ "properties" : {
+ "totalPages" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "totalElements" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "number" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "size" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "numberOfElements" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "content" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ },
+ "sort" : {
+ "$ref" : "#/definitions/Sort"
+ },
+ "first" : {
+ "type" : "boolean"
+ },
+ "last" : {
+ "type" : "boolean"
+ },
+ "pageable" : {
+ "$ref" : "#/definitions/Pageable"
+ },
+ "empty" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "PageBlueprintModelSearch" : {
+ "type" : "object",
+ "properties" : {
+ "totalPages" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "totalElements" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "number" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "size" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "numberOfElements" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "content" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/BlueprintModelSearch"
+ }
+ },
+ "sort" : {
+ "$ref" : "#/definitions/Sort"
+ },
+ "first" : {
+ "type" : "boolean"
+ },
+ "last" : {
+ "type" : "boolean"
+ },
+ "pageable" : {
+ "$ref" : "#/definitions/Pageable"
+ },
+ "empty" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "Pageable" : {
+ "type" : "object",
+ "properties" : {
+ "paged" : {
+ "type" : "boolean"
+ },
+ "unpaged" : {
+ "type" : "boolean"
+ },
+ "pageNumber" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "pageSize" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "offset" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "sort" : {
+ "$ref" : "#/definitions/Sort"
+ }
+ }
+ },
+ "PropertyDefinition" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "type" : "string"
+ },
+ "required" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string"
+ },
+ "constraints" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/ConstraintClause"
+ }
+ },
+ "metadata" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "value" : {
+ "$ref" : "#/definitions/JsonNode"
+ },
+ "input-param" : {
+ "type" : "boolean"
+ },
+ "default" : {
+ "$ref" : "#/definitions/JsonNode"
+ },
+ "entry_schema" : {
+ "$ref" : "#/definitions/EntrySchema"
+ },
+ "external-schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "RequirementAssignment" : {
+ "type" : "object",
+ "properties" : {
+ "capability" : {
+ "type" : "string"
+ },
+ "node" : {
+ "type" : "string"
+ },
+ "relationship" : {
+ "type" : "string"
+ }
+ }
+ },
+ "ResourceConfigSnapshot" : {
+ "type" : "object",
+ "required" : [ "config_snapshot", "createdDate", "resourceId", "resourceType", "status" ],
+ "properties" : {
+ "resourceType" : {
+ "type" : "string",
+ "example" : "ServiceInstance",
+ "description" : "Resource type."
+ },
+ "resourceId" : {
+ "type" : "string",
+ "example" : "1",
+ "description" : "ID associated with the resource type in the inventory system."
+ },
+ "status" : {
+ "type" : "string",
+ "description" : "Status of the snapshot, either running or candidate.",
+ "enum" : [ "RUNNING", "CANDIDATE" ]
+ },
+ "config_snapshot" : {
+ "type" : "string",
+ "example" : "config_snapshot",
+ "description" : "Snapshot of the resource as retrieved from resource."
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "createdDate" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "Creation date of the snapshot."
+ }
+ }
+ },
+ "ResourceDefinition" : {
+ "type" : "object",
+ "required" : [ "group", "name", "property", "sources", "updated-by" ],
+ "properties" : {
+ "tags" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string",
+ "example" : "default-source",
+ "description" : "Name"
+ },
+ "property" : {
+ "description" : "Property",
+ "$ref" : "#/definitions/PropertyDefinition"
+ },
+ "group" : {
+ "type" : "string",
+ "example" : "default",
+ "description" : "Group"
+ },
+ "updated-by" : {
+ "type" : "string",
+ "example" : "example@onap.com",
+ "description" : "Updated by"
+ },
+ "sources" : {
+ "type" : "object",
+ "example" : "sources",
+ "description" : "Sources",
+ "additionalProperties" : {
+ "$ref" : "#/definitions/NodeTemplate"
+ }
+ }
+ }
+ },
+ "ResourceDictionary" : {
+ "type" : "object",
+ "required" : [ "dataType", "definition", "description", "entrySchema", "name", "resourceDictionaryGroup", "tags", "updatedBy" ],
+ "properties" : {
+ "name" : {
+ "type" : "string",
+ "example" : "sample-db-source",
+ "description" : "Name"
+ },
+ "dataType" : {
+ "type" : "string",
+ "example" : "string",
+ "description" : "Data type"
+ },
+ "entrySchema" : {
+ "type" : "string",
+ "example" : "dt-license-key",
+ "description" : "Entry schema"
+ },
+ "resourceDictionaryGroup" : {
+ "type" : "string",
+ "example" : "default",
+ "description" : "Resource dictionary group"
+ },
+ "definition" : {
+ "description" : "Definition",
+ "$ref" : "#/definitions/ResourceDefinition"
+ },
+ "description" : {
+ "type" : "string",
+ "example" : "demo_artifacts_version",
+ "description" : "Description"
+ },
+ "tags" : {
+ "type" : "string",
+ "example" : "hostname",
+ "description" : "Tags"
+ },
+ "creationDate" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "updatedBy" : {
+ "type" : "string",
+ "example" : "username",
+ "description" : "Updated by"
+ }
+ }
+ },
+ "ResourceResolution" : {
+ "type" : "object",
+ "required" : [ "artifactName", "blueprintName", "blueprintVersion", "createdDate", "dictionaryName", "dictionarySource", "dictionaryVersion", "name", "occurrence", "resolutionKey", "resourceId", "resourceType", "status", "value" ],
+ "properties" : {
+ "blueprintName" : {
+ "type" : "string",
+ "description" : "Name of the CBA."
+ },
+ "blueprintVersion" : {
+ "type" : "string",
+ "description" : "Version of the CBA."
+ },
+ "artifactName" : {
+ "type" : "string",
+ "description" : "Artifact name for which to retrieve a resolved resource."
+ },
+ "name" : {
+ "type" : "string",
+ "description" : "Name of the resource."
+ },
+ "value" : {
+ "type" : "string",
+ "description" : "Value of the resolution."
+ },
+ "status" : {
+ "type" : "string",
+ "description" : "Whether success of failure."
+ },
+ "resolutionKey" : {
+ "type" : "string",
+ "description" : "Resolution Key uniquely identifying the resolution of a given artifact within a CBA."
+ },
+ "resourceType" : {
+ "type" : "string",
+ "example" : "ServiceInstance",
+ "description" : "Resolution type."
+ },
+ "resourceId" : {
+ "type" : "string",
+ "description" : "ID associated with the resolution type in the inventory system."
+ },
+ "occurrence" : {
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "If resolution occurred multiple time, this field provides the index."
+ },
+ "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"
+ },
+ "createdDate" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "Creation date of the resolution."
+ }
+ }
+ },
+ "ResourceSourceMapping" : {
+ "type" : "object",
+ "properties" : {
+ "resourceSourceMappings" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "Sort" : {
+ "type" : "object",
+ "properties" : {
+ "sorted" : {
+ "type" : "boolean"
+ },
+ "unsorted" : {
+ "type" : "boolean"
+ },
+ "empty" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "TemplateResolution" : {
+ "type" : "object",
+ "required" : [ "artifactName", "blueprintName", "blueprintVersion", "createdDate", "occurrence", "resolutionKey", "resourceId", "resourceType", "result" ],
+ "properties" : {
+ "blueprintName" : {
+ "type" : "string",
+ "description" : "Name of the CBA."
+ },
+ "blueprintVersion" : {
+ "type" : "string",
+ "description" : "Version of the CBA."
+ },
+ "artifactName" : {
+ "type" : "string",
+ "description" : "Artifact name for which to retrieve a resolved resource."
+ },
+ "result" : {
+ "type" : "string",
+ "description" : "Rendered template."
+ },
+ "resolutionKey" : {
+ "type" : "string",
+ "description" : "Resolution Key uniquely identifying the resolution of a given artifact within a CBA."
+ },
+ "resourceType" : {
+ "type" : "string",
+ "example" : "ServiceInstance",
+ "description" : "Resolution type."
+ },
+ "resourceId" : {
+ "type" : "string",
+ "description" : "ID associated with the resolution type in the inventory system."
+ },
+ "occurrence" : {
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "If resolution occurred multiple time, this field provides the index."
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "createdDate" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "Creation date of the resolution."
+ }
+ }
+ },
+ "Unit" : {
+ "type" : "object"
+ },
+ "WorkFlowSpecRequest" : {
+ "type" : "object",
+ "required" : [ "blueprintName", "workflowName" ],
+ "properties" : {
+ "blueprintName" : {
+ "type" : "string",
+ "example" : "pnf_netconf",
+ "description" : "Name of the BLueprint"
+ },
+ "version" : {
+ "type" : "string"
+ },
+ "returnContent" : {
+ "type" : "string"
+ },
+ "workflowName" : {
+ "type" : "string",
+ "example" : "config-assign",
+ "description" : "Name of the Workflow"
+ },
+ "specType" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
}
\ No newline at end of file |