From dc59e944df932349d1878072f2ba461e013d7820 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 29 Nov 2024 15:18:12 +0000 Subject: [PATCH] feat: Updated OpenAPI spec --- ...AppClient.AppPublicServiceCreateAgent.g.cs | 20 ++---- ...AppClient.AppPublicServiceUpdateAgent.g.cs | 19 +++--- ...AppClient.AppPublicServiceCreateAgent.g.cs | 18 ++--- ...AppClient.AppPublicServiceUpdateAgent.g.cs | 16 ++--- .../Instill.Models.AIAgentAppMetadata.g.cs | 30 +++------ .../Generated/Instill.Models.Agent.g.cs | 26 ++----- .../Instill.Models.CreateAgentBody.g.cs | 32 ++++----- .../Instill.Models.CreateAgentResponse.g.cs | 2 - .../Instill.Models.ListAgentsResponse.g.cs | 6 +- .../Instill.Models.ListToolsResponse.g.cs | 6 +- .../Instill.Models.UpdateAgentBody.g.cs | 35 +++++----- .../Instill.Models.UpdateAgentResponse.g.cs | 2 - src/libs/Instill/openapi.yaml | 67 ++++++++++--------- 13 files changed, 111 insertions(+), 168 deletions(-) diff --git a/src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceCreateAgent.g.cs b/src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceCreateAgent.g.cs index 06b830d..4cf10c8 100644 --- a/src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceCreateAgent.g.cs +++ b/src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceCreateAgent.g.cs @@ -226,18 +226,10 @@ partial void ProcessAppPublicServiceCreateAgentResponseContent( /// Creates an agent. /// /// - /// - /// The agent display name. - /// - /// - /// The agent description. - /// - /// - /// The agent tags. - /// - /// - /// The agent metadata. - /// + /// + /// + /// + /// /// The token to cancel the operation with /// [global::System.Diagnostics.CodeAnalysis.Experimental(diagnosticId: "INSTILL_ALPHA_001")] @@ -246,7 +238,7 @@ partial void ProcessAppPublicServiceCreateAgentResponseContent( string? displayName = default, string? description = default, global::System.Collections.Generic.IList? tags = default, - global::Instill.AIAgentAppMetadata? aiAgentApp = default, + global::Instill.AIAgentAppMetadata? aiAgentMetadata = default, global::System.Threading.CancellationToken cancellationToken = default) { var __request = new global::Instill.CreateAgentBody @@ -254,7 +246,7 @@ partial void ProcessAppPublicServiceCreateAgentResponseContent( DisplayName = displayName, Description = description, Tags = tags, - AiAgentApp = aiAgentApp, + AiAgentMetadata = aiAgentMetadata, }; return await AppPublicServiceCreateAgentAsync( diff --git a/src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceUpdateAgent.g.cs b/src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceUpdateAgent.g.cs index 87b13cd..e8f9695 100644 --- a/src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceUpdateAgent.g.cs +++ b/src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceUpdateAgent.g.cs @@ -233,31 +233,28 @@ partial void ProcessAppPublicServiceUpdateAgentResponseContent( /// /// /// - /// - /// The agent description. - /// - /// - /// The agent tags. - /// - /// - /// The agent metadata. - /// + /// + /// + /// + /// /// The token to cancel the operation with /// [global::System.Diagnostics.CodeAnalysis.Experimental(diagnosticId: "INSTILL_ALPHA_001")] public async global::System.Threading.Tasks.Task AppPublicServiceUpdateAgentAsync( string namespaceId, string agentUid, + string? displayName = default, string? description = default, global::System.Collections.Generic.IList? tags = default, - global::Instill.AIAgentAppMetadata? aiAgentApp = default, + global::Instill.AIAgentAppMetadata? aiAgentMetadata = default, global::System.Threading.CancellationToken cancellationToken = default) { var __request = new global::Instill.UpdateAgentBody { + DisplayName = displayName, Description = description, Tags = tags, - AiAgentApp = aiAgentApp, + AiAgentMetadata = aiAgentMetadata, }; return await AppPublicServiceUpdateAgentAsync( diff --git a/src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceCreateAgent.g.cs b/src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceCreateAgent.g.cs index 6a7349f..ac6bf5a 100644 --- a/src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceCreateAgent.g.cs +++ b/src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceCreateAgent.g.cs @@ -23,18 +23,10 @@ public partial interface IAppClient /// Creates an agent. /// /// - /// - /// The agent display name. - /// - /// - /// The agent description. - /// - /// - /// The agent tags. - /// - /// - /// The agent metadata. - /// + /// + /// + /// + /// /// The token to cancel the operation with /// [global::System.Diagnostics.CodeAnalysis.Experimental(diagnosticId: "INSTILL_ALPHA_001")] @@ -43,7 +35,7 @@ public partial interface IAppClient string? displayName = default, string? description = default, global::System.Collections.Generic.IList? tags = default, - global::Instill.AIAgentAppMetadata? aiAgentApp = default, + global::Instill.AIAgentAppMetadata? aiAgentMetadata = default, global::System.Threading.CancellationToken cancellationToken = default); } } \ No newline at end of file diff --git a/src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceUpdateAgent.g.cs b/src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceUpdateAgent.g.cs index 262726b..c7096b5 100644 --- a/src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceUpdateAgent.g.cs +++ b/src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceUpdateAgent.g.cs @@ -26,24 +26,20 @@ public partial interface IAppClient /// /// /// - /// - /// The agent description. - /// - /// - /// The agent tags. - /// - /// - /// The agent metadata. - /// + /// + /// + /// + /// /// The token to cancel the operation with /// [global::System.Diagnostics.CodeAnalysis.Experimental(diagnosticId: "INSTILL_ALPHA_001")] global::System.Threading.Tasks.Task AppPublicServiceUpdateAgentAsync( string namespaceId, string agentUid, + string? displayName = default, string? description = default, global::System.Collections.Generic.IList? tags = default, - global::Instill.AIAgentAppMetadata? aiAgentApp = default, + global::Instill.AIAgentAppMetadata? aiAgentMetadata = default, global::System.Threading.CancellationToken cancellationToken = default); } } \ No newline at end of file diff --git a/src/libs/Instill/Generated/Instill.Models.AIAgentAppMetadata.g.cs b/src/libs/Instill/Generated/Instill.Models.AIAgentAppMetadata.g.cs index 6ef5879..ee18e38 100644 --- a/src/libs/Instill/Generated/Instill.Models.AIAgentAppMetadata.g.cs +++ b/src/libs/Instill/Generated/Instill.Models.AIAgentAppMetadata.g.cs @@ -9,31 +9,31 @@ namespace Instill public sealed partial class AIAgentAppMetadata { /// - /// The instructions for the AI agent app. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("instructions")] public string? Instructions { get; set; } /// - /// The tools(pipelines) that the AI agent app can use. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("tools")] public global::System.Collections.Generic.IList? Tools { get; set; } /// - /// The catalog uids that the AI agent app can use. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("catalogUids")] public global::System.Collections.Generic.IList? CatalogUids { get; set; } /// - /// The AI agent app top k. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("chunkTopK")] public int? ChunkTopK { get; set; } /// - /// The AI agent chunk weight. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("chunkWeight")] public float? ChunkWeight { get; set; } @@ -47,21 +47,11 @@ public sealed partial class AIAgentAppMetadata /// /// Initializes a new instance of the class. /// - /// - /// The instructions for the AI agent app. - /// - /// - /// The tools(pipelines) that the AI agent app can use. - /// - /// - /// The catalog uids that the AI agent app can use. - /// - /// - /// The AI agent app top k. - /// - /// - /// The AI agent chunk weight. - /// + /// + /// + /// + /// + /// [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] public AIAgentAppMetadata( string? instructions, diff --git a/src/libs/Instill/Generated/Instill.Models.Agent.g.cs b/src/libs/Instill/Generated/Instill.Models.Agent.g.cs index 4989c9a..d4154d3 100644 --- a/src/libs/Instill/Generated/Instill.Models.Agent.g.cs +++ b/src/libs/Instill/Generated/Instill.Models.Agent.g.cs @@ -15,33 +15,31 @@ public sealed partial class Agent public string? AgentUid { get; set; } /// - /// The agent display name. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("displayName")] [global::System.Text.Json.Serialization.JsonRequired] public required string DisplayName { get; set; } /// - /// The agent description. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("description")] public string? Description { get; set; } /// - /// The namespace of the agent.
/// Included only in responses ///
[global::System.Text.Json.Serialization.JsonPropertyName("namespaceUid")] public string? NamespaceUid { get; set; } /// - /// The agent tags. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("tags")] public global::System.Collections.Generic.IList? Tags { get; set; } /// - /// The agent metadata.
/// Included only in responses ///
[global::System.Text.Json.Serialization.JsonPropertyName("aiAgentMetadata")] @@ -54,14 +52,12 @@ public sealed partial class Agent public string? CreatorUid { get; set; } /// - /// The creation time of the agent.
/// Included only in responses ///
[global::System.Text.Json.Serialization.JsonPropertyName("createTime")] public global::System.DateTime? CreateTime { get; set; } /// - /// The last update time of the agent.
/// Included only in responses ///
[global::System.Text.Json.Serialization.JsonPropertyName("updateTime")] @@ -79,32 +75,22 @@ public sealed partial class Agent /// /// Included only in responses /// - /// - /// The agent display name. - /// - /// - /// The agent description. - /// + /// + /// /// - /// The namespace of the agent.
/// Included only in responses /// - /// - /// The agent tags. - /// + /// /// - /// The agent metadata.
/// Included only in responses /// /// /// Included only in responses /// /// - /// The creation time of the agent.
/// Included only in responses /// /// - /// The last update time of the agent.
/// Included only in responses /// [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Instill/Generated/Instill.Models.CreateAgentBody.g.cs b/src/libs/Instill/Generated/Instill.Models.CreateAgentBody.g.cs index 5a3abed..263f67d 100644 --- a/src/libs/Instill/Generated/Instill.Models.CreateAgentBody.g.cs +++ b/src/libs/Instill/Generated/Instill.Models.CreateAgentBody.g.cs @@ -9,28 +9,28 @@ namespace Instill public sealed partial class CreateAgentBody { /// - /// The agent display name. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("displayName")] public string? DisplayName { get; set; } /// - /// The agent description. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("description")] public string? Description { get; set; } /// - /// The agent tags. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("tags")] public global::System.Collections.Generic.IList? Tags { get; set; } /// - /// The agent metadata. + /// /// - [global::System.Text.Json.Serialization.JsonPropertyName("aiAgentApp")] - public global::Instill.AIAgentAppMetadata? AiAgentApp { get; set; } + [global::System.Text.Json.Serialization.JsonPropertyName("aiAgentMetadata")] + public global::Instill.AIAgentAppMetadata? AiAgentMetadata { get; set; } /// /// Additional properties that are not explicitly defined in the schema @@ -41,29 +41,21 @@ public sealed partial class CreateAgentBody /// /// Initializes a new instance of the class. /// - /// - /// The agent display name. - /// - /// - /// The agent description. - /// - /// - /// The agent tags. - /// - /// - /// The agent metadata. - /// + /// + /// + /// + /// [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] public CreateAgentBody( string? displayName, string? description, global::System.Collections.Generic.IList? tags, - global::Instill.AIAgentAppMetadata? aiAgentApp) + global::Instill.AIAgentAppMetadata? aiAgentMetadata) { this.DisplayName = displayName; this.Description = description; this.Tags = tags; - this.AiAgentApp = aiAgentApp; + this.AiAgentMetadata = aiAgentMetadata; } /// diff --git a/src/libs/Instill/Generated/Instill.Models.CreateAgentResponse.g.cs b/src/libs/Instill/Generated/Instill.Models.CreateAgentResponse.g.cs index 445840b..9412505 100644 --- a/src/libs/Instill/Generated/Instill.Models.CreateAgentResponse.g.cs +++ b/src/libs/Instill/Generated/Instill.Models.CreateAgentResponse.g.cs @@ -9,7 +9,6 @@ namespace Instill public sealed partial class CreateAgentResponse { /// - /// The created agent.
/// Included only in responses ///
[global::System.Text.Json.Serialization.JsonPropertyName("agent")] @@ -25,7 +24,6 @@ public sealed partial class CreateAgentResponse /// Initializes a new instance of the class. ///
/// - /// The created agent.
/// Included only in responses /// [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Instill/Generated/Instill.Models.ListAgentsResponse.g.cs b/src/libs/Instill/Generated/Instill.Models.ListAgentsResponse.g.cs index 6d97074..d6735b5 100644 --- a/src/libs/Instill/Generated/Instill.Models.ListAgentsResponse.g.cs +++ b/src/libs/Instill/Generated/Instill.Models.ListAgentsResponse.g.cs @@ -9,7 +9,7 @@ namespace Instill public sealed partial class ListAgentsResponse { /// - /// The agents. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("agents")] public global::System.Collections.Generic.IList? Agents { get; set; } @@ -23,9 +23,7 @@ public sealed partial class ListAgentsResponse /// /// Initializes a new instance of the class. /// - /// - /// The agents. - /// + /// [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] public ListAgentsResponse( global::System.Collections.Generic.IList? agents) diff --git a/src/libs/Instill/Generated/Instill.Models.ListToolsResponse.g.cs b/src/libs/Instill/Generated/Instill.Models.ListToolsResponse.g.cs index f8c0ed6..48186c5 100644 --- a/src/libs/Instill/Generated/Instill.Models.ListToolsResponse.g.cs +++ b/src/libs/Instill/Generated/Instill.Models.ListToolsResponse.g.cs @@ -9,7 +9,7 @@ namespace Instill public sealed partial class ListToolsResponse { /// - /// The tools. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("tools")] public global::System.Collections.Generic.IList? Tools { get; set; } @@ -23,9 +23,7 @@ public sealed partial class ListToolsResponse /// /// Initializes a new instance of the class. /// - /// - /// The tools. - /// + /// [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] public ListToolsResponse( global::System.Collections.Generic.IList? tools) diff --git a/src/libs/Instill/Generated/Instill.Models.UpdateAgentBody.g.cs b/src/libs/Instill/Generated/Instill.Models.UpdateAgentBody.g.cs index 238e7ac..7ce84a2 100644 --- a/src/libs/Instill/Generated/Instill.Models.UpdateAgentBody.g.cs +++ b/src/libs/Instill/Generated/Instill.Models.UpdateAgentBody.g.cs @@ -9,22 +9,28 @@ namespace Instill public sealed partial class UpdateAgentBody { /// - /// The agent description. + /// + /// + [global::System.Text.Json.Serialization.JsonPropertyName("displayName")] + public string? DisplayName { get; set; } + + /// + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("description")] public string? Description { get; set; } /// - /// The agent tags. + /// /// [global::System.Text.Json.Serialization.JsonPropertyName("tags")] public global::System.Collections.Generic.IList? Tags { get; set; } /// - /// The agent metadata. + /// /// - [global::System.Text.Json.Serialization.JsonPropertyName("aiAgentApp")] - public global::Instill.AIAgentAppMetadata? AiAgentApp { get; set; } + [global::System.Text.Json.Serialization.JsonPropertyName("aiAgentMetadata")] + public global::Instill.AIAgentAppMetadata? AiAgentMetadata { get; set; } /// /// Additional properties that are not explicitly defined in the schema @@ -35,24 +41,21 @@ public sealed partial class UpdateAgentBody /// /// Initializes a new instance of the class. /// - /// - /// The agent description. - /// - /// - /// The agent tags. - /// - /// - /// The agent metadata. - /// + /// + /// + /// + /// [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] public UpdateAgentBody( + string? displayName, string? description, global::System.Collections.Generic.IList? tags, - global::Instill.AIAgentAppMetadata? aiAgentApp) + global::Instill.AIAgentAppMetadata? aiAgentMetadata) { + this.DisplayName = displayName; this.Description = description; this.Tags = tags; - this.AiAgentApp = aiAgentApp; + this.AiAgentMetadata = aiAgentMetadata; } /// diff --git a/src/libs/Instill/Generated/Instill.Models.UpdateAgentResponse.g.cs b/src/libs/Instill/Generated/Instill.Models.UpdateAgentResponse.g.cs index 74cc21f..58409e0 100644 --- a/src/libs/Instill/Generated/Instill.Models.UpdateAgentResponse.g.cs +++ b/src/libs/Instill/Generated/Instill.Models.UpdateAgentResponse.g.cs @@ -9,7 +9,6 @@ namespace Instill public sealed partial class UpdateAgentResponse { /// - /// The updated agent.
/// Included only in responses ///
[global::System.Text.Json.Serialization.JsonPropertyName("agent")] @@ -25,7 +24,6 @@ public sealed partial class UpdateAgentResponse /// Initializes a new instance of the class. ///
/// - /// The updated agent.
/// Included only in responses /// [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Instill/openapi.yaml b/src/libs/Instill/openapi.yaml index bfaff04..171d937 100644 --- a/src/libs/Instill/openapi.yaml +++ b/src/libs/Instill/openapi.yaml @@ -394,7 +394,7 @@ paths: parameters: - name: namespaceId in: path - description: The app's owner(namespaces). + description: namespace id required: true schema: type: string @@ -426,7 +426,7 @@ paths: parameters: - name: namespaceId in: path - description: The app's owner(namespaces). + description: namespace id required: true schema: type: string @@ -466,13 +466,13 @@ paths: parameters: - name: namespaceId in: path - description: The app's owner(namespaces). + description: namespace id required: true schema: type: string - name: agentUid in: path - description: The agent uid. + description: agent uid required: true schema: type: string @@ -511,13 +511,13 @@ paths: parameters: - name: namespaceId in: path - description: The app's owner(namespaces). + description: namespace id required: true schema: type: string - name: agentUid in: path - description: The agent uid. + description: agent uid required: true schema: type: string @@ -1002,7 +1002,7 @@ paths: parameters: - name: namespaceId in: path - description: The app's owner(namespaces). + description: namespace id required: true schema: type: string @@ -6240,25 +6240,25 @@ components: type: object properties: instructions: + title: instructions type: string - description: The instructions for the AI agent app. tools: + title: tools(pipelines) type: array items: $ref: '#/components/schemas/Tool' - description: The tools(pipelines) that the AI agent app can use. catalogUids: + title: catalog uids type: array items: type: string - description: The catalog uids that the AI agent app can use. chunkTopK: + title: AI agent app top k type: integer - description: The AI agent app top k. format: int32 chunkWeight: + title: AI agent chunk weight type: number - description: The AI agent chunk weight. format: float description: AIAgentAppMetadata represents the metadata for the AI agent app. AIAssistantAppMetadata: @@ -6285,37 +6285,37 @@ components: type: string readOnly: true displayName: + title: agent display name type: string - description: The agent display name. description: + title: agent description type: string - description: The agent description. namespaceUid: + title: namespace uid type: string - description: The namespace of the agent. readOnly: true tags: + title: agent tags type: array items: type: string - description: The agent tags. aiAgentMetadata: + title: agent metadata allOf: - $ref: '#/components/schemas/AIAgentAppMetadata' - description: The agent metadata. readOnly: true creatorUid: title: creator uid type: string readOnly: true createTime: + title: creation time type: string - description: The creation time of the agent. format: date-time readOnly: true updateTime: + title: last update time type: string - description: The last update time of the agent. format: date-time readOnly: true description: Agent represents a agent. @@ -7165,28 +7165,28 @@ components: type: object properties: displayName: + title: agent display name type: string - description: The agent display name. description: + title: agent description type: string - description: The agent description. tags: + title: agent tags type: array items: type: string - description: The agent tags. - aiAgentApp: + aiAgentMetadata: + title: agent metadata allOf: - $ref: '#/components/schemas/AIAgentAppMetadata' - description: The agent metadata. description: CreateAgentRequest represents a request to create a agent. CreateAgentResponse: type: object properties: agent: + title: created agent allOf: - $ref: '#/components/schemas/Agent' - description: The created agent. readOnly: true description: CreateAgentResponse represents a response for creating a agent. CreateAppBody: @@ -8107,10 +8107,10 @@ components: type: object properties: agents: + title: agents type: array items: $ref: '#/components/schemas/Agent' - description: The agents. description: ListAgentsResponse represents a response for listing agents. ListAppsResponse: type: object @@ -8811,10 +8811,10 @@ components: type: object properties: tools: + title: tools type: array items: $ref: '#/components/schemas/Tool' - description: The tools. description: ListToolsResponse represents a response for listing tools. ListUserMembershipsResponse: type: object @@ -10602,26 +10602,29 @@ components: UpdateAgentBody: type: object properties: + displayName: + title: agent display name + type: string description: + title: agent description type: string - description: The agent description. tags: + title: agent tags type: array items: type: string - description: The agent tags. - aiAgentApp: + aiAgentMetadata: + title: agent metadata allOf: - $ref: '#/components/schemas/AIAgentAppMetadata' - description: The agent metadata. description: UpdateAgentRequest represents a request to update a agent. UpdateAgentResponse: type: object properties: agent: + title: updated agent allOf: - $ref: '#/components/schemas/Agent' - description: The updated agent. readOnly: true description: UpdateAgentResponse represents a response for updating a agent. UpdateAppBody: