You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Updates the example to instantiate `RestApiWithSpec` in README so that
the constructor is used instead of the obsolete factory method.
- Bumps the version tag to `v0.2.0`.
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`.
@@ -32,11 +32,10 @@ As long as you are working on a CDK v2 project, you should not have to separatel
32
32
33
33
## Getting started
34
34
35
-
Please use [`RestApiWithSpec.createRestApi`](./api-docs/markdown/cdk-rest-api-with-spec.restapiwithspec.createrestapi.md) instead of the constructor of [`aws_apigateway.RestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html).
36
-
This function will return an object which augments [`aws_apigateway.RestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html) with the features to describe the OpenAPI definition.
35
+
Please instantiate [`RestApiWithSpec`](./api-docs/markdown/cdk-rest-api-with-spec.restapiwithspec.md) instead of [`aws_apigateway.RestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html).
37
36
38
37
```ts
39
-
const api =RestApiWithSpec.createRestApi(this, 'example-api', {
38
+
const api =newRestApiWithSpec(this, 'example-api', {
0 commit comments