Skip to content

Commit 9d7f564

Browse files
raphael-goetzraphael-goetz
committed
feat: added definitions
1 parent 16e8a35 commit 9d7f564

File tree

18 files changed

+8801
-0
lines changed

18 files changed

+8801
-0
lines changed

‎definitions/rest/data_type/array.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
```json
2+
{
3+
"variant": "ARRAY",
4+
"identifier": "HTTP_HEADER_MAP",
5+
"name": [
6+
{
7+
"code": "en-US",
8+
"content": "HTTP Headers"
9+
}
10+
],
11+
"rules": [
12+
{
13+
"contains_type": {
14+
"type": "HTTP_HEADER_ENTRY"
15+
}
16+
}
17+
],
18+
"parent_type_identifier": "ARRAY"
19+
}
20+
```

‎definitions/rest/data_type/object.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
```json
2+
{
3+
"variant": "OBJECT",
4+
"identifier": "HTTP_HEADER_ENTRY",
5+
"name": [
6+
{
7+
"code": "en-US",
8+
"content": "HTTP Header Entry"
9+
}
10+
],
11+
"rules": [
12+
{
13+
"contains_key": {
14+
"key": "key",
15+
"type": "TEXT"
16+
}
17+
},
18+
{
19+
"contains_key": {
20+
"key": "value",
21+
"type": "TEXT"
22+
}
23+
}
24+
],
25+
"parent_type_identifier": "OBJECT"
26+
}
27+
```
28+
29+
```json
30+
{
31+
"variant": "OBJECT",
32+
"identifier": "HTTP_REQUEST_OBJECT",
33+
"name": [
34+
{
35+
"code": "en-US",
36+
"content": "HTTP Request",
37+
}
38+
],
39+
"rules": [
40+
{
41+
"contains_key": {
42+
"key": "method",
43+
"type": "HTTP_METHOD"
44+
}
45+
},
46+
{
47+
"contains_key": {
48+
"key": "url",
49+
"type": "HTTP_URL"
50+
}
51+
},
52+
{
53+
"contains_key": {
54+
"key": "body",
55+
"type": "OBJECT"
56+
}
57+
},
58+
{
59+
"contains_key": {
60+
"key": "headers",
61+
"type": "HTTP_HEADER_MAP"
62+
}
63+
}
64+
],
65+
"parent_type_identifier": "OBJECT"
66+
}
67+
```
68+
69+
```json
70+
{
71+
"variant": "OBJECT",
72+
"identifier": "HTTP_RESPONSE_OBJECT",
73+
"name": [
74+
{
75+
"code": "en-US",
76+
"content": "HTTP Response"
77+
}
78+
],
79+
"rules": [
80+
{
81+
"contains_key": {
82+
"key": "headers",
83+
"type": "HTTP_HEADER_MAP"
84+
}
85+
},
86+
{
87+
"contains_key": {
88+
"key": "body",
89+
"type": "OBJECT"
90+
}
91+
}
92+
],
93+
"parent_type_identifier": "OBJECT"
94+
}
95+
```

‎definitions/rest/data_type/type.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
2+
## HTTP Method - Type
3+
```json
4+
{
5+
"variant": "TYPE",
6+
"identifier": "HTTP_METHOD",
7+
"name": [
8+
{
9+
"code": "en-US",
10+
"content": "HTTP Method",
11+
}
12+
],
13+
"rules": [
14+
{
15+
"item_of_collection": {
16+
"items": [ "GET", "POST", "PUT", "DELETE", "PATCH", "HEAD"]
17+
}
18+
}
19+
],
20+
"parent_type_identifier": null
21+
}
22+
```
23+
24+
## HTTP URL - Type
25+
26+
```json
27+
{
28+
"variant": "TYPE",
29+
"identifier": "HTTP_URL",
30+
"name": [
31+
{
32+
"code": "en-US",
33+
"content": "HTTP Route",
34+
}
35+
],
36+
"rules": [
37+
{
38+
"regex": {
39+
"pattern": "/^\/\w+(?:[.:~-]\w+)*(?:\/\w+(?:[.:~-]\w+)*)*$/"
40+
}
41+
}
42+
],
43+
"parent_type_identifier": null
44+
}
45+
```

