Skip to content

Conversation

@danielzhao122
Copy link
Contributor

@danielzhao122 danielzhao122 commented Oct 15, 2025

Added openapi-generator.rc.js for custom codecs
Added express tags to all express endpoints

ticket: WP-6196

@danielzhao122 danielzhao122 force-pushed the WP-6196-add-openapi-generator-rc-js branch 3 times, most recently from 9cd98a7 to be54765 Compare October 23, 2025 20:22
@danielzhao122 danielzhao122 marked this pull request as ready for review October 23, 2025 20:48
@danielzhao122 danielzhao122 requested review from a team as code owners October 23, 2025 20:48
@pranavjain97 pranavjain97 requested a review from Copilot October 23, 2025 21:01
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds OpenAPI generator support to the Express module by introducing custom codec definitions and ensuring all Express endpoints are properly tagged. The changes facilitate API documentation generation by providing custom schema mappings for io-ts types and standardizing endpoint metadata.

Key changes:

  • Added openapi-generator.rc.js configuration file with custom codecs for JSON schema generation
  • Created JsonFromStringifiedJson schema utility to replace inline codec definitions
  • Added @tag express annotations to all Express API endpoints

Reviewed Changes

Copilot reviewed 26 out of 26 changed files in this pull request and generated 18 comments.

Show a summary per file
File Description
modules/express/src/typedRoutes/schemas/jsonFromStringifedJson.ts New schema utility for JSON parsing from stringified JSON
modules/express/src/typedRoutes/api/v2/ofcSignPayload.ts Refactored to use centralized JsonFromStringifiedJson and added express tag
modules/express/src/typedRoutes/api/v2/*.ts Added express tag to v2 API endpoints
modules/express/src/typedRoutes/api/v1/*.ts Added express tag to v1 API endpoints
modules/express/src/typedRoutes/api/common/*.ts Added express tag to common API endpoints
modules/express/package.json Added source field pointing to API index
modules/express/openapi-generator.rc.js Configuration file defining custom codecs for OpenAPI generation

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

pranavjain97
pranavjain97 previously approved these changes Oct 23, 2025
Copy link
Contributor

@zahin-mohammad zahin-mohammad left a comment

Choose a reason for hiding this comment

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

Copilot comments seem valid, could we do a quick pass to fix these issues? Other than that lgtm.

@danielzhao122 danielzhao122 force-pushed the WP-6196-add-openapi-generator-rc-js branch from 157c9ac to 24b9260 Compare October 24, 2025 00:04
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 29 out of 29 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@danielzhao122 danielzhao122 merged commit c19b6cb into master Oct 27, 2025
13 checks passed
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.

5 participants