feat: support nested routes and configurable stage in SecureRestApi#1720
Merged
Conversation
Contributor
|
haha, you beat me on this, @toddhainsworth I have this in my personal kanban too. Could you please also support |
Use IResource.resourceForPath instead of addResource so multi-segment route paths create their intermediate resources rather than throwing ResourceSPathPartOnly at synth time. Routes sharing a prefix resolve idempotently. Add a deployOptions prop (CDK StageOptions) so the deployed stage name and other stage settings are configurable; defaults to the CDK prod stage. Add tests for nested routes, intermediate resource creation, shared-prefix resolution, and custom/default stage name; update README and changeset (minor).
24b3357 to
2649bf8
Compare
Member
Author
☑️ |
AdamJHall
approved these changes
Jun 30, 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
Two changes to
@aligent/cdk-secure-rest-api(released together as aminor):Nested route paths
The
routeshelper only worked for single-segment paths. Any path with more than one segment (e.g.rewards/accounts/{accountId}/redeem) threwResourceSPathPartOnlyat synth time, because the construct passed the entire path toIResource.addResource, which only accepts a single path part. Swapped toIResource.resourceForPath, which splits on/, creates intermediate resources, and is idempotent for shared prefixes. The leading-slash strip is preserved for backwards compatibility.Configurable deployment stage (requested by Kai)
The stage name was always
prod(CDK's default). Added adeployOptions?: StageOptionsprop passed straight through to the underlyingRestApi, so callers can setstageName(and any other stage settings — logging, tracing, etc.). Defaults to the CDKprodstage when omitted.Changes
lib/secure-rest-api.ts—resourceForPath; newdeployOptionspropprodstageminor)Testing
yarn nx test secure-rest-api— 17/17 passyarn nx lint secure-rest-api— clean