Merge pull request #31 from spiceai/jeadie/pub

Add `utoipa::ToSchema` to relevant types

Author: ewgenius

async-openai/src/client.rs

@@ -354,7 +354,8 @@ impl<C: Config> Client<C> {
     }
 
     /// Make a POST request to {path} and deserialize the response body
-    pub async fn post<I, O>(
+    #[allow(unused)]
+    pub(crate) async fn post<I, O>(
         &self,
         path: &str,
         request: I,
@@ -563,7 +564,8 @@ impl<C: Config> Client<C> {
     }
 
     /// Make HTTP POST request to receive SSE
-    pub async fn post_stream<I, O>(
+    #[allow(unused)]
+    pub(crate) async fn post_stream<I, O>(
         &self,
         path: &str,
         request: I,

async-openai/src/types/mcp/mcp_.rs

@@ -1,9 +1,10 @@
 use derive_builder::Builder;
 use serde::{Deserialize, Serialize};
+use utoipa::ToSchema;
 
 use crate::error::OpenAIError;
 
-#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
+#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, ToSchema)]
 #[serde(rename_all = "snake_case")]
 pub enum McpToolConnectorId {
     ConnectorDropbox,
@@ -16,7 +17,7 @@ pub enum McpToolConnectorId {
     ConnectorSharepoint,
 }
 
-#[derive(Debug, Serialize, Deserialize, Clone, Builder, PartialEq, Default)]
+#[derive(Debug, Serialize, Deserialize, Clone, Builder, PartialEq, Default, ToSchema)]
 #[builder(
     name = "MCPToolArgs",
     pattern = "mutable",
@@ -70,7 +71,7 @@ pub struct MCPTool {
     pub server_url: Option<String>,
 }
 
-#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
+#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, ToSchema)]
 #[serde(untagged)]
 pub enum MCPToolAllowedTools {
     /// A string array of allowed tool names
@@ -79,7 +80,7 @@ pub enum MCPToolAllowedTools {
     Filter(MCPToolFilter),
 }
 
-#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
+#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, ToSchema)]
 pub struct MCPToolFilter {
     /// Indicates whether or not a tool modifies data or is read-only.
     /// If an MCP server is annotated with [readOnlyHint](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
@@ -92,7 +93,7 @@ pub struct MCPToolFilter {
 }
 
 /// Approval policy or filter for MCP tools.
-#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
+#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, ToSchema)]
 #[serde(untagged)]
 pub enum MCPToolRequireApproval {
     /// Specify which of the MCP server's tools require approval. Can be
@@ -105,14 +106,14 @@ pub enum MCPToolRequireApproval {
     ApprovalSetting(MCPToolApprovalSetting),
 }
 
-#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
+#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, ToSchema)]
 #[serde(rename_all = "lowercase")]
 pub enum MCPToolApprovalSetting {
     Always,
     Never,
 }
 
-#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
+#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, ToSchema)]
 pub struct MCPToolApprovalFilter {
     /// A list of tools that always require approval.
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -122,7 +123,7 @@ pub struct MCPToolApprovalFilter {
     pub never: Option<MCPToolFilter>,
 }
 
-#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
+#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, ToSchema)]
 pub struct MCPListToolsTool {
     /// The JSON schema describing the tool's input.
     pub input_schema: serde_json::Value,

async-openai/src/types/metadata.rs

@@ -15,3 +15,9 @@ impl From<serde_json::Value> for Metadata {
         Self(value)
     }
 }
+
+impl Metadata {
+    pub fn as_value(&self) -> &serde_json::Value {
+        &self.0
+    }
+}