Schema

Schema name: RealtimeClientEventResponseCancel

{
  "(resource) realtime > (model) response_cancel_event > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel",
    "docstring": "Send this event to cancel an in-progress response. The server will respond \nwith a `response.done` event with a status of `response.status=cancelled`. If \nthere is no response to cancel, the server will respond with an error. It's safe\nto call `response.cancel` even if no response is in progress, an error will be\nreturned the session will remain unaffected.\n",
    "ident": "ResponseCancelEvent",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "type"
        },
        {
          "ident": "event_id"
        },
        {
          "ident": "response_id"
        }
      ]
    },
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) response_cancel_event > (schema) > (property) type",
      "(resource) realtime > (model) response_cancel_event > (schema) > (property) event_id",
      "(resource) realtime > (model) response_cancel_event > (schema) > (property) response_id"
    ]
  },
  "(resource) realtime > (model) response_cancel_event > (schema) > (property) type": {
    "kind": "HttpDeclProperty",
    "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/type",
    "deprecated": false,
    "key": "type",
    "docstring": "The event type, must be `response.cancel`.",
    "type": {
      "kind": "HttpTypeUnion",
      "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/type",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "response.cancel"
        }
      ]
    },
    "optional": false,
    "nullable": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) response_cancel_event > (schema) > (property) type > (member) 0"
    ]
  },
  "(resource) realtime > (model) response_cancel_event > (schema) > (property) event_id": {
    "kind": "HttpDeclProperty",
    "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/event_id",
    "deprecated": false,
    "key": "event_id",
    "docstring": "Optional client-generated ID used to identify this event.",
    "type": {
      "kind": "HttpTypeString"
    },
    "constraints": {
      "maxLength": 512
    },
    "optional": true,
    "nullable": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) response_cancel_event > (schema) > (property) response_id": {
    "kind": "HttpDeclProperty",
    "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/response_id",
    "deprecated": false,
    "key": "response_id",
    "docstring": "A specific response ID to cancel - if not provided, will cancel an \nin-progress response in the default conversation.\n",
    "type": {
      "kind": "HttpTypeString"
    },
    "optional": true,
    "nullable": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) response_cancel_event > (schema) > (property) type > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "response.cancel"
    }
  }
}