code0-definition/definitions/draco_rest/functions/rest_control_respond.proto.json at 2fb779153f0043c8a2e943bbf133ba9b6fae791e · code0-tech/code0-definition · 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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
{
  "runtime_definition_name": "rest::control::respond",
  "runtimeName": "rest::control::respond",
  "parameter_definitions": [
    {
      "runtimeName": "http_status_code",
      "defaultValue": null,
      "name": [
        {
          "code": "en-US",
          "content": "HTTP Status Code"
        }
      ],
      "description": [
        {
          "code": "en-US",
          "content": "An HTTP status code is a three-digit number (100–599) indicating the result of a request (e.g., 200, 404, 500)."
        }
      ],
      "documentation": []
    },
    {
      "runtimeName": "headers",
      "defaultValue": null,
      "name": [
        {
          "code": "en-US",
          "content": "HTTP response headers"
        }
      ],
      "description": [
        {
          "code": "en-US",
          "content": "A collection of key-value pairs containing additional response metadata."
        }
      ],
      "documentation": []
    },
    {
      "runtimeName": "http_schema",
      "defaultValue": null,
      "name": [
        {
          "code": "en-US",
          "content": "Content Type"
        }
      ],
      "description": [
        {
          "code": "en-US",
          "content": "Specifies the MIME type of the response payload, such as application/json, application/xml, or text/plain. This determines the expected format of the payload parameter."
        }
      ],
      "documentation": []
    },
    {
      "runtimeName": "payload",
      "defaultValue": null,
      "name": [
        {
          "code": "en-US",
          "content": "Response Payload"
        }
      ],
      "description": [
        {
          "code": "en-US",
          "content": "Contains the response payload. For application/json the value must be an OBJECT, for all other content types a plain string is expected."
        }
      ],
      "documentation": []
    }
  ],
  "deprecationMessage": [],
  "throwsError": false,
  "name": [
    {
      "code": "en-US",
      "content": "Respond"
    }
  ],
  "description": [
    {
      "code": "en-US",
      "content": "Processes an HTTP response and returns it to the requesting client. This function typically completes the HTTP request–response cycle by delivering the server’s final output, such as headers, status codes, and body content, back to the client."
    }
  ],
  "documentation": [],
  "alias": [
    {
      "code": "en-US",
      "content": "respond;control;http"
    }
  ],
  "displayMessage": [
    {
      "code": "en-US",
      "content": "Sends response with status ${http_status_code} and payload ${payload}"
    }
  ],
  "displayIcon": "tabler:cube-send",
  "signature": "<S extends HTTP_SCHEMA>(http_status_code: HTTP_STATUS_CODE, headers: OBJECT<{}>, http_schema: S, payload: HTTP_PAYLOAD<S>): void",
  "linkedDataTypeIdentifiers": [
    "HTTP_STATUS_CODE",
    "OBJECT",
    "HTTP_SCHEMA",
    "HTTP_PAYLOAD"
  ]
}