Skip to content

Comments

Wp 7280 express docs#8004

Closed
derranW26 wants to merge 1 commit intomasterfrom
WP-7280-express-docs
Closed

Wp 7280 express docs#8004
derranW26 wants to merge 1 commit intomasterfrom
WP-7280-express-docs

Conversation

@derranW26
Copy link

Summary

This PR enables API documentation generation for the Express ping endpoint only. This is the first in a series of smaller PRs to gradually enable documentation for all Express API endpoints while keeping diffs manageable for the development team.

Background

The build-systems service uses OpenAI to generate API documentation from the express_entry.ts file. When all endpoints were enabled at once, the initial commit produced a diff that was too large (>10k lines), making it difficult for the development team to review.

Changes

  • ✅ Enabled ExpressPingApiSpec (ping endpoint) for documentation generation
  • ✅ Commented out all other API endpoint specs (38 remaining endpoints)
  • ✅ Commented out unnecessary imports
  • ✅ Updated ExpressApi type and object to only include ExpressPingApiSpec
  • ✅ Added PostSignerMacaroon import to match index.ts (commented out for now)

Next Steps

This PR will be followed by additional PRs that enable endpoints in batches:

  • Large endpoints (400+ lines): Will be committed individually
  • Medium endpoints (200-400 lines): Will be committed individually
  • Smaller endpoints (<200 lines): Will be batched in groups of 5

This approach ensures each PR's documentation diff stays under ~1,500-2,000 lines, making reviews more manageable.

Testing

  • Branch rebased onto latest master
  • File updated to match latest index.ts structure
  • Only ping endpoint enabled
  • All other endpoints commented out

Related

  • Ticket: WP-7280
  • Follow-up PRs will enable remaining endpoints incrementally

Add express_entry.ts to control OpenAPI doc generation. Starting with
ping endpoint only to validate the pipeline before adding more.

WP-7280

TICKET: WP-7280
@derranW26 derranW26 force-pushed the WP-7280-express-docs branch from eb8b547 to c36d00d Compare February 2, 2026 15:05
Copy link
Contributor

@pranavjain97 pranavjain97 left a comment

Choose a reason for hiding this comment

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

Not sure what this PR is doing? Why is it only uncommenting the ping endpoint?

@derranW26
Copy link
Author

derranW26 commented Feb 4, 2026

This shouldnt be a PR, Im using this branch to run the Express Api pipeline on

@derranW26 derranW26 closed this Feb 4, 2026
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