Skip to content

W-22219984-ch-API-endpoints-reorg-kt#877

Merged
kevintroller merged 4 commits intolatestfrom
W-22219984-ch-API-endpoints-reorg-kt
Apr 28, 2026
Merged

W-22219984-ch-API-endpoints-reorg-kt#877
kevintroller merged 4 commits intolatestfrom
W-22219984-ch-API-endpoints-reorg-kt

Conversation

@kevintroller
Copy link
Copy Markdown
Contributor

@kevintroller kevintroller commented Apr 24, 2026

Summary

  • Adds a new "Quick Reference: Common API Endpoints" section to cloudhub-api.adoc with categorized tables covering Applications, Logs, Notifications/Alerts, Schedules, Load Balancers, VPCs/VPNs/TGWs, and Diagnostics endpoints.
  • Each category includes cross-references to the relevant feature-specific pages that contain detailed curl examples (e.g., lb-download-logs.adoc, lb-cert-validation.adoc, create-vpc-cli.adoc).
  • Preserves all existing content and continues to defer to the Exchange interactive API reference for full specifications.

Test plan

  • Verify the AsciiDoc tables render correctly in the Antora site build.
  • Confirm all xref: cross-references resolve to valid pages.
  • Review endpoint paths for accuracy against the Exchange API reference.

Consolidate commonly used CloudHub API endpoints into categorized tables
(Applications, Logs, Notifications/Alerts, Schedules, Load Balancers,
VPCs/VPNs/TGWs, Diagnostics) with cross-references to feature-specific
pages for detailed curl examples.

Made-with: Cursor
@kevintroller kevintroller requested a review from a team as a code owner April 24, 2026 20:47
@kevintroller kevintroller changed the title W-22219984: Add quick-reference API endpoint tables to CloudHub API page W-22219984-ch-API-endpoints-reorg-kt Apr 24, 2026
…erence page

Move the endpoint tables from cloudhub-api.adoc into a new dedicated
cloudhub-api-reference.adoc page, matching the CH2 reference format.
Add xref from the main API page and register in nav.

Made-with: Cursor
- Correct LB creation path to include vpcId
- Update VPN paths to use /ipsec under VPCs
- Add GET and PUT for Transit Gateway attachments
- Replace single diagnostics endpoint with full set of seven endpoints

Made-with: Cursor
[%header,cols="10,45,45"]
|===
|Method |Endpoint |Description
|`GET` |`/applications` |List all applications.
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.

(Globally) Only full sentences should take final period.

** xref:tgw-troubleshoot.adoc[Troubleshoot Transit Gateway Attachments]
* xref:cloudhub-cli.adoc[CloudHub CLI]
* xref:cloudhub-api.adoc[CloudHub API]
** xref:cloudhub-api-reference.adoc[CloudHub API Reference]
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.

Suggested change
** xref:cloudhub-api-reference.adoc[CloudHub API Reference]
** xref:cloudhub-api-reference.adoc[]

@kevintroller kevintroller merged commit bcf150e into latest Apr 28, 2026
4 checks passed
@kevintroller kevintroller deleted the W-22219984-ch-API-endpoints-reorg-kt branch April 28, 2026 14:02
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