CDS API reference add request classes

[ccsdk/cds.git] / docs / api-reference / media / bp-processor.postman_collection.json

diff --git a/docs/api-reference/media/bp-processor.postman_collection.json b/docs/api-reference/media/bp-processor.postman_collection.json
index f2a9f14..0e62117 100644 (file)
--- a/docs/api-reference/media/bp-processor.postman_collection.json
+++ b/docs/api-reference/media/bp-processor.postman_collection.json
@@ -317,6 +317,169 @@
                                                                }
                                                        }
                                                },
+                                               "url": {
+                                                       "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/by-name/pnf_netconf/version/1.0.0",
+                                                       "protocol": "http",
+                                                       "host": [
+                                                               "{{host}}"
+                                                       ],
+                                                       "port": "{{port}}",
+                                                       "path": [
+                                                               "api",
+                                                               "v1",
+                                                               "blueprint-model",
+                                                               "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",
+                                       "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/download/by-name/pnf_netconf/version/1.0.0",
                                                        "protocol": "http",
@@ -335,7 +498,7 @@
                                                                "1.0.0"
                                                        ]
                                                },
-                                               "description": "Get Meta-Data of a Blueprint Model by its name and version."
+                                               "description": "Gets the CBA of a blueprint model by its name and version. Response can be saved to a file to download the CBA."
                                        },
                                        "response": [
                                                {
@@ -482,7 +645,7 @@
                                                        }
                                                ],
                                                "url": {
-                                                       "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/download/416f241d-3ef9-4cb6-8834-956ae4f70b07",
+                                                       "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/download/44471683-4446-4ed9-8b27-fac6a8f81e5e",
                                                        "protocol": "http",
                                                        "host": [
                                                                "{{host}}"
@@ -493,7 +656,7 @@
                                                                "v1",
                                                                "blueprint-model",
                                                                "download",
-                                                               "416f241d-3ef9-4cb6-8834-956ae4f70b07"
+                                                               "44471683-4446-4ed9-8b27-fac6a8f81e5e"
                                                        ]
                                                },
                                                "description": "Gets the CBA of a blueprint model by its ID. Response can be saved to a file to download the CBA."
@@ -2682,12 +2845,12 @@
        ],
        "variable": [
                {
-                       "id": "86d601d8-fded-49c0-8870-545b57019003",
+                       "id": "59f58f5b-ee64-490b-be39-09983d888dd8",
                        "key": "host",
                        "value": "localhost"
                },
                {
-                       "id": "b53854bd-6fbb-42bb-a001-9b77a3883cf8",
+                       "id": "284f1750-2dd3-4fa4-aade-cccd91d53cc7",
                        "key": "port",
                        "value": "8081"
                }