feat:Add POST /manage/api/add_credits endpoint for adding user credits

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced a new API endpoint to allow adding credits to an API user's account.
  • Enhanced API responses to provide clear feedback on successful credit additions and error messages for failed requests.

[coderabbitai]

Walkthrough

A new POST endpoint /manage/api/add_credits has been introduced in the API specification to facilitate adding credits to an API user's account. This endpoint requires a request body that specifies the credit amount and responds with confirmation, error messages, or authorization errors as appropriate. New schema definitions for the request, response, and error formats have also been added to support this functionality. The endpoint is secured with Bearer token authentication and is managed by the designated controller.

Changes

File(s)	Change Summary
src/libs/Ideogram/openapi.yaml	Added POST /manage/api/add_credits endpoint, new request/response/error schemas for credit management.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API Gateway
    participant ManageController

    Client->>API Gateway: POST /manage/api/add_credits (amount)
    API Gateway->>ManageController: Validate token and request
    ManageController-->>API Gateway: Success (credited amount) / Error (messages)
    API Gateway-->>Client: 200 (amount) / 400 (error messages) / 401 / 403

Loading

Poem

A credit hop, a credit jump,
Now users fill their credit lump!
With POST and token, safely sent,
The API counts every cent.
New schemas bloom, requests take flight—
More credits added, all is right!
🐇💳

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

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

174-187: Suggest adding an operation-level description for clarity
The new POST /manage/api/add_credits operation currently includes only a summary. For consistency with other endpoints (e.g., /edit, /generate), consider adding a longer-form description to explain intent, side‑effects, and any preconditions.
Example addition:

  /manage/api/add_credits:
    post:
      summary: Add credits to an API user's account.
+     description: "Adds a credit balance to the authenticated API user's account. Requires a valid Bearer token and a positive `amount`."
      operationId: post_add_credits_for_api
      tags:
        - manage
      requestBody:
        description: A request to add credits to an API user's account.
        # …

---

188-207: Refine HTTP response descriptions and differentiate auth errors
The 200–403 responses could use clearer descriptions and better semantics, and 401 vs. 403 should be distinct. For example:

-      responses:
-        '200':
-          description: API subscription content
+      responses:
+        '200':
+          description: Credits added successfully.
         '400':
-          description: Bad request
+          description: Invalid request to add credits.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/PostAddCreditsError'
-        '401':
-          description: Not authorized
-        '403':
-          description: Not authorized
+        '401':
+          description: Authentication failed or missing Bearer token.
+        '403':
+          description: Forbidden – insufficient permissions to add credits.

Optionally, consider reusing a standard error schema for 401/403 bodies or adding a 422 if you need more granular validation errors.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8a01c56 and b206ddf.

⛔ Files ignored due to path filters (9)

• src/libs/Ideogram/Generated/Ideogram.IManageClient.PostAddCreditsForApi.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.ManageClient.PostAddCreditsForApi.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.PostAddCreditsError.Json.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.PostAddCreditsError.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.PostAddCreditsRequest.Json.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.PostAddCreditsRequest.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.PostAddCreditsResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.PostAddCreditsResponse.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 (2 hunks)

🔇 Additional comments (3)

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

1644-1656: Schema PostAddCreditsResponse definition looks correct
The response schema requires an amount of type Price and the example aligns with existing patterns in the spec.

---

1657-1672: Schema PostAddCreditsError definition is consistent
The error schema exposes a messages array (string) in line with other subscription‑related error schemas.

---

1673-1684: Schema PostAddCreditsRequest definition is well structured
Requiring amount of type Price matches similar endpoints, and the example is valid.