‎definitions/rest/flow_type/flow_type.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Rest FlowType
2+
3+
```json
4+
{
5+
"identifier": "REST"
6+
"name": [
7+
{
8+
"code": "en-US",
9+
"content": "Rest Endpoint"
10+
}
11+
],
12+
"description": [
13+
{
14+
"code": "en-US",
15+
"content": "A REST API is a web service that lets clients interact with data on a server using standard HTTP methods like GET, POST, PUT, and DELETE, usually returning results in JSON format."
16+
}
17+
],
18+
"settings": [],
19+
"input_type_identifier": "HTTP_REQUEST_OBJECT",
20+
"return_type_identifier": "HTTP_RESPONSE_OBJECT"
21+
}
22+
```

‎definitions/standard/data_type/array.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# All Data_Types of the Array Variant
2+
3+
## ARRAY
4+
```json
5+
{
6+
"variant": 5,
7+
"identifier": "ARRAY",
8+
"name": [
9+
{
10+
"code": "en-US",
11+
"content": "Generic Array"
12+
}
13+
],
14+
"rules": [
15+
{
16+
"contains_type": {
17+
"data_type_identifier": {
18+
"generic_key": "T"
19+
}
20+
}
21+
}
22+
],
23+
"generic_keys": ["T"],
24+
"parent_type_identifier": null
25+
}
26+
```

‎definitions/standard/data_type/node.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
## PREDICATE
2+
```json
3+
{
4+
"identifier": "PREDICATE",
5+
"variant": 7,
6+
"rules": [
7+
{
8+
"return_type": {
9+
"data_type_identifier": "BOOLEAN"
10+
}
11+
},
12+
{
13+
"input_type": [
14+
{
15+
"data_type_identifier": {
16+
"generic_key": "T"
17+
},
18+
"input_identifier": "predicate"
19+
}
20+
]
21+
}
22+
],
23+
"generic_keys": ["T"],
24+
"name": [
25+
{
26+
"code": "en-US",
27+
"content": "Predicate"
28+
}
29+
]
30+
}
31+
```
32+
33+
## CONSUMER
34+
```json
35+
{
36+
"identifier": "CONSUMER",
37+
"variant": 7,
38+
"rules": [
39+
{
40+
"input_type": [
41+
{
42+
"data_type_identifier": {
43+
"generic_key": "T"
44+
},
45+
"input_identifier": "consumer"
46+
}
47+
]
48+
}
49+
],
50+
"generic_keys": ["T"],
51+
"name": [
52+
{
53+
"code": "en-US",
54+
"content": "Consumer"
55+
}
56+
]
57+
58+
}
59+
```
60+
61+
## TRANSFORM
62+
```json
63+
{
64+
"identifier": "TRANSFORM",
65+
"variant": 7,
66+
"rules": [
67+
{
68+
"return_type": {
69+
"data_type_identifier": {
70+
"generic_key": "R"
71+
}
72+
}
73+
},
74+
{
75+
"input_type": [
76+
{
77+
"data_type_identifier": {
78+
"generic_key": "I"
79+
},
80+
"input_identifier": "transform"
81+
}
82+
]
83+
}
84+
],
85+
"generic_keys": ["I", "R"],
86+
"name": [
87+
{
88+
"code": "en-US",
89+
"content": "Transform"
90+
}
91+
]
92+
93+
}
94+
```
95+
96+
## COMPARITOR
97+
```json
98+
{
99+
"identifier": "COMPARITOR",
100+
"variant": 7,
101+
"rules": [
102+
{
103+
"return_type": {
104+
"data_type_identifier": {
105+
"data_type_identifier": "NUMBER"
106+
}
107+
}
108+
},
109+
{
110+
"input_type": [
111+
{
112+
"data_type_identifier": {
113+
"generic_key": "I"
114+
},
115+
"input_identifier": "left"
116+
},
117+
{
118+
"data_type_identifier": {
119+
"generic_key": "I"
120+
},
121+
"input_identifier": "right"
122+
}
123+
]
124+
}
125+
],
126+
"generic_keys": ["I"],
127+
"name": [
128+
{
129+
"code": "en-US",
130+
"content": "Comparitor"
131+
}
132+
]
133+
}
134+
```

0 commit comments

Comments
 (0)