feat:Update negative_prompt and ColorPalette schemas in openapi.yaml

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Enhanced API documentation by refining descriptions to specify that certain properties are only available for designated model versions.
  • Clarified usage guidelines for image prompt configuration and color palette options based on model version support.

[coderabbitai]

Walkthrough

The pull request updates the API documentation in the openapi.yaml file. Two schema descriptions are revised: the negative_prompt property now specifies availability for model versions V_1, V_1_TURBO, V_2, and V_2_TURBO, and the ColorPaletteWithPresetNameOrMembers schema now indicates it is only available for models V_2 and V_2_TURBO.

Changes

File	Change Summary
src/.../openapi.yaml	Updated negative_prompt description to include model versions V_1, V_1_TURBO, V_2, and V_2_TURBO; Updated ColorPaletteWithPresetNameOrMembers description to specify availability for V_2 and V_2_TURBO.

Possibly related PRs

• feat:Update OpenAPI Specification for Ideogram API with New Properties and Schemas #47: Updates the ImageRequest schema by adding a new property, closely related to the modifications in the property descriptions.

Suggested reviewers

• github-actions

Poem

I'm a rabbit on a merry code spree,
Hopping through YAML with clarity.
Descriptions refined with versions in sight,
Documenting features with delight.
Cheers to updates that make docs just right!

---

📜 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 4c2fc37 and 978c141.

⛔ Files ignored due to path filters (2)

• src/libs/Ideogram/Generated/Ideogram.Models.ColorPaletteWithPresetNameOrMembers.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.ImageRequest.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (2)

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

705-708: Updated Negative Prompt Property Description
The updated description for the negative_prompt property now explicitly states that it is only available for model versions V_1, V_1_TURBO, V_2, and V_2_TURBO, which satisfies the updated API documentation requirements. The explanation also clarifies that prompt descriptions take precedence over the negative prompt, ensuring clear guidance for API consumers.

---

1337-1341: Refined Color Palette Schema Availability
The ColorPaletteWithPresetNameOrMembers schema now clearly indicates that it is only available for model versions V_2 and V_2_TURBO. The description also specifies that the color palette must be provided either via a preset name or explicitly via hexadecimal representations (with optional weights), which aligns with the intended documentation improvements.

---

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