code0-definition/definitions/http/runtime_definition/response/http_response_create.json at 87c06ea4296304f5978a4546eb98737887f35cdd · 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
110
111
112
113
114
{
  "runtime_name": "http::response::create",
  "runtime_parameter_definitions": [
    {
      "data_type_identifier": {
        "type": {
          "DataTypeIdentifier": "HTTP_STATUS_CODE"
        }
      },
      "runtime_name": "http_status_code",
      "default_value": null,
      "name": [
        {
          "code": "en-US",
          "content": "HTTP Status Code"
        }
      ],
      "description": [
        {
          "code": "en-US",
          "content": "Represents the numeric status code returned by the server in response to an HTTP request."
        }
      ],
      "documentation": [
        {
          "code": "en-US",
          "content": "Indicates the outcome of an HTTP request. Common codes include 200 (OK), 201 (Created), 400 (Bad Request), 401 (Unauthorized), 404 (Not Found), and 500 (Internal Server Error)."
        }
      ]
    },
    {
      "data_type_identifier": {
        "type": {
          "DataTypeIdentifier": "HTTP_HEADER_MAP"
        }
      },
      "runtime_name": "headers",
      "default_value": null,
      "name": [
        {
          "code": "en-US",
          "content": "HTTP Headers"
        }
      ],
      "description": [
        {
          "code": "en-US",
          "content": "A collection of key-value pairs containing additional request metadata."
        }
      ],
      "documentation": [
        {
          "code": "en-US",
          "content": "Optional headers that can define content type, authorization, cookies, caching policies, and more."
        }
      ]
    },
    {
      "data_type_identifier": {
        "type": {
          "GenericKey": "P"
        }
      },
      "runtime_name": "payload",
      "default_value": null,
      "name": [
        {
          "code": "en-US",
          "content": "Request Body"
        }
      ],
      "description": [
        {
          "code": "en-US",
          "content": "The data to include in the body of the request, typically used with methods like POST or PUT."
        }
      ],
      "documentation": [
        {
          "code": "en-US",
          "content": "Contains the request payload, such as JSON, XML, form data, or binary content, depending on the Content-Type header."
        }
      ]
    }
  ],
  "return_type_identifier": {
    "type": {
      "DataTypeIdentifier": "HTTP_RESPONSE"
    }
  },
  "throws_error": false,
  "generic_keys": [
    "P"
  ],
  "name": [
    {
      "code": "en-US",
      "content": "Construct HTTP Response"
    }
  ],
  "description": [
    {
      "code": "en-US",
      "content": "Builds an HTTP response object using the specified status code, headers, and optional response body."
    }
  ],
  "documentation": [
    {
      "code": "en-US",
      "content": "Creates a complete HTTP response object to be returned from a server. The response includes a status code, headers, and an optional body containing the response content."
    }
  ],
  "deprecation_message": []
}