ROSAENG-62641: [docs-agent] Update API documentation formatting and stale wording

[redhat-chai-bot]

Automated Documentation Update

Changes Made

Content fix (1 file):

• docs/api/passthrough-design.md: Fixed stale wording — removed "on this branch" phrasing left over from a feature branch that has long since merged to main.

Formatting fixes (13 files):

• Applied npx prettier formatting across all markdown files to fix table alignment and whitespace inconsistencies.
• Files: .github/ISSUE_TEMPLATE/bug_report.md, .github/ISSUE_TEMPLATE/feature_request.md, clientset/docs/architecture.md, docs/api/api-management.md, docs/api/v2-sdk-rosa-integration.md, docs/api/zoa-endpoints.md, docs/authz.md, docs/e2e-lifecycle-testing.md, docs/konflux/quay-image-tags.md, hack/api-codegen/README.md, hyperfleet-operator/docs/quickstart.md, hyperfleet-operator/docs/sharding.md

Triggered By

Recent PRs (last 7 days):

• No recent PRs required documentation changes — all doc-touching PRs handled their own updates.

Overall Documentation Validation:

• CLAUDE.md: Accurate, no changes needed
• docs/: Fixed stale wording in passthrough-design.md
• Formatting: 13 files had prettier violations, now fixed
• Cross-repo consistency: API docs align with platform docs

Security scan: Passed. Pre-existing example AWS account IDs (123456789012) verified as unchanged placeholder values.

---

Generated by Chai Bot documentation update task (weekly validation).

---

AI-generated. Review for accuracy.

Automated by scheduled task rosa_hyperfleet_docs_update (instructions: ship_help_bot/shared/instructions/scheduled/rosa_hyperfleet_docs_update.md, run: d575a91f, commit: a3b17607-dirty)

Summary by CodeRabbit

• Documentation

  • Improved Markdown table formatting and alignment across architecture, API, authorization, testing, integration, and operational guides.
  • Expanded compact JSON and response examples for clearer reading.
  • Clarified documented error translation output, including the HTTP 403 response example.
  • Improved readability of quickstart, sharding, code generation, and image-tagging documentation without changing content or behavior.

• Chores

  • Standardized issue template metadata formatting and removed unnecessary trailing spaces.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: openshift-online/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: d1bfc5b7-aab0-4742-aa28-1dceff0e7024

📥 Commits

Reviewing files that changed from the base of the PR and between c882180 and 76e14f3.

📒 Files selected for processing (13)

• .github/ISSUE_TEMPLATE/bug_report.md
• .github/ISSUE_TEMPLATE/feature_request.md
• clientset/docs/architecture.md
• docs/api/api-management.md
• docs/api/passthrough-design.md
• docs/api/v2-sdk-rosa-integration.md
• docs/api/zoa-endpoints.md
• docs/authz.md
• docs/e2e-lifecycle-testing.md
• docs/konflux/quay-image-tags.md
• hack/api-codegen/README.md
• hyperfleet-operator/docs/quickstart.md
• hyperfleet-operator/docs/sharding.md

---

Walkthrough

This pull request standardizes Markdown formatting across documentation, expands compact JSON examples, adjusts emphasis syntax, removes trailing spaces, and normalizes issue-template metadata. Documented behavior, API contracts, test entries, and configuration semantics remain unchanged.

Changes

Documentation formatting

