Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat:Enhance OpenAPI Specification with Improved Documentation and Clarity #61

Merged
merged 1 commit into from
Nov 29, 2024
Merged

feat:Enhance OpenAPI Specification with Improved Documentation and Clarity #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 6 additions & 14 deletions src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceCreateAgent.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,18 +226,10 @@ partial void ProcessAppPublicServiceCreateAgentResponseContent(
/// Creates an agent.
/// </summary>
/// <param name="namespaceId"></param>
/// <param name="displayName">
/// The agent display name.
/// </param>
/// <param name="description">
/// The agent description.
/// </param>
/// <param name="tags">
/// The agent tags.
/// </param>
/// <param name="aiAgentApp">
/// The agent metadata.
/// </param>
/// <param name="displayName"></param>
/// <param name="description"></param>
/// <param name="tags"></param>
/// <param name="aiAgentMetadata"></param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
[global::System.Diagnostics.CodeAnalysis.Experimental(diagnosticId: "INSTILL_ALPHA_001")]
Expand All @@ -246,15 +238,15 @@ partial void ProcessAppPublicServiceCreateAgentResponseContent(
string? displayName = default,
string? description = default,
global::System.Collections.Generic.IList<string>? tags = default,
global::Instill.AIAgentAppMetadata? aiAgentApp = default,
global::Instill.AIAgentAppMetadata? aiAgentMetadata = default,
global::System.Threading.CancellationToken cancellationToken = default)
{
var __request = new global::Instill.CreateAgentBody
{
DisplayName = displayName,
Description = description,
Tags = tags,
AiAgentApp = aiAgentApp,
AiAgentMetadata = aiAgentMetadata,
};

return await AppPublicServiceCreateAgentAsync(
Expand Down
19 changes: 8 additions & 11 deletions src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceUpdateAgent.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,31 +233,28 @@ partial void ProcessAppPublicServiceUpdateAgentResponseContent(
/// </summary>
/// <param name="namespaceId"></param>
/// <param name="agentUid"></param>
/// <param name="description">
/// The agent description.
/// </param>
/// <param name="tags">
/// The agent tags.
/// </param>
/// <param name="aiAgentApp">
/// The agent metadata.
/// </param>
/// <param name="displayName"></param>
/// <param name="description"></param>
/// <param name="tags"></param>
/// <param name="aiAgentMetadata"></param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
[global::System.Diagnostics.CodeAnalysis.Experimental(diagnosticId: "INSTILL_ALPHA_001")]
public async global::System.Threading.Tasks.Task<global::Instill.UpdateAgentResponse> AppPublicServiceUpdateAgentAsync(
string namespaceId,
string agentUid,
string? displayName = default,
string? description = default,
global::System.Collections.Generic.IList<string>? 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(
Expand Down
18 changes: 5 additions & 13 deletions src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceCreateAgent.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,10 @@ public partial interface IAppClient
/// Creates an agent.
/// </summary>
/// <param name="namespaceId"></param>
/// <param name="displayName">
/// The agent display name.
/// </param>
/// <param name="description">
/// The agent description.
/// </param>
/// <param name="tags">
/// The agent tags.
/// </param>
/// <param name="aiAgentApp">
/// The agent metadata.
/// </param>
/// <param name="displayName"></param>
/// <param name="description"></param>
/// <param name="tags"></param>
/// <param name="aiAgentMetadata"></param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
[global::System.Diagnostics.CodeAnalysis.Experimental(diagnosticId: "INSTILL_ALPHA_001")]
Expand All @@ -43,7 +35,7 @@ public partial interface IAppClient
string? displayName = default,
string? description = default,
global::System.Collections.Generic.IList<string>? tags = default,
global::Instill.AIAgentAppMetadata? aiAgentApp = default,
global::Instill.AIAgentAppMetadata? aiAgentMetadata = default,
global::System.Threading.CancellationToken cancellationToken = default);
}
}
16 changes: 6 additions & 10 deletions src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceUpdateAgent.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,24 +26,20 @@ public partial interface IAppClient
/// </summary>
/// <param name="namespaceId"></param>
/// <param name="agentUid"></param>
/// <param name="description">
/// The agent description.
/// </param>
/// <param name="tags">
/// The agent tags.
/// </param>
/// <param name="aiAgentApp">
/// The agent metadata.
/// </param>
/// <param name="displayName"></param>
/// <param name="description"></param>
/// <param name="tags"></param>
/// <param name="aiAgentMetadata"></param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
[global::System.Diagnostics.CodeAnalysis.Experimental(diagnosticId: "INSTILL_ALPHA_001")]
global::System.Threading.Tasks.Task<global::Instill.UpdateAgentResponse> AppPublicServiceUpdateAgentAsync(
string namespaceId,
string agentUid,
string? displayName = default,
string? description = default,
global::System.Collections.Generic.IList<string>? tags = default,
global::Instill.AIAgentAppMetadata? aiAgentApp = default,
global::Instill.AIAgentAppMetadata? aiAgentMetadata = default,
global::System.Threading.CancellationToken cancellationToken = default);
}
}
30 changes: 10 additions & 20 deletions src/libs/Instill/Generated/Instill.Models.AIAgentAppMetadata.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,31 @@ namespace Instill
public sealed partial class AIAgentAppMetadata
{
/// <summary>
/// The instructions for the AI agent app.
///
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("instructions")]
public string? Instructions { get; set; }

/// <summary>
/// The tools(pipelines) that the AI agent app can use.
///
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("tools")]
public global::System.Collections.Generic.IList<global::Instill.Tool>? Tools { get; set; }

/// <summary>
/// The catalog uids that the AI agent app can use.
///
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("catalogUids")]
public global::System.Collections.Generic.IList<string>? CatalogUids { get; set; }

