feat: remove IBaseResourceWithSpec

- Replaces `IBaseResourceWithSpec` with `IResourceWithSpec` because
  the properties of `Resource` and `IResource` are the same.

issue #5

Author: kikuomax

src/models.ts

@@ -13,7 +13,7 @@ import { JsonSchemaEx } from './json-schema-ex';
  */
 export interface IRestApiWithSpec extends apigateway.IRestApi {
   /** Root resource ('/') with the features to build the OpenAPI definition. */
-  root: IBaseResourceWithSpec;
+  readonly root: IResourceWithSpec;
 
   /** Adds a new model. */
   addModel(id: string, props: ModelOptionsWithSpec): apigateway.Model;
@@ -25,46 +25,10 @@ export interface IRestApiWithSpec extends apigateway.IRestApi {
  *
  * @remarks
  *
- * This interface duplicates {@link IResourceWithSpec} but is necessary because
- * {@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html#root | aws_apigateway.RestApi.root}
- * might not satisfy
- * {@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.Resource.html | aws_apigateway.Resource}.
- *
- * It might not be obvious but this interface is a super-interface of
- * {@link IResourceWithSpec}.
- *
- * @beta
- */
-export interface IBaseResourceWithSpec extends apigateway.IResource {
-  /** Default method options with the OpenAPI definition. */
-  defaultMethodOptions?: MethodOptionsWithSpec;
-
-  /**
-   * Parent resource.
-   *
-   * @remarks
-   *
-   * `undefined` if this resource represents the root.
-   */
-  parentResource?: IBaseResourceWithSpec;
-
-  /** Adds a new child resource with the OpenAPI definition. */
-  addResource(
-    pathPart: string,
-    options?: ResourceOptionsWithSpec,
-  ): IResourceWithSpec;
-
-  /** Adds a method with the OpenAPI definition. */
-  addMethod(
-    httpMethod: string,
-    target?: apigateway.Integration,
-    options?: MethodOptionsWithSpec,
-  ): apigateway.Method;
-}
-
-/**
- * {@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.Resource.html | aws_apigateway.Resource}
- * augmented with the features to build the OpenAPI definition.
+ * Although this interface actually inherits
+ * {@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.Resource.html | aws_apigateway.Resource},
+ * you should rely on only properties defined in
+ * {@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IResource.html | aws_apigateway.IResource}.
  *
  * @beta
  */
@@ -79,7 +43,7 @@ export interface IResourceWithSpec extends apigateway.Resource {
    *
    * `undefined` if this resource is the root.
    */
-  parentResource?: IBaseResourceWithSpec;
+  parentResource?: IResourceWithSpec;
 
   /** Adds a new child resource with the OpenAPI definition. */
   addResource(
@@ -196,6 +160,10 @@ export interface MethodOptionsWithSpec extends apigateway.MethodOptions {
    * {@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.MethodOptions.html#requestparameters | requestParameters}
    * and `requestParameterSchemas` are specified, `requestParameterSchemas`
    * precedes.
+   *
+   * Please refer to
+   * {@link https://github.com/metadevpro/openapi3-ts | OpenApi3-TS}
+   * for more details about `BaseParameterObject`.
    */
   requestParameterSchemas?: { [key: string]: BaseParameterObject };
   /**

src/rest-api-with-spec.ts

@@ -12,7 +12,6 @@ import {
 
 import { translateJsonSchemaEx } from './json-schema-ex';
 import {
-  IBaseResourceWithSpec,
   IResourceWithSpec,
   IRestApiWithSpec,
   MethodOptionsWithSpec,
@@ -184,7 +183,7 @@ class ResourceWithSpec {
     private builder: OpenApiBuilder,
     private restApi: IRestApiWithSpec,
     private resource: apigateway.IResource,
-    private parent?: IBaseResourceWithSpec,
+    private parent?: IResourceWithSpec,
   ) {}
 
   /**
@@ -213,7 +212,7 @@ class ResourceWithSpec {
     builder: OpenApiBuilder,
     restApi: IRestApiWithSpec,
     resource: apigateway.IResource,
-    parent?: IBaseResourceWithSpec,
+    parent?: IResourceWithSpec,
   ): IResourceWithSpec {
     const wrapper = new ResourceWithSpec(builder, restApi, resource, parent);
     wrapper.facade = new Proxy(resource, {
@@ -335,7 +334,7 @@ class ResourceWithSpec {
  * @private
  */
 function translatePathPart(
-  resource: IBaseResourceWithSpec,
+  resource: IResourceWithSpec,
 ): ParameterObject[] | undefined {
   // locates /{name} at the end
   const match = resource.path.match(/\/\{(.+)\}$/);