improve api gateway cors - #247
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the OrcaBusApiGateway construct to make API Gateway HTTP API CORS configuration more extensible, addressing #246 while preserving existing default behavior unless consumers opt in.
Changes:
- Added optional
corsAllowHeaders?: string[]andcorsExposeHeaders?: string[]toOrcaBusApiGatewayProps. - Extended the default CORS configuration to include
PUTand to append any additional allowed request headers. - Wired
corsExposeHeadersthrough tocorsPreflight.exposeHeadersand updated generated docs accordingly.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/api-gateway/api-gateway.ts | Adds new optional CORS props and applies them to HttpApi CORS preflight config (extra allow headers, PUT method, expose headers). |
| packages/docs/@orcabus/namespaces/apigateway/interfaces/OrcaBusApiGatewayProps.md | Updates generated interface docs to include the two new optional CORS props. |
| packages/docs/@orcabus/namespaces/apigateway/classes/OrcaBusApiGateway.md | Updates generated class docs to reflect source line shifts from the code change. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
williamputraintan
approved these changes
Jun 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolve issue #246
Make
OrcaBusApiGatewayCORS configuration more extensible for service-specific API requirements.This PR adds:
corsAllowHeaderscorsExposeHeadersPUTto the default CORS allowed methodsChanges
corsAllowHeaders?: string[]toOrcaBusApiGatewayPropscorsExposeHeaders?: string[]toOrcaBusApiGatewayPropsprops.corsAllowHeadersto the default CORSallowHeadersCorsHttpMethod.PUTto default CORSallowMethodsprops.corsExposeHeaderstocorsPreflight.exposeHeadersCompatibility
Existing services keep the same default CORS behavior unless they opt in to the new props.
corsAllowOriginsbehavior is unchanged.