Fix: Pass down parameters (#13) (#14)

* fix: request parameter schemas not passed down

- Fixes the bug that `requestParameterSchemas` of a parent resource were
  not passed down to child resources if they have non-null
  `defaultMethodOptions`. Merges `requestParameterSchemas` in
  `defaultMethodOptions` before passing `ResourceOptions` to the
  underlying `aws-apigateway.Resource.addResource` method so that the
  merge of `defaultMethodOptions` by `aws-apigateway.Resource` does not
  replace `requestParameterSchemas` of the parent resource.

issue #13

* chore: bump version to 0.2.3

- Bumps version to 0.2.3.
- Bumps `aws-cdk-lib` and `constructs` to the latest versions as of this
  commit. The installed versions in `pnpm-lock.yaml` were already the
  latest.

* feat(example): add nested path parameter

- Adds a nested path parameter `{photoId}` under `/pet/{petId}/photo` to
  test if parameters are passed down. The GET endpoint returns a PNG
  image of a single transparent dot, which is implemented in a new file
  `lib/example-stack.getimage.ts`.

* chore(example): update example output

* docs: update README

- Bumps version to 0.2.3 in the installation command.
- Bumps Node.js to 18.x in the authorizer example.

* docs: update API documentation

Author: kikuomax

README.ja.md

@@ -21,7 +21,7 @@
 このレポジトリを依存関係(`dependencies`)に追加してください。
 
 ```sh
-npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.2.2
+npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.2.3
 ```
 
 このライブラリはCDK v2プロジェクトで使用することを想定しており、以下のモジュールは`dependencies`ではなく`peerDependencies`に含んでいます。
@@ -297,7 +297,7 @@ const authorizer = augmentAuthorizer(
     {
       handler: new nodejs.NodejsFunction(this, 'authorizer', {
         description: 'Example authorizer',
-        runtime: lambda.Runtime.NODEJS_16_X,
+        runtime: lambda.Runtime.NODEJS_18_X,
       }),
     },
   ),

README.md

@@ -21,7 +21,7 @@ This library is implemented for the CDK **version 2** (CDK v2) and does not work
 Please add this repository to your dependencies.
 
 ```sh
-npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.2.2
+npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.2.3
 ```
 
 This library is supposed to be used in a CDK v2 project, so it does not include the following modules in the `dependencies` but does in the `peerDependencies`.
@@ -297,7 +297,7 @@ const authorizer = augmentAuthorizer(
     {
       handler: new nodejs.NodejsFunction(this, 'authorizer', {
         description: 'Example authorizer',
-        runtime: lambda.Runtime.NODEJS_16_X,
+        runtime: lambda.Runtime.NODEJS_18_X,
       }),
     },
   ),

api-docs/markdown/cdk-rest-api-with-spec.augmentauthorizer.md

@@ -4,12 +4,12 @@
 
 ## augmentAuthorizer() function
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
 Makes a given [aws\_apigateway.IAuthorizer](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IAuthorizer.html) an [IAuthorizerWithSpec](./cdk-rest-api-with-spec.iauthorizerwithspec.md) by augmenting it with a specified security scheme object.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export declare function augmentAuthorizer(authorizer: apigateway.IAuthorizer, securitySchemeObject: SecuritySchemeObject): IAuthorizerWithSpec;
@@ -22,7 +22,7 @@ export declare function augmentAuthorizer(authorizer: apigateway.IAuthorizer, se
 |  authorizer | apigateway.IAuthorizer | Authorizer to be augmented. |
 |  securitySchemeObject | SecuritySchemeObject | Security scheme object to add to <code>authorizer</code>. |
 
-<b>Returns:</b>
+**Returns:**
 
 [IAuthorizerWithSpec](./cdk-rest-api-with-spec.iauthorizerwithspec.md)
 

api-docs/markdown/cdk-rest-api-with-spec.iauthorizerwithspec.md

@@ -4,21 +4,21 @@
 
 ## IAuthorizerWithSpec interface
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
 Authorizer augmented with the features to describe the OpenAPI definition.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export interface IAuthorizerWithSpec extends apigateway.IAuthorizer 
 ```
-<b>Extends:</b> apigateway.IAuthorizer
+**Extends:** apigateway.IAuthorizer
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [securitySchemeObject?](./cdk-rest-api-with-spec.iauthorizerwithspec.securityschemeobject.md) |  | SecuritySchemeObject | <b><i>(BETA)</i></b> <i>(Optional)</i> Security scheme object representing this authorizer. |
+|  [securitySchemeObject?](./cdk-rest-api-with-spec.iauthorizerwithspec.securityschemeobject.md) |  | SecuritySchemeObject | **_(BETA)_** _(Optional)_ Security scheme object representing this authorizer. |
 

api-docs/markdown/cdk-rest-api-with-spec.iauthorizerwithspec.securityschemeobject.md

@@ -4,12 +4,12 @@
 
 ## IAuthorizerWithSpec.securitySchemeObject property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
 Security scheme object representing this authorizer.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 securitySchemeObject?: SecuritySchemeObject;

api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.addmethod.md

@@ -4,12 +4,12 @@
 
 ## IResourceWithSpec.addMethod() method
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
 Adds a method with the OpenAPI definition.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 addMethod(httpMethod: string, target?: apigateway.Integration, options?: MethodOptionsWithSpec): apigateway.Method;
@@ -20,10 +20,10 @@ addMethod(httpMethod: string, target?: apigateway.Integration, options?: MethodO
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  httpMethod | string |  |
-|  target | apigateway.Integration | <i>(Optional)</i> |
-|  options | [MethodOptionsWithSpec](./cdk-rest-api-with-spec.methodoptionswithspec.md) | <i>(Optional)</i> |
+|  target | apigateway.Integration | _(Optional)_ |
+|  options | [MethodOptionsWithSpec](./cdk-rest-api-with-spec.methodoptionswithspec.md) | _(Optional)_ |
 
-<b>Returns:</b>
+**Returns:**
 
 apigateway.Method
 

api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.addresource.md

@@ -4,12 +4,12 @@
 
 ## IResourceWithSpec.addResource() method
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
 Adds a new child resource with the OpenAPI definition.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 addResource(pathPart: string, options?: ResourceOptionsWithSpec): IResourceWithSpec;
@@ -20,9 +20,9 @@ addResource(pathPart: string, options?: ResourceOptionsWithSpec): IResourceWithS
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  pathPart | string |  |
-|  options | [ResourceOptionsWithSpec](./cdk-rest-api-with-spec.resourceoptionswithspec.md) | <i>(Optional)</i> |
+|  options | [ResourceOptionsWithSpec](./cdk-rest-api-with-spec.resourceoptionswithspec.md) | _(Optional)_ |
 
-<b>Returns:</b>
+**Returns:**
 
 [IResourceWithSpec](./cdk-rest-api-with-spec.iresourcewithspec.md)
 

api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.defaultmethodoptions.md

@@ -4,12 +4,12 @@
 
 ## IResourceWithSpec.defaultMethodOptions property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
 Default method options with the OpenAPI definition.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 defaultMethodOptions?: MethodOptionsWithSpec;

api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.md

@@ -4,17 +4,17 @@
 
 ## IResourceWithSpec interface
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
 [aws\_apigateway.IResource](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IResource.html) augmented with the features to build the OpenAPI definition.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export interface IResourceWithSpec extends apigateway.Resource 
 ```
-<b>Extends:</b> apigateway.Resource
+**Extends:** apigateway.Resource
 
 ## Remarks
 
@@ -24,13 +24,13 @@ Although this interface actually inherits [aws\_apigateway.Resource](https://doc
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [defaultMethodOptions?](./cdk-rest-api-with-spec.iresourcewithspec.defaultmethodoptions.md) |  | [MethodOptionsWithSpec](./cdk-rest-api-with-spec.methodoptionswithspec.md) | <b><i>(BETA)</i></b> <i>(Optional)</i> Default method options with the OpenAPI definition. |
-|  [parentResource?](./cdk-rest-api-with-spec.iresourcewithspec.parentresource.md) |  | [IResourceWithSpec](./cdk-rest-api-with-spec.iresourcewithspec.md) | <b><i>(BETA)</i></b> <i>(Optional)</i> Parent resource. |
+|  [defaultMethodOptions?](./cdk-rest-api-with-spec.iresourcewithspec.defaultmethodoptions.md) |  | [MethodOptionsWithSpec](./cdk-rest-api-with-spec.methodoptionswithspec.md) | **_(BETA)_** _(Optional)_ Default method options with the OpenAPI definition. |
+|  [parentResource?](./cdk-rest-api-with-spec.iresourcewithspec.parentresource.md) |  | [IResourceWithSpec](./cdk-rest-api-with-spec.iresourcewithspec.md) | **_(BETA)_** _(Optional)_ Parent resource. |
 
 ## Methods
 
 |  Method | Description |
 |  --- | --- |
-|  [addMethod(httpMethod, target, options)](./cdk-rest-api-with-spec.iresourcewithspec.addmethod.md) | <b><i>(BETA)</i></b> Adds a method with the OpenAPI definition. |
-|  [addResource(pathPart, options)](./cdk-rest-api-with-spec.iresourcewithspec.addresource.md) | <b><i>(BETA)</i></b> Adds a new child resource with the OpenAPI definition. |
+|  [addMethod(httpMethod, target, options)](./cdk-rest-api-with-spec.iresourcewithspec.addmethod.md) | **_(BETA)_** Adds a method with the OpenAPI definition. |
+|  [addResource(pathPart, options)](./cdk-rest-api-with-spec.iresourcewithspec.addresource.md) | **_(BETA)_** Adds a new child resource with the OpenAPI definition. |
 

api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.parentresource.md

@@ -4,12 +4,12 @@
 
 ## IResourceWithSpec.parentResource property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
 Parent resource.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 parentResource?: IResourceWithSpec;