Skip to content

feat:Add replace-background endpoint and schema updates to Ideogram 3.0 OpenAPI spec #74

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

Jump to bottom
Merged
github-actions merged 1 commit into from
Apr 30, 2025
Merged

feat:Add replace-background endpoint and schema updates to Ideogram 3.0 OpenAPI spec #74

github-actions merged 1 commit into from
Apr 30, 2025

Conversation

@HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Apr 30, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features
    • Introduced a new API endpoint for replacing image backgrounds using Ideogram 3.0, allowing users to specify a prompt and optional style parameters.
  • Improvements
    • Updated schema descriptions for improved clarity regarding supported image resolutions.

@coderabbitai
Copy link

coderabbitai bot commented Apr 30, 2025 •
edited
Loading

Walkthrough

A new API endpoint /v1/ideogram-v3/replace-background was added to the OpenAPI specification for Ideogram 3.0, allowing users to synchronously replace the background of an image while preserving the foreground subject. The endpoint accepts multipart/form-data requests with a defined schema that includes required and optional parameters for customization. A new schema, ReplaceBackgroundRequestV3, was introduced to support this functionality. Additionally, the description of the ResolutionV3 schema was updated to clarify its association with Ideogram 3.0.

Changes

File(s) Change Summary
src/libs/Ideogram/openapi.yaml Added a new POST endpoint /v1/ideogram-v3/replace-background for background replacement in images, including request and response definitions, error responses, and operation details. Introduced the ReplaceBackgroundRequestV3 schema with required and optional fields for the new endpoint. Updated the description of the ResolutionV3 schema to reference Ideogram 3.0.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Controller

    Client->>API: POST /v1/ideogram-v3/replace-background (image, prompt, options)
    API->>Controller: Validate and process ReplaceBackgroundRequestV3
    Controller->>Controller: Identify foreground, replace background
    Controller->>API: Return ImageGenerationResponseV3
    API->>Client: Respond with processed image(s) or error
Loading

Poem

In the warren where images hop and bound,
A new endpoint for backgrounds is found!
With prompts and some style,
Foregrounds stay awhile,
While new scenes and colors abound.
🐇✨

📜 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 bb4bff7 and cf63186.

⛔ Files ignored due to path filters (16)
  • src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImageV3.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.PostRemixImageV3.g.cs is excluded by !**/generated/**
  • src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostReplaceBackgroundV3.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.PostReframeImageV3.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.PostReplaceBackgroundV3.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.ImageGenerationObjectV3.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.RemixImageRequestV3.g.cs is excluded by !**/generated/**
  • src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundRequestV3.Json.g.cs is excluded by !**/generated/**
  • src/libs/Ideogram/Generated/Ideogram.Models.ReplaceBackgroundRequestV3.g.cs is excluded by !**/generated/**
  • src/libs/Ideogram/Generated/Ideogram.Models.ResolutionV3.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 comments (3)
src/libs/Ideogram/openapi.yaml (3)

687-726: Add new replace-background endpoint for Ideogram 3.0
The /v1/ideogram-v3/replace-background path is consistent with other v3 endpoints (uses multipart/form-data for binary support, proper x-openapi-router-controller, and standard response codes). OperationId is unique and descriptive.

975-1006: Define ReplaceBackgroundRequestV3 schema
The new ReplaceBackgroundRequestV3 schema follows the pattern of other v3 request schemas: required binary image and prompt, plus optional parameters for magic prompts, styling, and reproducibility. Referencing global schema types ensures consistent validation.

1888-1888: Update ResolutionV3 description
The description has been clarified to reference "Ideogram 3.0" instead of the internal model version identifier, improving user-facing clarity.

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
🪧 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 generate sequence diagram to generate a sequence diagram of the changes in 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.

@github-actions github-actions bot enabled auto-merge April 30, 2025 03:38
@github-actions github-actions bot merged commit b0ad52c into main Apr 30, 2025
3 of 4 checks passed
@github-actions github-actions bot deleted the bot/update-openapi_202504300337 branch April 30, 2025 03:39
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Add replace-background endpoint and schema updates to Ideogram 3.0 OpenAPI spec Apr 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@github-actions github-actions[bot] github-actions[bot] approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@HavenDV