Skip to content

feat:Update OpenAPI Documentation: Reorder Endpoints and Append Periods #70

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

Merged
github-actions merged 1 commit into from
Apr 11, 2025
Merged

feat:Update OpenAPI Documentation: Reorder Endpoints and Append Periods #70

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
12 changes: 7 additions & 5 deletions src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostEditImage.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,16 +311,16 @@ partial void ProcessPostEditImageResponseContent(
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it.
/// </summary>
/// <param name="imageFile">
/// The image being edited; only JPEG, WebP and PNG formats are supported at this time
/// The image being edited; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="imageFilename">
/// The image being edited; only JPEG, WebP and PNG formats are supported at this time
/// The image being edited; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="mask">
/// A black and white image of the same size as the image being edited. Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time
/// A black and white image of the same size as the image being edited. Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="maskname">
/// A black and white image of the same size as the image being edited. Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time
/// A black and white image of the same size as the image being edited. Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="prompt">
/// The prompt used to describe the edited result.<br/>
Expand All @@ -332,13 +332,15 @@ partial void ProcessPostEditImageResponseContent(
/// Example: V_2_TURBO
/// </param>
/// <param name="magicPromptOption">
/// Determine if MagicPrompt should be used in generating the request or not<br/>
/// Determine if MagicPrompt should be used in generating the request or not.<br/>
/// Example: ON
/// </param>
/// <param name="numImages">
/// The number of images to generate.<br/>
/// Default Value: 1
/// </param>
/// <param name="seed">
/// Random seed. Set for reproducible generation.<br/>
/// Example: 12345
/// </param>
/// <param name="styleType">
Expand Down
32 changes: 17 additions & 15 deletions src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostEditImageV3.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ partial void ProcessPostEditImageV3ResponseContent(
request: request);

var __pathBuilder = new PathBuilder(
path: "/v1/edit/ideogram-v3",
path: "/v1/ideogram-v3/edit",
baseUri: HttpClient.BaseAddress);
var __path = __pathBuilder.ToString();
using var __httpRequest = new global::System.Net.Http.HttpRequestMessage(
Expand Down Expand Up @@ -72,9 +72,9 @@ partial void ProcessPostEditImageV3ResponseContent(
}
using var __httpRequestContent = new global::System.Net.Http.MultipartFormDataContent();
__httpRequestContent.Add(
content: new global::System.Net.Http.ByteArrayContent(request.ImageFile ?? global::System.Array.Empty<byte>()),
name: "image_file",
fileName: request.ImageFilename ?? string.Empty);
content: new global::System.Net.Http.ByteArrayContent(request.Image ?? global::System.Array.Empty<byte>()),
name: "image",
fileName: request.Imagename ?? string.Empty);
__httpRequestContent.Add(
content: new global::System.Net.Http.ByteArrayContent(request.Mask ?? global::System.Array.Empty<byte>()),
name: "mask",
Expand Down Expand Up @@ -325,30 +325,32 @@ partial void ProcessPostEditImageV3ResponseContent(
/// Supported image formats include JPEG, PNG, and WebP.<br/>
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it.
/// </summary>
/// <param name="imageFile">
/// The image being edited; only JPEG, WebP and PNG formats are supported at this time
/// <param name="image">
/// The image being edited; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="imageFilename">
/// The image being edited; only JPEG, WebP and PNG formats are supported at this time
/// <param name="imagename">
/// The image being edited; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="mask">
/// A black and white image of the same size as the image being edited. Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time
/// A black and white image of the same size as the image being edited. Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="maskname">
/// A black and white image of the same size as the image being edited. Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time
/// A black and white image of the same size as the image being edited. Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="prompt">
/// The prompt used to describe the edited result.<br/>
/// Example: A photo of a cat.
/// </param>
/// <param name="magicPrompt">
/// Determine if MagicPrompt should be used in generating the request or not<br/>
/// Determine if MagicPrompt should be used in generating the request or not.<br/>
/// Example: ON
/// </param>
/// <param name="numImages">
/// The number of images to generate.<br/>
/// Default Value: 1
/// </param>
/// <param name="seed">
/// Random seed. Set for reproducible generation.<br/>
/// Example: 12345
/// </param>
/// <param name="renderingSpeed">
Expand All @@ -368,8 +370,8 @@ partial void ProcessPostEditImageV3ResponseContent(
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
public async global::System.Threading.Tasks.Task<global::Ideogram.ImageGenerationResponseV3> PostEditImageV3Async(
byte[] imageFile,
string imageFilename,
byte[] image,
string imagename,
byte[] mask,
string maskname,
string prompt,
Expand All @@ -384,8 +386,8 @@ partial void ProcessPostEditImageV3ResponseContent(
{
var __request = new global::Ideogram.EditImageRequestV3
{
ImageFile = imageFile,
ImageFilename = imageFilename,
Image = image,
Imagename = imagename,
Mask = mask,
Maskname = maskname,
Prompt = prompt,
Expand Down
2 changes: 1 addition & 1 deletion src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImage.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ partial void ProcessPostGenerateImageResponseContent(
/// </summary>
/// <param name="imageRequest"></param>
/// <param name="styleRefEmbeddings">
/// A list of base64 encoded binary embeddings
/// A list of base64 encoded binary embeddings.
/// </param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
Expand Down
7 changes: 4 additions & 3 deletions src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImageV3.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ partial void ProcessPostGenerateImageV3ResponseContent(
request: request);

var __pathBuilder = new PathBuilder(
path: "/v1/generate/ideogram-v3",
path: "/v1/ideogram-v3/generate",
baseUri: HttpClient.BaseAddress);
var __path = __pathBuilder.ToString();
using var __httpRequest = new global::System.Net.Http.HttpRequestMessage(
Expand Down Expand Up @@ -342,21 +342,22 @@ partial void ProcessPostGenerateImageV3ResponseContent(
/// Example: A photo of a cat
/// </param>
/// <param name="seed">
/// Random seed. Set for reproducible generation.<br/>
/// Example: 12345
/// </param>
/// <param name="resolution">
/// The resolutions supported for model version V_3.<br/>
/// Example: 1280x800
/// </param>
/// <param name="aspectRatio">
/// The aspect ratio to use for image generation, which determines the image's resolution. Cannot be used in conjunction with resolution. Defaults to 1:1.
/// The aspect ratio to use for image generation, which determines the image's resolution. Cannot be used in conjunction with resolution. Defaults to 1x1.
/// </param>
/// <param name="renderingSpeed">
/// The rendering speed to use.<br/>
/// Default Value: BALANCED
/// </param>
/// <param name="magicPrompt">
/// Determine if MagicPrompt should be used in generating the request or not<br/>
/// Determine if MagicPrompt should be used in generating the request or not.<br/>
/// Example: ON
/// </param>
/// <param name="negativePrompt">
Expand Down
6 changes: 4 additions & 2 deletions src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostReframeImage.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ partial void ProcessPostReframeImageResponseContent(
/// <summary>
/// Reframe<br/>
/// Reframe a square image to a chosen resolution. The supported image formats include JPEG, PNG, and WebP.<br/>
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it.
/// </summary>
/// <param name="request"></param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
Expand Down Expand Up @@ -294,7 +294,7 @@ partial void ProcessPostReframeImageResponseContent(
/// <summary>
/// Reframe<br/>
/// Reframe a square image to a chosen resolution. The supported image formats include JPEG, PNG, and WebP.<br/>
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it.
/// </summary>
/// <param name="imageFile">
/// The image being reframed; only JPEG, WebP and PNG formats are supported at this time.
Expand All @@ -312,9 +312,11 @@ partial void ProcessPostReframeImageResponseContent(
/// Example: V_2_TURBO
/// </param>
/// <param name="numImages">
/// The number of images to generate.<br/>
/// Default Value: 1
/// </param>
/// <param name="seed">
/// Random seed. Set for reproducible generation.<br/>
/// Example: 12345
/// </param>
/// <param name="styleType">
Expand Down
26 changes: 14 additions & 12 deletions src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostReframeImageV3.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ partial void ProcessPostReframeImageV3ResponseContent(
/// <summary>
/// Reframe with Ideogram 3.0<br/>
/// Reframe a square image to a chosen resolution with Ideogram 3.0. The supported image formats include JPEG, PNG, and WebP.<br/>
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it.
/// </summary>
/// <param name="request"></param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
Expand All @@ -42,7 +42,7 @@ partial void ProcessPostReframeImageV3ResponseContent(
request: request);

var __pathBuilder = new PathBuilder(
path: "/v1/reframe/ideogram-v3",
path: "/v1/ideogram-v3/reframe",
baseUri: HttpClient.BaseAddress);
var __path = __pathBuilder.ToString();
using var __httpRequest = new global::System.Net.Http.HttpRequestMessage(
Expand Down Expand Up @@ -70,9 +70,9 @@ partial void ProcessPostReframeImageV3ResponseContent(
}
using var __httpRequestContent = new global::System.Net.Http.MultipartFormDataContent();
__httpRequestContent.Add(
content: new global::System.Net.Http.ByteArrayContent(request.ImageFile ?? global::System.Array.Empty<byte>()),
name: "image_file",
fileName: request.ImageFilename ?? string.Empty);
content: new global::System.Net.Http.ByteArrayContent(request.Image ?? global::System.Array.Empty<byte>()),
name: "image",
fileName: request.Imagename ?? string.Empty);
__httpRequestContent.Add(
content: new global::System.Net.Http.StringContent($"{request.Resolution.ToValueString()}"),
name: "resolution");
Expand Down Expand Up @@ -309,22 +309,24 @@ partial void ProcessPostReframeImageV3ResponseContent(
/// <summary>
/// Reframe with Ideogram 3.0<br/>
/// Reframe a square image to a chosen resolution with Ideogram 3.0. The supported image formats include JPEG, PNG, and WebP.<br/>
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it.
/// </summary>
/// <param name="imageFile">
/// <param name="image">
/// The image being reframed; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="imageFilename">
/// <param name="imagename">
/// The image being reframed; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="resolution">
/// The resolutions supported for model version V_3.<br/>
/// Example: 1280x800
/// </param>
/// <param name="numImages">
/// The number of images to generate.<br/>
/// Default Value: 1
/// </param>
/// <param name="seed">
/// Random seed. Set for reproducible generation.<br/>
/// Example: 12345
/// </param>
/// <param name="renderingSpeed">
Expand All @@ -344,8 +346,8 @@ partial void ProcessPostReframeImageV3ResponseContent(
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
public async global::System.Threading.Tasks.Task<global::Ideogram.ImageGenerationResponseV3> PostReframeImageV3Async(
byte[] imageFile,
string imageFilename,
byte[] image,
string imagename,
global::Ideogram.ResolutionV3 resolution,
int? numImages = default,
int? seed = default,
Expand All @@ -357,8 +359,8 @@ partial void ProcessPostReframeImageV3ResponseContent(
{
var __request = new global::Ideogram.ReframeImageRequestV3
{
ImageFile = imageFile,
ImageFilename = imageFilename,
Image = image,
Imagename = imagename,
Resolution = resolution,
NumImages = numImages,
Seed = seed,
Expand Down
8 changes: 4 additions & 4 deletions src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostRemixImage.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ partial void ProcessPostRemixImageResponseContent(

/// <summary>
/// Remix<br/>
/// Remix provided images synchronously based on a given prompt and optional parameters<br/>
/// Remix provided images synchronously based on a given prompt and optional parameters.<br/>
/// Input images are cropped to the chosen aspect ratio before being remixed.<br/>
/// Supported image formats include JPEG, PNG, and WebP.<br/>
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it.
Expand Down Expand Up @@ -274,7 +274,7 @@ partial void ProcessPostRemixImageResponseContent(

/// <summary>
/// Remix<br/>
/// Remix provided images synchronously based on a given prompt and optional parameters<br/>
/// Remix provided images synchronously based on a given prompt and optional parameters.<br/>
/// Input images are cropped to the chosen aspect ratio before being remixed.<br/>
/// Supported image formats include JPEG, PNG, and WebP.<br/>
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it.
Expand All @@ -283,10 +283,10 @@ partial void ProcessPostRemixImageResponseContent(
/// A request to generate a new image using a provided image and a prompt.
/// </param>
/// <param name="imageFile">
/// An image binary; only JPEG, WebP and PNG formats are supported at this time
/// An image binary; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="imageFilename">
/// An image binary; only JPEG, WebP and PNG formats are supported at this time
/// An image binary; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
Expand Down
Loading
Loading