[docs-agent] Update API documentation — rename Regional Platform to HyperFleet in docs/titles - #118
Conversation
…yperFleet in docs/titles
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: redhat-chai-bot The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
openshift-ci
Bot
added
the
needs-ok-to-test
|
Hi @redhat-chai-bot. Thanks for your PR. I'm waiting for a openshift-online member to verify that this patch is reasonable to test. If it is, they should reply with Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
WalkthroughThis PR renames the project from "ROSA Regional Platform API" to "ROSA HyperFleet API" across AGENTS.md, CLAUDE.md, README.md, SECURITY-AUDIT.md, openapi.yaml, and test/e2e-api/README.md. It also reformats documentation content into markdown tables, expands README E2E testing/troubleshooting instructions, and updates SECURITY-AUDIT.md findings narrative. ChangesRebrand and documentation updates
Estimated code review effort: 2 (Simple) | ~12 minutes Suggested labels: 🚥 Pre-merge checks | ✅ 10 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (10 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@openapi/openapi.yaml`:
- Line 3: The Swagger UI title is still hardcoded with the old spec name, so
update the title used by the swagger generation path to match the renamed API.
In particular, adjust the `make generate-swagger` template in `Makefile` so the
generated UI title stays aligned with `ROSA HyperFleet API`, and verify any
other swagger title string constants used by the generation flow are updated
consistently.
In `@README.md`:
- Around line 215-221: The custom credentials path example in the README uses
the wrong shell syntax, so update the `make test-e2e-container` example to use
the `PWD` environment variable form instead of command substitution. Fix the
snippet under the “Using credentials from a custom location” section so
`AWS_CREDENTIALS_PATH` references the current directory via `$PWD` or `${PWD}`.
In `@test/e2e-api/README.md`:
- Line 3: The README rename is inconsistent with the suite banner, because
test/e2e-api/e2e_test.go still prints the old “ROSA Regional Platform API E2E
Suite” text. Update the banner string in the e2e test entrypoint (the code that
prints the suite name, likely in e2e_test.go/main test setup) so it matches the
README’s “ROSA HyperFleet API” terminology and both docs and runtime output use
the same name.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: openshift-online/coderabbit/.coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: cf266577-79f6-4fe4-b3c5-1ce53bf4307a
📒 Files selected for processing (7)
AGENTS.mdCLAUDE.mdREADME.mdSECURITY-AUDIT.mddocs/api/zoa-endpoints.mdopenapi/openapi.yamltest/e2e-api/README.md
| openapi: 3.0.3 | ||
| info: | ||
| title: ROSA Regional Platform API | ||
| title: ROSA HyperFleet API |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Keep the Swagger UI title in sync with the spec rename.
make generate-swagger still hardcodes ROSA Regional Platform API - Swagger UI in Makefile, so regenerating docs will leave the checked-in Swagger page with the old name unless that template is updated too.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@openapi/openapi.yaml` at line 3, The Swagger UI title is still hardcoded with
the old spec name, so update the title used by the swagger generation path to
match the renamed API. In particular, adjust the `make generate-swagger`
template in `Makefile` so the generated UI title stays aligned with `ROSA
HyperFleet API`, and verify any other swagger title string constants used by the
generation flow are updated consistently.
| **Using credentials from a custom location**: | ||
|
|
||
| ```bash | ||
| make test-e2e-container \ | ||
| BASE_URL="https://xxxxx.execute-api.us-east-2.amazonaws.com/prod" \ | ||
| AWS_CREDENTIALS_PATH="$(PWD)/../my-credentials-dir" | ||
| ``` |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Fix the custom credentials path example.
$(PWD) is command substitution, not the current-directory variable, so this example will fail. Use $PWD (or ${PWD}) instead.
Patch
- AWS_CREDENTIALS_PATH="$(PWD)/../my-credentials-dir"
+ AWS_CREDENTIALS_PATH="$PWD/../my-credentials-dir"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Using credentials from a custom location**: | |
| ```bash | |
| make test-e2e-container \ | |
| BASE_URL="https://xxxxx.execute-api.us-east-2.amazonaws.com/prod" \ | |
| AWS_CREDENTIALS_PATH="$(PWD)/../my-credentials-dir" | |
| ``` | |
| **Using credentials from a custom location**: | |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 215 - 221, The custom credentials path example in the
README uses the wrong shell syntax, so update the `make test-e2e-container`
example to use the `PWD` environment variable form instead of command
substitution. Fix the snippet under the “Using credentials from a custom
location” section so `AWS_CREDENTIALS_PATH` references the current directory via
`$PWD` or `${PWD}`.
| # E2E Tests | ||
|
|
||
| End-to-end integration and functional tests for the ROSA Regional Platform API. | ||
| End-to-end integration and functional tests for the ROSA HyperFleet API. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Align the README with the suite banner.
test/e2e-api/e2e_test.go still prints ROSA Regional Platform API E2E Suite, so the docs rename and the runtime output will diverge until that string is updated too.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@test/e2e-api/README.md` at line 3, The README rename is inconsistent with the
suite banner, because test/e2e-api/e2e_test.go still prints the old “ROSA
Regional Platform API E2E Suite” text. Update the banner string in the e2e test
entrypoint (the code that prints the suite name, likely in e2e_test.go/main test
setup) so it matches the README’s “ROSA HyperFleet API” terminology and both
docs and runtime output use the same name.
|
Auto-closing: this documentation update was not reviewed within 3 days. If the changes are still relevant, a new PR will be opened in a future run. |
1 participant
Automated Documentation Update
Changes Made
Renamed "ROSA Regional Platform" to "ROSA HyperFleet" in documentation prose and titles across 7 files:
rosa-regional-platformtorosa-hyperfleetTriggered By
Recent PRs (last 7 days):
Platform repo #665 renamed all references from "ROSA Regional Platform" to "ROSA HyperFleet", but this API repo still had 40+ stale references.
Overall Documentation Validation:
Deliberately left unfixed:
go.modmodule path (github.com/openshift/rosa-regional-platform-api) — changing would break all importsdeployment/manifests, Helm charts, ArgoCD apps — live k8s resource/namespace names/cc @jmelis @slopezz @iamkirkbater @ravitri — please review these updates.
Generated by Chai Bot documentation update task (weekly validation).
Summary by CodeRabbit