rest_control_respond.proto.json

{
  "runtimeName": "rest::control::respond",
  "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 response 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": "Response Payload"
        }
      ],
      "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": []
    }
  ],
  "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-sent",
  "signature": "<T>(http_status_code: HTTP_STATUS_CODE, headers: OBJECT<{}>, payload: T): void",
  "linkedDataTypeIdentifiers": [
    "HTTP_STATUS_CODE",
    "OBJECT"
  ]
}