feat:Update OpenAPI schema descriptions for image binary fields and size limits

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Updated descriptions for image upload fields across various image-related requests to clearly state a maximum file size of 10MB and supported formats (JPEG, PNG, WebP).
  • Clarified that collections of style reference images have a combined maximum size of 10MB.

[coderabbitai]

Walkthrough

This change updates the OpenAPI schema documentation for several image-related request properties by clarifying and standardizing their descriptions. The updated descriptions now explicitly state that image binary fields (such as image_file, image, mask, and style_reference_images) support JPEG, PNG, and WebP formats and must not exceed a maximum size of 10MB. For collections of style reference images, the total size limit is also specified as 10MB. No modifications were made to the data types or structural aspects of the API, only to the descriptive text.

Changes

File(s)	Change Summary
src/libs/Ideogram/openapi.yaml	Updated descriptions for image binary fields in multiple request schemas to specify 10MB max size and supported formats (JPEG, PNG, WebP). Clarified total size limit for collections of style reference images. No structural or type changes.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API

    Client->>API: Submit request with image (JPEG/PNG/WebP, ≤10MB)
    API-->>Client: Validate image size and format
    API-->>Client: Process request as per schema

Loading

Possibly related PRs

• feat:Add /internal-testing endpoint to Ideogram API with OpenAPI update #45: Adds a new /internal-testing endpoint and defines the InternalTestingRequest schema, which is also updated in this PR for description clarity.

Suggested reviewers

• github-actions

Poem

🐇
In fields of docs, I hop with glee,
Clarifying limits for all to see.
Ten megabytes, not a byte more,
JPEG, PNG, WebP—formats galore!
With every schema, neat and bright,
Your API’s future looks just right.
—A rabbit’s OpenAPI delight!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7177e1 and 48fa96d.

⛔ Files ignored due to path filters (30)

• src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostEditImage.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostEditImageV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImageV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostReframeImage.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostReframeImageV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostRemixImage.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostRemixImageV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostUpscaleImage.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostEditImage.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostEditImageV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostGenerateImageV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostReframeImage.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostReframeImageV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostRemixImage.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostRemixImageV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostUpscaleImage.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IInternalTestingClient.PostInternalTesting.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IVisionClient.PostDescribe.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.InternalTestingClient.PostInternalTesting.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.DescribeRequest.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.EditImageRequest.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.EditImageRequestV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageRequestV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.InternalTestingRequest.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageRequest.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.ReframeImageRequestV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.RemixImageRequest.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.RemixImageRequestV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.UpscaleImageRequest.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.VisionClient.PostDescribe.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/Ideogram/openapi.yaml (13 hunks)

🔇 Additional comments (1)

src/libs/Ideogram/openapi.yaml (1)

677-677: Documentation improvements are clear and consistent.

The updated descriptions for image binary fields and style reference images now clearly state the supported formats (JPEG, PNG, WebP) and the 10MB maximum size (or total size for arrays). This improves API usability and reduces ambiguity for integrators.

If not already enforced, consider verifying that the backend logic or API gateway actually rejects files that exceed these limits or are of unsupported formats, to ensure the documentation matches runtime behavior.

Would you like a script to search for and verify enforcement of these constraints in the backend code?

Also applies to: 689-689, 693-693, 784-784, 793-793, 836-836, 846-846, 850-850, 873-873, 882-882, 901-901, 912-912, 916-916, 983-983, 995-995, 1017-1017

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.