Merge "adding the basic running steps for CDS in README file"
[ccsdk/cds.git] / docs / datadictionary / restsourcecode.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (C) 2019 IBM.
4
5 Rest Source Code:
6 =================
7
8 .. code-block:: json
9    :linenos:
10    
11    "description": "This is Rest Resource Source Node Type",
12    "version": "1.0.0",
13    "properties": {
14      "type": {
15        "required": false,
16        "type": "string",
17        "default": "JSON",
18        "constraints": [
19          {
20            "valid_values": [
21              "JSON"
22            ]
23          }
24        ]
25      },
26      "verb": {
27        "required": false,
28        "type": "string",
29        "default": "GET",
30        "constraints": [
31          {
32            "valid_values": [
33              "GET", "POST", "DELETE", "PUT"
34            ]
35          }
36        ]
37      },
38      "payload": {
39        "required": false,
40        "type": "string",
41        "default": ""
42      },
43      "endpoint-selector": {
44        "required": false,
45        "type": "string"
46      },
47      "url-path": {
48        "required": true,
49        "type": "string"
50      },
51      "path": {
52        "required": true,
53        "type": "string"
54      },
55      "expression-type": {
56        "required": false,
57        "type": "string",
58        "default": "JSON_PATH",
59        "constraints": [
60          {
61            "valid_values": [
62              "JSON_PATH",
63              "JSON_POINTER"
64            ]
65          }
66        ]
67      },
68      "input-key-mapping": {
69        "required": false,
70        "type": "map",
71        "entry_schema": {
72          "type": "string"
73        }
74      },
75      "output-key-mapping": {
76        "required": false,
77        "type": "map",
78        "entry_schema": {
79          "type": "string"
80        }
81      },
82      "key-dependencies": {
83        "required": true,
84        "type": "list",
85        "entry_schema": {
86          "type": "string"
87        }
88      }
89    },
90    "derived_from": "tosca.nodes.ResourceSource"