API Gateway: api.node.defaultResource does not work

[RomainMuller]

Note: for support questions, please first reference our documentation, then use Stackoverflow. This repository's issues are intended for feature requests and bug reports.

• I'm submitting a ...

  • 🪲 bug report

• What is the current behavior?
  If the current behavior is a 🪲bug🪲: Please provide the steps to reproduce

const api: RestApi = /* ... */;
api.node.defaultResouce; // Throws an exception

• What is the expected behavior (or behavior of feature suggested)?

I expected api.node.defaultResource to return the CfnRestApi resource.

It turns out the RestApi construct registers the CfnRestApi as Resource and a virtual construct for the root resource (in the REST sense) as Default. This is surprising, as the CfnRestApi should be what is named Default, and the root REST resource should probably be called something like Root.

• Please tell us about your environment:

  • CDK CLI Version: 0.37.0
  • Module Version: 0.37.0
  • OS: all
  • Language: all

[nija-at]

Confirmed this still occurs in CDK version 1.10.0

Call to api.node.defaultChild on the RestApi resource throws the exception Cannot determine default child for FirstStack/BooksApi. There is both a child with id "Resource" and id "Default"