mirror of
https://github.com/openai/codex.git
synced 2026-11-10 21:00:47 +00:00
joeytrasatti-openai
2635431edb
## Why `thread/attachment/list` lists attachments for a known thread. Clients also need to find the threads associated with a given attachment identity. ## What changed Add `thread/attachmentOwner/list` to return owning thread IDs and archive status for an exact `attachmentType` and `identityKey`. Support cursor pagination and an optional `archived` filter, including both archived and non-archived threads by default. Wire the request through the thread store and update documentation, protocol schemas, and generated TypeScript and Python types. The lookup is limited to the configured thread store and reports current membership, not an atomic resource-cleanup check. ## Testing Extend app-server integration tests to cover exact type-and-key matching, multiple owners, archive filtering, and invalid cursor rejection. GitOrigin-RevId: 30f4a20e00243d0023246d465a9b95213b3adeb6
143 lines
4.9 KiB
Rust
143 lines
4.9 KiB
Rust
//! Wire contracts for managing the current set of attachments on a thread.
|
|
|
|
use crate::JsonSchema;
|
|
use crate::TS;
|
|
use serde::Deserialize;
|
|
use serde::Serialize;
|
|
use serde_json::Value as JsonValue;
|
|
|
|
/// An independently persisted attachment associated with a thread.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export_to = "v2/")]
|
|
pub struct ThreadAttachment {
|
|
pub id: String,
|
|
pub attachment_type: String,
|
|
pub identity_key: String,
|
|
pub payload: JsonValue,
|
|
#[ts(type = "number")]
|
|
pub created_at: i64,
|
|
}
|
|
|
|
/// Parameters for creating or locating an attachment on its owning thread.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export_to = "v2/")]
|
|
pub struct ThreadAttachmentAddParams {
|
|
pub thread_id: String,
|
|
pub attachment_type: String,
|
|
pub identity_key: String,
|
|
pub payload: JsonValue,
|
|
}
|
|
|
|
/// Result of attempting to associate an attachment with a thread.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq, Eq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(rename_all = "camelCase", export_to = "v2/")]
|
|
pub enum ThreadAttachmentAddOutcome {
|
|
Created,
|
|
Existing,
|
|
}
|
|
|
|
/// The created or existing attachment.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export_to = "v2/")]
|
|
pub struct ThreadAttachmentAddResponse {
|
|
pub outcome: ThreadAttachmentAddOutcome,
|
|
pub attachment: ThreadAttachment,
|
|
}
|
|
|
|
/// Parameters for listing attachments from one thread.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, Default, PartialEq, Eq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export_to = "v2/")]
|
|
pub struct ThreadAttachmentListParams {
|
|
pub thread_id: String,
|
|
#[ts(optional = nullable)]
|
|
pub cursor: Option<String>,
|
|
#[ts(optional = nullable)]
|
|
pub limit: Option<u32>,
|
|
}
|
|
|
|
/// One page of attachments associated with the requested thread.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export_to = "v2/")]
|
|
pub struct ThreadAttachmentListResponse {
|
|
pub data: Vec<ThreadAttachment>,
|
|
pub next_cursor: Option<String>,
|
|
}
|
|
|
|
/// Parameters for deleting an attachment by its stable thread-local identity.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export_to = "v2/")]
|
|
pub struct ThreadAttachmentRemoveParams {
|
|
pub thread_id: String,
|
|
pub attachment_type: String,
|
|
pub identity_key: String,
|
|
}
|
|
|
|
/// Successful deletion does not return additional attachment data.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, Default, PartialEq, Eq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export_to = "v2/")]
|
|
pub struct ThreadAttachmentRemoveResponse {}
|
|
|
|
/// The persisted attachment change represented by a notification.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq, Eq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(rename_all = "camelCase", export_to = "v2/")]
|
|
pub enum ThreadAttachmentOperation {
|
|
Created,
|
|
Deleted,
|
|
}
|
|
|
|
/// Notification published after a thread attachment is created or deleted.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export_to = "v2/")]
|
|
pub struct ThreadAttachmentUpdatedNotification {
|
|
pub thread_id: String,
|
|
pub attachment_type: String,
|
|
pub identity_key: String,
|
|
pub attachment_id: String,
|
|
pub operation: ThreadAttachmentOperation,
|
|
}
|
|
|
|
/// Parameters for reverse lookup by attachment identity within this server's store.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, Default, PartialEq, Eq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export_to = "v2/")]
|
|
pub struct ThreadAttachmentOwnerListParams {
|
|
pub attachment_type: String,
|
|
pub identity_key: String,
|
|
/// Omitted or null returns all matches; false returns non-archived threads only.
|
|
#[ts(optional = nullable)]
|
|
pub archived: Option<bool>,
|
|
#[ts(optional = nullable)]
|
|
pub cursor: Option<String>,
|
|
#[ts(optional = nullable)]
|
|
pub limit: Option<u32>,
|
|
}
|
|
|
|
/// A thread that currently owns an attachment with the requested identity.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export_to = "v2/")]
|
|
pub struct ThreadAttachmentOwner {
|
|
pub thread_id: String,
|
|
/// Whether the owning thread is archived, not whether it is currently executing a turn.
|
|
pub archived: bool,
|
|
}
|
|
|
|
/// One page of matching owners, including threads without their own user messages.
|
|
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, JsonSchema, TS)]
|
|
#[serde(rename_all = "camelCase")]
|
|
#[ts(export_to = "v2/")]
|
|
pub struct ThreadAttachmentOwnerListResponse {
|
|
pub data: Vec<ThreadAttachmentOwner>,
|
|
pub next_cursor: Option<String>,
|
|
}
|