http-json-meta-protocol/meta-file.json at main · mapikit/http-json-meta-protocol · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
{
  "name": "http-json-meta-protocol",
  "entrypoint": "./dist/entrypoint.js",
  "configurationFormat": {
    "port": { "type": "number", "required": true },
    "host": { "type": "string", "required": true },
    "enableCors": { "type": "boolean" },
    "corsConfig": { "type": "object", "subtype": {
      "origin": { "type": "string", "required": true },
      "optionsSuccessStatus": { "type": "number", "required": true },
      "allowedHeaders": { "type": "string", "required": false }
    }},
    "cookieSecret": { "type": "string" },
    "routePrefix": { "type": "string" },
    "routes": { "type": "array", "required": true, "subtype": {
      "route": { "type": "string", "required": true },
      "businessOperation": { "type": "string", "required": true },
      "method": { "type": "enum", "subtype": [ "GET", "PUT", "POST", "PATCH", "DELETE" ], "required": true },
      "inputMapConfiguration": { "type": "array", "required": true, "subtype": {
        "origin": { "type": "enum", "required": true, "subtype": [ "route", "queryParams", "headers", "body" ] },
        "originPath": { "type": "string", "required": true },
        "targetPath": { "type": "string", "required": true }
      }},
      "resultMapConfiguration": { "type": "object", "required": true, "subtype": {
        "statusCode": [{ "type": "string", "required": true }, { "type": "number", "required": true }],
        "headers": { "type": "array", "required": true, "subtype": "cloudedObject" },
        "body": { "type": "cloudedObject", "required": true },
        "cookies": { "type": "array", "subtype": {
          "namePath": { "type": "string", "required": true },
          "dataPath": { "type": "string", "required": true },
          "signed": { "type": "boolean", "required": false },
          "httpOnly": { "type": "boolean", "required": false },
          "path": { "type": "string", "required": false }
        }}
      }},
      "middlewares": { "type": "array", "subtype": {
        "businessOperation": { "type": "string", "required": true },
        "inputMapConfiguration": { "type": "array", "required": true, "subtype": {
          "origin": { "type": "enum", "required": true, "subtype": [ "route", "queryParams", "headers", "body" ] },
          "originPath": { "type": "string", "required": true },
          "targetPath": { "type": "string", "required": true }
        }},
        "injectMapConfiguration": { "type":"array", "subtype": {
          "originPath": { "type": "string", "required": true },
          "targetPath": { "type": "string", "required": true }
        }},
        "interceptMapConfiguration": { "required": false, "type": "object", "subtype": {
          "shouldInterceptPath": { "type": "string", "required": true },
          "statusCode": [{ "type": "string", "required": true }, { "type": "number", "required": true }],
          "headers": { "type": "array", "required": true, "subtype": "cloudedObject" },
          "body": { "type": "cloudedObject", "required": true },
          "cookies": { "type": "array", "subtype": {
            "namePath": { "type": "string", "required": true },
            "dataPath": { "type": "string", "required": true },
            "signed": { "type": "boolean", "required": false },
            "httpOnly": { "type": "boolean", "required": false },
            "path": { "type": "string", "required": false }
          }}
        }}
      }}
    }}
  },
  "permissions": [
    { "entity": "bopFunctions", "permissions": ["get_function"] }
  ]
}