http_response_create.proto.json

{
  "runtimeName": "http::response::create",
  "runtimeParameterDefinitions": [
    {
      "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 Headers"
        }
      ],
      "description": [
        {
          "code": "en-US",
          "content": "A collection of key-value pairs containing additional response metadata."
        }
      ],
      "documentation": []
    },
    {
      "runtimeName": "payload",
      "defaultValue": null,
      "name": [
        {
          "code": "en-US",
          "content": "Request Body"
        }
      ],
      "description": [
        {
          "code": "en-US",
          "content": "Contains the response payload, such as JSON, XML, form data, or binary content, depending on the Content-Type header."
        }
      ],
      "documentation": []
    }
  ],
  "throwsError": false,
  "name": [
    {
      "code": "en-US",
      "content": "Create HTTP-Response"
    }
  ],
  "description": [
    {
      "code": "en-US",
      "content": "Creates an HTTP-Response object with the specified method, headers and payload."
    }
  ],
  "documentation": [],
  "alias": [
    {
      "code": "en-US",
      "content": "create;response;http"
    }
  ],
  "displayMessage": [
    {
      "code": "en-US",
      "content": "Create Http-Response with Method: ${http_method}, Headers: ${headers} and Payload: ${payload}"
    }
  ],
  "deprecationMessage": [],
  "displayIcon": "tabler:world-www",
  "signature": "<T>(http_status_code: HTTP_STATUS_CODE, headers: OBJECT<{}>, payload: T): HTTP_RESPONSE<T>",
  "linkedDataTypeIdentifiers": [
    "HTTP_STATUS_CODE",
    "OBJECT",
    "HTTP_RESPONSE"
  ]
}