feat:Update OpenAPI spec for /magic-prompt with multipart, new fields, and FICTION style

[HavenDV]

Summary by CodeRabbit

• New Features

  • Added support for uploading character reference images and specifying a system prompt when generating magic prompts and images.
  • Introduced a new "FICTION" style type option for prompt and image generation.

• Enhancements

  • The magic prompt endpoint now accepts both JSON and multipart form data for more flexible input options.

[coderabbitai]

Walkthrough

The OpenAPI specification for the Ideogram API was updated to support multipart/form-data for the /magic-prompt endpoint, add character_reference_images and system_prompt properties to relevant request schemas, and introduce a new FICTION style type in both StyleType and StyleTypeV3 enums.

Changes

File(s)	Change Summary
src/libs/Ideogram/openapi.yaml	Enhanced /magic-prompt endpoint to support multipart/form-data, added character_reference_images and system_prompt to request schemas, and introduced FICTION to style enums.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

A prompt for magic, now with flair,
Images and system prompts in the air!
New style—FICTION—joins the show,
Multipart forms let your ideas flow.
The API grows, so swift and spry—
A rabbit hops by, waving hi!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch bot/update-openapi_202507260155

---

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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate unit tests to generate unit tests 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

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

188-195: Consider adding explicit encoding metadata for the new multipart request.

/magic-prompt now accepts multipart/form-data, but the multipart/form-data block does not declare an encoding: section for character_reference_images (array of binary) or any other text fields. Several other endpoints (/edit, /reframe, etc.) already provide explicit encoding objects to specify contentType and style=form.

While the default (style=form, explode=true) usually works, being explicit:

content:
  multipart/form-data:
    schema:
      $ref: '#/components/schemas/MagicPromptRequest'
    encoding:
      character_reference_images:
        contentType: image/*          # or image/png,image/jpeg,image/webp
        style: form

(a) documents intent unambiguously,
(b) prevents subtle client-generator differences,
(c) aligns with the other endpoints for consistency.

---

1018-1023: Add JSON–schema constraints for the new character_reference_images array.

character_reference_images is described as “maximum total size 10 MB”, but no structural limits are enforced. Adding maxItems (e.g., maxItems: 10) and/or maxLength per file name is cheap insurance and enables client generators to validate early.

---

1620-1629: MagicPromptRequest: mirror constraints & encoding hints for the new fields.

1. Same size / item-count remarks as above.
2. system_prompt is free-form; consider maxLength (the other string fields have none either, but adding limits prevents abuse).
3. When this schema is used under application/json, properties with type: string, format: binary are technically non-conformant in OAS 3.0. If JSON clients are expected to omit those fields, note this in the docstring or split the schema.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7269462 and 0db7536.

⛔ Files ignored due to path filters (8)

• src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImageV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostGenerateImageV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IPromptClient.PostMagicPrompt.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.MagicPromptRequest.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.StyleType.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.StyleTypeV3.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.PromptClient.PostMagicPrompt.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (2)

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

2041-2042: Enum extension looks good – FICTION added to StyleType.

No conflicts detected; existing descriptions remain valid.

---

2281-2282: Enum extension looks good – FICTION added to StyleTypeV3.

Keeps V3 parity with legacy enum; good.