Skip to content

docs: use canonical OpenAPI reference domain - #5679

Merged
nobodyiam merged 3 commits into
apolloconfig:masterfrom
nobodyiam:codex/update-openapi-docs-domain
Sep 23, 2026
Merged

nobodyiam merged 3 commits into
apolloconfig:masterfrom
nobodyiam:codex/update-openapi-docs-domain

Conversation

@nobodyiam

@nobodyiam nobodyiam commented Sep 22, 2026 •

Copy link
Copy Markdown
Member

What's the purpose of this PR

Update the English and Chinese OpenAPI platform guides to link directly to the canonical API reference at https://openapi.apolloconfig.com/, following apolloconfig/apollo-openapi#40.

Which issue(s) this PR fixes

No linked issue.

Brief changelog

  • Replace the old GitHub Pages documentation URL in both language guides.

Validation

  • Confirmed no old OpenAPI documentation domain remains in tracked files.
  • Confirmed the new documentation URL returns HTTP 200.
  • mvn -B -ntp spotless:apply passed.
  • git diff --check passed.

Checklist

  • Read the contributing guide.
  • Describe the purpose and scope of the change.
  • Assess necessary unit tests: no new tests needed for this documentation-only change.
  • Run mvn clean test (not run locally: documentation-only change).
  • Run mvn spotless:apply.
  • Assess changelog impact: no CHANGES.md entry is needed for this non-functional documentation change.

Summary by CodeRabbit

  • Documentation
    • Updated the API reference link in the English and Chinese Open API platform documentation.

@coderabbitai

coderabbitai Bot commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: a954e49d-02b2-464f-a21a-bec94a1b2a6c

📥 Commits

Reviewing files that changed from the base of the PR and between 0edf58e and 559420a.

📒 Files selected for processing (2)
  • docs/en/portal/apollo-open-api-platform.md
  • docs/zh/portal/apollo-open-api-platform.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The English and Chinese Open API platform pages now link to https://openapi.apolloconfig.com/ for the full API reference.

Changes

Open API platform documentation

Layer / File(s) Summary
Update API reference links
docs/en/portal/apollo-open-api-platform.md, docs/zh/portal/apollo-open-api-platform.md
Both pages replace the previous API reference URL with https://openapi.apolloconfig.com/.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Suggested reviewers: shalk

Merge Risk: ⚪ Minimal · up to 55942

The English and Chinese guides now point to the same API reference. No actionable merge risk is evident.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: updating documentation to use the canonical OpenAPI reference domain.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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.

@nobodyiam
nobodyiam marked this pull request as ready for review September 23, 2026 05:27
Copilot AI lite review requested due to automatic review settings September 23, 2026 05:27

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

Documentation-only URL updates were fully reviewed with no unresolved issues.

Review effort: Lite
Findings: None

What changed in this PR

Updates the English and Chinese OpenAPI guides to use the canonical API reference domain.

Changes:

  • Replaced the deprecated GitHub Pages URL in both guides.
  • Confirmed the canonical reference link.
File Description
docs/​zh/​portal/​apollo-open-api-platform.md Uses the canonical OpenAPI reference URL.
docs/​en/​portal/​apollo-open-api-platform.md Uses the canonical OpenAPI reference URL.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@nobodyiam
nobodyiam merged commit bb0725d into apolloconfig:master Sep 23, 2026
9 checks passed
@nobodyiam
nobodyiam deleted the codex/update-openapi-docs-domain branch September 23, 2026 11:24
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 23, 2026
@nobodyiam nobodyiam added this to the 3.0.0 milestone Sep 27, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants