feat:Add /edit endpoint for synchronous image editing in Ideogram API

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced a new /edit endpoint for the Ideogram API, enabling users to edit images with specified parameters.
  • Added support for various image formats, including JPEG, PNG, and WEBP.
  • Enhanced aspect ratio options with the reintroduction of the AspectRatio schema.

• Bug Fixes

  • Improved error handling for invalid inputs and unauthorized access.

[coderabbitai]

Walkthrough

The changes introduce a new endpoint /edit to the Ideogram API's OpenAPI specification, enabling synchronous image editing with specified parameters. This endpoint accepts multipart/form-data requests and supports image formats such as JPEG, PNG, and WEBP. It defines a new request body schema, EditImageRequest, and reintroduces the AspectRatio schema. The endpoint includes various response scenarios, including success and error responses. These modifications enhance the API's capabilities for image editing and aspect ratio management.

Changes

File Path	Change Summary
src/libs/Ideogram/openapi.yaml	- Added new endpoint POST /edit with operation ID post_edit_image.
	- Introduced new request body schema EditImageRequest.
	- Reintroduced AspectRatio schema with various aspect ratio options.

Poem

In the garden of code, a new path we tread,
With /edit for images, creativity spread.
Masks and prompts dance, in formats so bright,
JPEGs and PNGs, a wonderful sight!
Aspect ratios return, like rabbits in play,
Hopping through changes, in a joyful array! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

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

40-90: LGTM! New /edit endpoint is well-structured.

The new /edit endpoint is well-defined and includes all necessary components such as tags, summary, description, request body, and responses. It aligns well with the existing API structure.

For consistency with other endpoints, consider adding a brief example in the description, similar to the /describe endpoint.

---

Line range hint 1-1146: Overall changes look good. Consider updating documentation.

The changes to the OpenAPI specification, including the new /edit endpoint and reintroduced AspectRatio schema, are well-implemented and consistent with the existing structure. The security schemes and tags are properly defined.

To ensure that the API documentation remains up-to-date, consider updating any relevant external documentation or README files to reflect these changes, particularly the new image editing functionality.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3987c51 and 66f3438.

⛔ Files ignored due to path filters (5)

• src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostEditImage.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostEditImage.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.EditImageRequest.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🧰 Additional context used

🔇 Additional comments (2)

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

1128-1146: LGTM! AspectRatio schema is properly reintroduced.

The AspectRatio schema is well-defined with appropriate enum values, description, and external documentation link. Its reintroduction aligns with the changes mentioned in the AI-generated summary.

---

52-52: Verify the EditImageRequest schema definition.

The EditImageRequest schema is referenced in the /edit endpoint, but its definition is not visible in the provided code snippet. Please ensure that this schema is properly defined either in this file or in a referenced file.