Skip to content

chore: update the relay openapi file - #2353

Merged
Calcium-Ion merged 1 commit into
mainfrom
openapi
Dec 2, 2025
Merged

chore: update the relay openapi file#2353
Calcium-Ion merged 1 commit into
mainfrom
openapi

Conversation

@t0ng7u

@t0ng7u t0ng7u commented Dec 2, 2025

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Simplified API documentation structure for image generation operations with streamlined categorization and consolidated naming conventions for improved clarity and navigation.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai

coderabbitai Bot commented Dec 2, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Updates OpenAPI specification tag names in relay documentation to flatten hierarchical Chinese paths. Three nested image-generation tags are renamed to shorter forms, and corresponding operation-tag references updated to use the new tag names. Documentation-only change with no behavioral modifications.

Changes

Cohort / File(s) Change Summary
OpenAPI tag restructuring
docs/openapi/relay.json
Three top-level tag names flattened: "图片生成/编辑(Images)" → "图片生成", "图片生成/编辑(Images)/OpenAI兼容格式" → "图片生成/OpenAI兼容格式", "图片生成/编辑(Images)/Qwen千问" → "图片生成/Qwen千问". Operation tag references in /v1/images/generations and /v1/images/edits endpoints updated to reflect new tag names.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Single file with consistent, repetitive rename pattern
  • Straightforward documentation update with no logic changes
  • Quick to verify tag name consistency across definitions and references

Suggested reviewers

  • Calcium-Ion

Poem

🐰 Tags were tangled, hierarchies deep,
So I hopped through and tidied the heap,
Flattened the paths with a flourish and care,
Now API docs flow light through the air! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'chore: update the relay openapi file' is vague and generic, using non-descriptive language that doesn't convey what specific changes were made to the OpenAPI file. Consider using a more specific title such as 'chore: simplify OpenAPI tag names in relay.json' or 'chore: consolidate image generation tag hierarchy in relay.json' to clearly indicate the nature of the changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch openapi

📜 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 d3ca454 and 0c6d890.

📒 Files selected for processing (1)
  • docs/openapi/relay.json (3 hunks)
🔇 Additional comments (3)
docs/openapi/relay.json (3)

288-296: Operation tag updated to new naming convention.

The /v1/images/generations operation tag has been correctly updated from the old hierarchical format to the new simplified tag name "图片生成/Qwen千问", consistent with the tag definition changes.


404-412: Operation tag updated to new naming convention.

The /v1/images/edits operation tag has been correctly updated from the old hierarchical format to the new simplified tag name "图片生成/Qwen千问", consistent with the tag definition changes and the previous operation update.


8-72: Tag hierarchy simplified: old tag names successfully replaced.

The tag definitions correctly remove the redundant "(Images)" hierarchy path, replacing three nested tags with cleaner names. Verification confirms all old tag names have been completely removed from the file and all operation references have been updated to the new tag names. The JSON structure remains valid.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@Calcium-Ion
Calcium-Ion merged commit 509d1f6 into main Dec 2, 2025
1 check was pending
@Calcium-Ion
Calcium-Ion deleted the openapi branch January 29, 2026 17:10
ennnnny pushed a commit to ennnnny/new-api that referenced this pull request Mar 17, 2026
chore: update the relay openapi file
jiutubaba pushed a commit to jiutubaba/fx-api that referenced this pull request May 17, 2026
…n-type-sync

fix: sync OpenAI plan type from usage limit errors
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants