diff options
| author |   JakobKrieg <jakob.krieg@bcmsolutions.de> | 2020-12-08 19:15:36 +0100 |
|---|---|---|
| committer | JakobKrieg <jakob.krieg@bcmsolutions.de> | 2020-12-08 19:15:40 +0100 |
| commit | eaa1ac9e51c6c87cd1f4dd1cf7ba2d070ed75979 (patch) | |
| tree | 1bd95cf78ee9093b171b569080d6e5b2b4a9b359 /docs | |
| parent | a4b721c3e9c4aa7c5342304a061dc5634935acd0 (diff) | |
CDS add API reference documentation
Issue-ID: CCSDK-3014
Change-Id: Id31270c287bdf23de5feb6666ca859d6cd5732c2
Signed-off-by: JakobKrieg <jakob.krieg@bcmsolutions.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-reference/bp-processor.rst | 185 | ||||
| -rw-r--r-- | docs/api-reference/media/bp-processor.postman_collection.json | 2702 | ||||
| -rw-r--r-- | docs/api-reference/media/cds-bp-processor-api-swagger.json | 837 | ||||
| -rw-r--r-- | docs/api-reference/media/cds-bp-processor-api-swagger.yaml | 714 | ||||
| -rw-r--r-- | docs/conf.py | 2 |
5 files changed, 4159 insertions, 281 deletions
diff --git a/docs/api-reference/bp-processor.rst b/docs/api-reference/bp-processor.rst index 2789825e0..31efc40fd 100644 --- a/docs/api-reference/bp-processor.rst +++ b/docs/api-reference/bp-processor.rst @@ -8,9 +8,10 @@ Blueprint Processor API Reference Introduction -------------- -This section shows all resources and endpoints which CDS BP processor currently provides with sample requests/responses, -parameter description and other information. If there is a new API and you want do document it, you can use this template -:download:`rst <api-doc-template.rst>`. +This section shows all resources and endpoints which CDS BP processor currently provides through a swagger file +which is automatically created during CDS build process by Swagger Maven Plugin. A corresponding Postman collection is +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 ----------------- @@ -20,7 +21,13 @@ Use Basic athentification with `ccsdkapps` as a username and password, in Header Download ------------ -You can find a postman collection including sample requests here: :download:`JSON <media/bp-processor.postman_collection.json>` +Here is the automatically created swagger file for CDS Blueprint Processor API: +:download:`cds-bp-processor-api-swagger.json <media/cds-bp-processor-api-swagger.json>` +:download:`cds-bp-processor-api-swagger.yaml <media/cds-bp-processor-api-swagger.yaml>` + +You can find a postman collection including sample requests for all endpoints here: +:download:`bp-processor.postman_collection.json <media/bp-processor.postman_collection.json>`. +Please keep the Postman Collection up-to-date for new endpoints. General Setup -------------- @@ -136,169 +143,13 @@ HTTP Status 202 OK } } -Blueprint Model Catalog API ----------------------------- - -Blueprint-model resource contains all Controller Blueprints Archive (CBA) packages which are available in CDS. -With blueprint-model API you can manage your CBAs. - -Bootstrap -~~~~~~~~~~~ - -POST ``/blueprint-model/bootstrap`` -.................................... - -Loads all Model Types, Resource Dictionaries and CBAs which are included in CDS by default. - - -Request -........... - -.. code-block:: curl - :caption: **sample request** - - curl --location --request POST 'http://localhost:8081/api/v1/blueprint-model/bootstrap' \ - --header 'Authorization: Basic Y2NzZGthcHBzOmNjc2RrYXBwcw==' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "loadModelType" : true, - "loadResourceDictionary" : true, - "loadCBA" : true - }' - -**Request Body Parameters:** - -.. list-table:: - :widths: 20 20 20 40 - :header-rows: 1 - - * - Parameter - - Type - - Required - - Description - * - loadModelType - - Boolean - - yes - - Specifies if default model types should be loaded - * - loadResourceDictionary - - Boolean - - Yes - - Specifies if default data dictionaries should be loaded - * - loadCBA - - Boolean - - Yes - - Specifies if default CBAs should be loaded - -Success Response -...................... - -HTTP Status 202 OK - - -Consumes -............ - -``application/json`` - - -Functional Description -.............................. - -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 Dictioniaries but this is not recommended. -The loaded CBAs are already enriched, that's why CBAs can be loaded even without Data Dictionaries or Model Types. If -validation of a CBA fails the CBA is skipped and the call is still executed successfully. You can find the error logs e.g. -in the console of an IDE. - - -Technical Description -........................... - -All Model Types which are loaded by bootstrap are in folder `/components/model-catalog/definition-type/starter-type`, -all Resource Dictionaries in `components/model-catalog/resource-dictionary/starter-dictionary`, all CBAs in -`model-catalog/blueprint-model/service-blueprint`. -**Called class/method:** ``org.onap.ccsdk.cds.blueprintsprocessor.designer.api.BlueprintModelController#bootstrap``. - -Related topics -.................. - -.. toctree:: - :maxdepth: 1 - - ../modelingconcepts/cba - ../modelingconcepts/data-dictionary - ../modelingconcepts/data-type - - -List all blueprint models -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -GET ``/blueprint-model`` -.............................. - -Lists all blueprint models which are saved in CDS. - -Request -........... - -.. code-block:: curl - :caption: **request** - - curl --location --request GET 'http://{{ip_adress}}:{{port}}/api/v1/blueprint-model' \ - --header 'Authorization: Basic Y2NzZGthcHBzOmNjc2RrYXBwcw==' - -Produces -........... - -``application/json`` - - -Success Response -...................... +API Reference +-------------- -HTTP Status 200 OK +.. warning:: + In the used Sphinx plugin `sphinxcontrib-swaggerdoc` some information of the swagger file is not + rendered completely, e.g. the request body. Use your favorite Swagger Editor and paste the swagger file + to get a complete view of the API reference, e.g. on https://editor.swagger.io/. -.. code-block:: json - :caption: **example response** - - [ - { - "blueprintModel": { - "id": "109e725d-5145-4f70-a2e7-ee6640e2fb5f", - "artifactUUId": null, - "artifactType": "SDNC_MODEL", - "artifactVersion": "1.0.0", - "artifactDescription": "", - "internalVersion": null, - "createdDate": "2020-11-09T19:00:20.000Z", - "artifactName": "vLB_CDS_RESTCONF", - "published": "Y", - "updatedBy": "DanielEmmarts>", - "tags": "vLB-CDS" - } - }, - { - "blueprintModel": { - "id": "5cce3804-09eb-473d-b513-81f8547a7240", - "artifactUUId": null, - "artifactType": "SDNC_MODEL", - "artifactVersion": "1.0.0", - "artifactDescription": "", - "internalVersion": null, - "createdDate": "2020-11-09T19:00:20.000Z", - "artifactName": "vLB_CDS", - "published": "Y", - "updatedBy": "TomKennedy>", - "tags": "vLB_CDS" - } - } - ] - -Technical Description -........................... - -Loads all Blueprint Models which are saved in the CDS database in table `BLUEPRINT_MODEL`. Unpublished and unproceeded -Blueprint Models are also included. -**Called class/method:** ``org.onap.ccsdk.cds.blueprintsprocessor.designer.api.BlueprintModelController#allBlueprintModel()``. +.. swaggerv2doc:: media/cds-bp-processor-api-swagger.json
\ No newline at end of file diff --git a/docs/api-reference/media/bp-processor.postman_collection.json b/docs/api-reference/media/bp-processor.postman_collection.json index 4dd1c5fe5..f2a9f1437 100644 --- a/docs/api-reference/media/bp-processor.postman_collection.json +++ b/docs/api-reference/media/bp-processor.postman_collection.json @@ -1,185 +1,2661 @@ { "info": { "_postman_id": "481808a1-8f9d-47b3-8e03-9302d22731d9", - "name": "Blueprints Processor API Reference Collection", + "name": " CDS Blueprint Processor API Reference", + "description": "Shows all resources and endpoints which CDS BP processor currently provides with sample requests/responses, parameter description and other information.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { - "name": "Get All Endpoints", - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "" + "name": "Blueprint Model Catalog API", + "item": [ + { + "name": "List all Blueprint Models", + "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/blueprint-model", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model" + ] + }, + "description": "Lists all blueprint models which are saved in CDS." + }, + "response": [] }, - "description": "Lists all endpoints from blueprints processor" - }, - "response": [] - }, - { - "name": "Get Blueprints", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "auth": { - "type": "basic", - "basic": [ - { - "key": "password", - "value": "ccsdkapps", - "type": "string" + { + "name": "Save a Blueprint Model", + "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": [ + { + "key": "file", + "type": "file", + "src": "/home/jakob/Downloads/cba.zip" + } + ] }, + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model" + ] + }, + "description": "Saves a blueprint model by the given file input. There is no validation of the attached CBA happening when this API is called." + }, + "response": [] + }, + { + "name": "Bootstrap CDS", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : true,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : true\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + }, + "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." + }, + "response": [ { - "key": "username", - "value": "ccsdkapps", - "type": "string" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" } ] }, - "method": "GET", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "", - "value": "", - "type": "text", - "disabled": true - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n\"loadModelType\" : true,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", - "options": { - "raw": {} - } - }, - "url": { - "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model", - "protocol": "http", - "host": [ - "{{host}}" - ], - "port": "{{port}}", - "path": [ - "api", - "v1", - "blueprint-model" - ] - } - }, - "response": [ { - "name": "CDS Bootstrap", - "originalRequest": { - "method": "POST", + "name": "Get a Blueprint Model by Name and Version", + "protocolProfileBehavior": { + "disabledSystemHeaders": {}, + "disableBodyPruning": true + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] + }, + "method": "GET", "header": [ { "key": "Content-Type", - "value": "application/json" + "value": "application/json", + "disabled": true }, { "key": "", - "value": "", "type": "text", + "value": "", "disabled": true } ], "body": { "mode": "raw", - "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "raw": "{\r\n\"loadModelType\" : true,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : true\r\n}", "options": { - "raw": {} + "raw": { + "language": "json" + } } }, "url": { - "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/download/by-name/pnf_netconf/version/1.0.0", "protocol": "http", "host": [ - "localhost" + "{{host}}" ], - "port": "8081", + "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", - "bootstrap" + "download", + "by-name", + "pnf_netconf", + "version", + "1.0.0" ] + }, + "description": "Get Meta-Data of a Blueprint Model by its name and version." + }, + "response": [ + { + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" } + ] + }, + { + "name": "Download a Blueprint Model by ID", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] + }, + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/download/416f241d-3ef9-4cb6-8834-956ae4f70b07", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "download", + "416f241d-3ef9-4cb6-8834-956ae4f70b07" + ] + }, + "description": "Gets the CBA of a blueprint model by its ID. Response can be saved to a file to download the CBA." + }, + "response": [ { - "key": "X-ONAP-RequestID", - "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Enrich a Blueprint Model", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "type": "file", + "src": "/home/jakob/Downloads/PNF_DEMO.zip" + } + ], + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/enrich", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "enrich" + ] }, + "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." + }, + "response": [ { - "key": "X-ONAP-InvocationID", - "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Enrich and publish a Blueprint Model", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "type": "file", + "src": "/home/jakob/Downloads/PNF_DEMO.zip" + } + ], + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/enrichandpublish", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "enrichandpublish" + ] + }, + "description": "Enriches the attached CBA, validates it and saves it in CDS if validation was successful." + }, + "response": [ { - "key": "X-ONAP-PartnerName", - "value": "cds-controller" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Search for Blueprints by a Keyword", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] + }, + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/meta-data/pnf_netconf", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "meta-data", + "pnf_netconf" + ] }, + "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." + }, + "response": [ { - "key": "Vary", - "value": "Origin" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Delete a Blueprint Model by Name", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] }, + "method": "DELETE", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/name/pnf_netconf/version/1.0.0", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "name", + "pnf_netconf", + "version", + "1.0.0" + ] + }, + "description": "Delete a blueprint model identified by its name and version from CDS." + }, + "response": [ { - "key": "Vary", - "value": "Access-Control-Request-Method" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Get Blueprints ordered", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] + }, + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/paged?limit=5&sort=DATE", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "paged" + ], + "query": [ + { + "key": "limit", + "value": "5" + }, + { + "key": "sort", + "value": "DATE" + } + ] }, + "description": "Lists all blueprint models which are saved in CDS in an ordered mode." + }, + "response": [ { - "key": "Vary", - "value": "Access-Control-Request-Headers" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Search for Blueprints by a Keyword in an ordered mode", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] + }, + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/paged/meta-data/test?limit=5&sort=DATE", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "paged", + "meta-data", + "test" + ], + "query": [ + { + "key": "limit", + "value": "5" + }, + { + "key": "sort", + "value": "DATE" + } + ] }, + "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." + }, + "response": [ { - "key": "Content-Type", - "value": "application/json" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Publish a Blueprint Model", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "type": "file", + "src": "/home/jakob/Downloads/cba.zip" + } + ], + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/publish", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "publish" + ] + }, + "description": "Validates the attached CBA file and saves it in CDS if validation was successful. CBA needs to be already enriched." + }, + "response": [ { - "key": "Content-Length", - "value": "0" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Search for a Blueprint by Tag", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] }, + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/search/test", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "search", + "test" + ] + }, + "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." + }, + "response": [ { - "key": "Cache-Control", - "value": "no-cache, no-store, max-age=0, must-revalidate" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Get Workflow Specification", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"blueprintName\" : \"vLB_CDS_KOTLIN\",\n \"workflowName\": \"config-assign\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/workflow-spec", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "workflow-spec" + ] + }, + "description": "Get the workflow of a blueprint identified by Blueprint and workflow name. Inputs, outputs and data types of workflow is returned." + }, + "response": [ { - "key": "Pragma", - "value": "no-cache" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Get Workflows of a Blueprint", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] }, + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/workflows/blueprint-name/vLB_CDS_KOTLIN/version/1.0.0", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "workflows", + "blueprint-name", + "vLB_CDS_KOTLIN", + "version", + "1.0.0" + ] + }, + "description": "Get all available workflows of a Blueprint by its name and version." + }, + "response": [ { - "key": "Expires", - "value": "0" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Get a Blueprint Model by ID", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] + }, + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/416f241d-3ef9-4cb6-8834-956ae4f70b07", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "416f241d-3ef9-4cb6-8834-956ae4f70b07" + ] }, + "description": "Get a blueprint model by its internally created ID." + }, + "response": [ { - "key": "X-Content-Type-Options", - "value": "nosniff" + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Delete a Blueprint Model by its ID", + "protocolProfileBehavior": { + "disabledSystemHeaders": {} + }, + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "ccsdkapps", + "type": "string" + }, + { + "key": "username", + "value": "ccsdkapps", + "type": "string" + } + ] }, + "method": "DELETE", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "disabled": true + }, + { + "key": "", + "type": "text", + "value": "", + "disabled": true + } + ], + "url": { + "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/416f241d-3ef9-4cb6-8834-956ae4f70b07", + "protocol": "http", + "host": [ + "{{host}}" + ], + "port": "{{port}}", + "path": [ + "api", + "v1", + "blueprint-model", + "416f241d-3ef9-4cb6-8834-956ae4f70b07" + ] + }, + "description": "Delete a blueprint model a a given ID. ID is the internally created ID of blueprint, not the name of blueprint." + }, + "response": [ + { + "name": "CDS Bootstrap", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "", + "value": "", + "type": "text", + "disabled": true + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", + "options": { + "raw": {} + } + }, + "url": { + "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8081", + "path": [ + "api", + "v1", + "blueprint-model", + "bootstrap" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-ONAP-RequestID", + "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" + }, + { + "key": "X-ONAP-InvocationID", + "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" + }, + { + "key": "X-ONAP-PartnerName", + "value": "cds-controller" + }, + { + "key": "Vary", + "value": "Origin" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Method" + }, + { + "key": "Vary", + "value": "Access-Control-Request-Headers" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Content-Length", + "value": "0" + }, + { + "key": "Cache-Control", + "value": "no-cache, no-store, max-age=0, must-revalidate" + }, + { + "key": "Pragma", + "value": "no-cache" + }, + { + "key": "Expires", + "value": "0" + }, + { + "key": "X-Content-Type-Options", + "value": "nosniff" + }, + { + "key": "X-Frame-Options", + "value": "DENY" + }, + { + "key": "X-XSS-Protection", + "value": "1 ; mode=block" + }, + { + "key": "Referrer-Policy", + "value": "no-referrer" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "description": "Manages all blueprint models which are available in CDS", + "protocolProfileBehavior": {} + }, + { + "name": "List all endpoints", + "request": { + "auth": { + "type": "basic", + "basic": [ { - "key": "X-Frame-Options", - "value": "DENY" + "key": "username", + "value": "ccsdkapps", + "type": "string" }, { - "key": "X-XSS-Protection", - "value": "1 ; mode=block" + "key": "password", + "value": "ccsdkapps", + "type": "string" }, { - "key": "Referrer-Policy", - "value": "no-referrer" + "key": "showPassword", + "value": false, + "type": "boolean" } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "http://{{host}}:{{port}}/actuator/mappings", + "protocol": "http", + "host": [ + "{{host}}" ], - "cookie": [], - "body": "" - } - ] + "port": "{{port}}", + "path": [ + "actuator", + "mappings" + ] + }, + "description": "Lists all available endpoints from blueprints processor API." + }, + "response": [] } ], "event": [ @@ -206,12 +2682,12 @@ ], "variable": [ { - "id": "3d10b67b-766c-40e4-bfc4-a2b913414336", + "id": "86d601d8-fded-49c0-8870-545b57019003", "key": "host", "value": "localhost" }, { - "id": "ef57cc1c-95c6-4679-8da1-42d356a060fe", + "id": "b53854bd-6fbb-42bb-a001-9b77a3883cf8", "key": "port", "value": "8081" } diff --git a/docs/api-reference/media/cds-bp-processor-api-swagger.json b/docs/api-reference/media/cds-bp-processor-api-swagger.json new file mode 100644 index 000000000..a9f596527 --- /dev/null +++ b/docs/api-reference/media/cds-bp-processor-api-swagger.json @@ -0,0 +1,837 @@ +{ + "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" : { + "type" : "object" + } + }, + "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" : { + "type" : "object" + } + }, + "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" : { + "type" : "object" + } + }, + "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" : "object" + } + } + } + } + }, + "/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" : { + "type" : "object" + } + } + } + } + }, + "/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" : "object" + } + } + } + } + }, + "/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", + "required" : false, + "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" : { + "type" : "object" + } + }, + "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" + } + } + } + } +}
\ No newline at end of file diff --git a/docs/api-reference/media/cds-bp-processor-api-swagger.yaml b/docs/api-reference/media/cds-bp-processor-api-swagger.yaml new file mode 100644 index 000000000..e16e22cad --- /dev/null +++ b/docs/api-reference/media/cds-bp-processor-api-swagger.yaml @@ -0,0 +1,714 @@ +--- +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" + parameters: [] + 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: + type: "object" + 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: + type: "object" + 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: + type: "object" + 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: "object" + /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: + type: "object" + /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: "object" + /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" + required: false + 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: + type: "object" + 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" diff --git a/docs/conf.py b/docs/conf.py index de84a196d..f3087f901 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,7 +7,7 @@ linkcheck_ignore = [ 'http://localhost', ] -extensions = ['sphinx_tabs.tabs'] +extensions = ['sphinx_tabs.tabs', 'sphinxcontrib.swaggerdoc'] intersphinx_mapping = {} |