/// <summary>
/// The AI agent app top k.
///
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("chunkTopK")]
public int? ChunkTopK { get; set; }

/// <summary>
/// The AI agent chunk weight.
///
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("chunkWeight")]
public float? ChunkWeight { get; set; }
Expand All @@ -47,21 +47,11 @@ public sealed partial class AIAgentAppMetadata
/// <summary>
/// Initializes a new instance of the <see cref="AIAgentAppMetadata" /> class.
/// </summary>
/// <param name="instructions">
/// The instructions for the AI agent app.
/// </param>
/// <param name="tools">
/// The tools(pipelines) that the AI agent app can use.
/// </param>
/// <param name="catalogUids">
/// The catalog uids that the AI agent app can use.
/// </param>
/// <param name="chunkTopK">
/// The AI agent app top k.
/// </param>
/// <param name="chunkWeight">
/// The AI agent chunk weight.
/// </param>
/// <param name="instructions"></param>
/// <param name="tools"></param>
/// <param name="catalogUids"></param>
/// <param name="chunkTopK"></param>
/// <param name="chunkWeight"></param>
[global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]
public AIAgentAppMetadata(
string? instructions,
Expand Down
26 changes: 6 additions & 20 deletions src/libs/Instill/Generated/Instill.Models.Agent.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,31 @@ public sealed partial class Agent
public string? AgentUid { get; set; }

/// <summary>
/// The agent display name.
///
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("displayName")]
[global::System.Text.Json.Serialization.JsonRequired]
public required string DisplayName { get; set; }

/// <summary>
/// The agent description.
///
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("description")]
public string? Description { get; set; }

/// <summary>
/// The namespace of the agent.<br/>
/// Included only in responses
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("namespaceUid")]
public string? NamespaceUid { get; set; }

/// <summary>
/// The agent tags.
///
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("tags")]
public global::System.Collections.Generic.IList<string>? Tags { get; set; }

/// <summary>
/// The agent metadata.<br/>
/// Included only in responses
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("aiAgentMetadata")]
Expand All @@ -54,14 +52,12 @@ public sealed partial class Agent
public string? CreatorUid { get; set; }

/// <summary>
/// The creation time of the agent.<br/>
/// Included only in responses
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("createTime")]
public global::System.DateTime? CreateTime { get; set; }

/// <summary>
/// The last update time of the agent.<br/>
/// Included only in responses
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("updateTime")]
Expand All @@ -79,32 +75,22 @@ public sealed partial class Agent
/// <param name="agentUid">
/// Included only in responses
/// </param>
/// <param name="displayName">
/// The agent display name.
/// </param>
/// <param name="description">
/// The agent description.
/// </param>
/// <param name="displayName"></param>
/// <param name="description"></param>
/// <param name="namespaceUid">
/// The namespace of the agent.<br/>
/// Included only in responses
/// </param>
/// <param name="tags">
/// The agent tags.
/// </param>
/// <param name="tags"></param>
/// <param name="aiAgentMetadata">
/// The agent metadata.<br/>
/// Included only in responses
/// </param>
/// <param name="creatorUid">
/// Included only in responses
/// </param>
/// <param name="createTime">
/// The creation time of the agent.<br/>
/// Included only in responses
/// </param>
/// <param name="updateTime">
/// The last update time of the agent.<br/>
/// Included only in responses
/// </param>
[global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]
Expand Down
32 changes: 12 additions & 20 deletions src/libs/Instill/Generated/Instill.Models.CreateAgentBody.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,28 @@ namespace Instill
public sealed partial class CreateAgentBody
{
/// <summary>
/// The agent display name.
///
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("displayName")]
public string? DisplayName { get; set; }

/// <summary>
/// The agent description.
///
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("description")]
public string? Description { get; set; }

/// <summary>
/// The agent tags.
///
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("tags")]
public global::System.Collections.Generic.IList<string>? Tags { get; set; }

/// <summary>
/// The agent metadata.
///
/// </summary>
[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; }

/// <summary>
/// Additional properties that are not explicitly defined in the schema
Expand All @@ -41,29 +41,21 @@ public sealed partial class CreateAgentBody
/// <summary>
/// Initializes a new instance of the <see cref="CreateAgentBody" /> class.
/// </summary>
/// <param name="displayName">
/// The agent display name.
/// </param>
/// <param name="description">
/// The agent description.
/// </param>
/// <param name="tags">
/// The agent tags.
/// </param>
/// <param name="aiAgentApp">
/// The agent metadata.
/// </param>
/// <param name="displayName"></param>
/// <param name="description"></param>
/// <param name="tags"></param>
/// <param name="aiAgentMetadata"></param>
[global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]
public CreateAgentBody(
string? displayName,
string? description,
global::System.Collections.Generic.IList<string>? tags,
global::Instill.AIAgentAppMetadata? aiAgentApp)
global::Instill.AIAgentAppMetadata? aiAgentMetadata)
{
this.DisplayName = displayName;
this.Description = description;
this.Tags = tags;
this.AiAgentApp = aiAgentApp;
this.AiAgentMetadata = aiAgentMetadata;
}

/// <summary>
Expand Down
2 changes: 0 additions & 2 deletions src/libs/Instill/Generated/Instill.Models.CreateAgentResponse.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ namespace Instill
public sealed partial class CreateAgentResponse
{
/// <summary>
/// The created agent.<br/>
/// Included only in responses
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("agent")]
Expand All @@ -25,7 +24,6 @@ public sealed partial class CreateAgentResponse
/// Initializes a new instance of the <see cref="CreateAgentResponse" /> class.
/// </summary>
/// <param name="agent">
/// The created agent.<br/>
/// Included only in responses
/// </param>
[global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]
Expand Down
Loading
Loading