Layer / File(s)	Summary
Issue template cleanup .github/ISSUE_TEMPLATE/*	Issue templates use consistent double-quoted empty metadata values and omit trailing spaces from prompts.
Architecture examples and mappings clientset/docs/architecture.md	Transport mappings, response examples, field mappings, and platform error examples use expanded Markdown and readable JSON formatting.
API documentation formatting docs/api/*	API tables, emphasis syntax, endpoint examples, error references, and DynamoDB schema tables were reformatted without changing documented contracts.
Authorization and lifecycle documentation docs/authz.md, docs/e2e-lifecycle-testing.md	Authorization and lifecycle testing tables were aligned. The Cedar example includes a blank line.
Operational and developer documentation docs/konflux/*, hack/api-codegen/README.md, hyperfleet-operator/docs/*	Operational, code-generation, quickstart, and sharding tables were reformatted without changing their values or meanings.

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

Merge Risk: ⚪ Minimal · up to 76e14

This PR only updates documentation wording and Markdown formatting; no actionable merge-blocking risk remains after normal checks and review.

Suggested labels: lgtm, approved

Suggested reviewers: typeid

🚥 Pre-merge checks | ✅ 10 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Ai-Attribution	⚠️ Warning	AI use is stated in the PR and commit; the changed commit has Co-Authored-By: Claude Opus 4.6 but no Assisted-by or Generated-by Red Hat trailer.	Remove the AI Co-Authored-By trailer and add the required Red Hat Assisted-by or Generated-by trailer.

✅ Passed checks (10 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
No-Weak-Crypto	✅ Passed	The commit changes only 13 Markdown files. No MD5, SHA1, DES, RC4, 3DES, Blowfish, ECB, or custom crypto implementation was introduced; the existing DES-CBC3-SHA entry is unchanged.
Container-Privileges	✅ Passed	The PR changes only 13 Markdown files; the parent-to-HEAD diff adds no privilege, host namespace, SYS_ADMIN, or allowPrivilegeEscalation settings.
No-Sensitive-Data-In-Logs	✅ Passed	All 13 changed paths are Markdown. The diff contains formatting, JSON layout, emphasis, and wording edits only; no logging calls or sensitive literals were added.
No-Hardcoded-Secrets	✅ Passed	HEAD^..HEAD adds only Markdown formatting, examples, and stale-wording edits; scans found no new secret assignments, private keys, base64 strings, or credential URLs. The existing PostgreSQL placeh...
No-Injection-Vectors	✅ Passed	The diff changes only 13 Markdown files; added-line analysis found no SQL concatenation, shell=True, eval/exec, pickle.loads, unsafe yaml.load, os.system, or dangerouslySetInnerHTML.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies the API documentation formatting updates and the removal of stale wording, which match the primary changes.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

_{Comment @coderabbitai help to get the list of available commands.}

[cdoan1]

/retest

[cdoan1]

/approve
/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cdoan1, redhat-chai-bot

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [cdoan1]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[openshift-ci-robot]

@redhat-chai-bot: This pull request references ROSAENG-62641 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the epic to target the "5.1.0" version, but no target version was set.

Details

In response to this:

Automated Documentation Update

Changes Made

Content fix (1 file):

• docs/api/passthrough-design.md: Fixed stale wording — removed "on this branch" phrasing left over from a feature branch that has long since merged to main.

Formatting fixes (13 files):

• Applied npx prettier formatting across all markdown files to fix table alignment and whitespace inconsistencies.
• Files: .github/ISSUE_TEMPLATE/bug_report.md, .github/ISSUE_TEMPLATE/feature_request.md, clientset/docs/architecture.md, docs/api/api-management.md, docs/api/v2-sdk-rosa-integration.md, docs/api/zoa-endpoints.md, docs/authz.md, docs/e2e-lifecycle-testing.md, docs/konflux/quay-image-tags.md, hack/api-codegen/README.md, hyperfleet-operator/docs/quickstart.md, hyperfleet-operator/docs/sharding.md

Triggered By

Recent PRs (last 7 days):

• No recent PRs required documentation changes — all doc-touching PRs handled their own updates.

Overall Documentation Validation:

• CLAUDE.md: Accurate, no changes needed
• docs/: Fixed stale wording in passthrough-design.md
• Formatting: 13 files had prettier violations, now fixed
• Cross-repo consistency: API docs align with platform docs

Security scan: Passed. Pre-existing example AWS account IDs (123456789012) verified as unchanged placeholder values.

---

Generated by Chai Bot documentation update task (weekly validation).

---

AI-generated. Review for accuracy.

Automated by scheduled task rosa_hyperfleet_docs_update (instructions: ship_help_bot/shared/instructions/scheduled/rosa_hyperfleet_docs_update.md, run: d575a91f, commit: a3b17607-dirty)

Summary by CodeRabbit

• Documentation

• Improved Markdown table formatting and alignment across architecture, API, authorization, testing, integration, and operational guides.

• Expanded compact JSON and response examples for clearer reading.

• Clarified documented error translation output, including the HTTP 403 response example.

• Improved readability of quickstart, sharding, code generation, and image-tagging documentation without changing content or behavior.

• Chores

• Standardized issue template metadata formatting and removed unnecessary trailing spaces.

Instructions 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 openshift-eng/jira-lifecycle-plugin repository.