[BUG] [type-safe-api] Error: Path /path contains unsupported methods summary, description, parameters. Supported methods are get, put, post, delete, options, head, patch, trace.

[valebedu]

Describe the bug

When building a type-safe-api project with a valid OAS file with summary, description and/or parameters under a path, the build fail with error:

Error: Path /path contains unsupported methods summary, description, parameters. Supported methods are get, put, post, delete, options, head, patch, trace.

Expected Behavior

Theses fields should not be treated as methods

Current Behavior

The build fail with error:

@acme/infra: /Users/johndoe/Workspace/acme/api/template-api/node_modules/.pnpm/@aws+pdk@0.22.42_@aws-cdk+aws-cognito-identitypool-alpha@2.104.0-alpha.0_@pnpm+logger@5.0.0_@_rhxgvbrzwsnk24l3fokhskptm4/node_modules/@aws/pdk/type-safe-api/construct/prepare-spec-event-handler/prepare-spec.ts:309
@acme/infra:     throw new Error(
@acme/infra:           ^
@acme/infra: Error: Path /info contains unsupported methods summary, description. Supported methods are get, put, post, delete, options, head, patch, trace.
@acme/infra:     at preparePathSpec (/Users/johndoe/Workspace/acme/api/template-api/node_modules/.pnpm/@aws+pdk@0.22.42_@aws-cdk+aws-cognito-identitypool-alpha@2.104.0-alpha.0_@pnpm+logger@5.0.0_@_rhxgvbrzwsnk24l3fokhskptm4/node_modules/@aws/pdk/type-safe-api/construct/prepare-spec-event-handler/prepare-spec.ts:309:11)
@acme/infra:     at /Users/johndoe/Workspace/acme/api/template-api/node_modules/.pnpm/@aws+pdk@0.22.42_@aws-cdk+aws-cognito-identitypool-alpha@2.104.0-alpha.0_@pnpm+logger@5.0.0_@_rhxgvbrzwsnk24l3fokhskptm4/node_modules/@aws/pdk/type-safe-api/construct/prepare-spec-event-handler/prepare-spec.ts:569:11
@acme/infra:     at Array.map (<anonymous>)
@acme/infra:     at prepareApiSpec (/Users/johndoe/Workspace/acme/api/template-api/node_modules/.pnpm/@aws+pdk@0.22.42_@aws-cdk+aws-cognito-identitypool-alpha@2.104.0-alpha.0_@pnpm+logger@5.0.0_@_rhxgvbrzwsnk24l3fokhskptm4/node_modules/@aws/pdk/type-safe-api/construct/prepare-spec-event-handler/prepare-spec.ts:567:36)
@acme/infra:     at new TypeSafeRestApi (/Users/johndoe/Workspace/acme/api/template-api/node_modules/.pnpm/@aws+pdk@0.22.42_@aws-cdk+aws-cognito-identitypool-alpha@2.104.0-alpha.0_@pnpm+logger@5.0.0_@_rhxgvbrzwsnk24l3fokhskptm4/node_modules/@aws/pdk/type-safe-api/construct/type-safe-rest-api.ts:334:51)
@acme/infra:     at new Api (/Users/johndoe/Workspace/acme/api/template-api/packages/api/generated/infrastructure/typescript/src/api.ts:18:5)
@acme/infra:     at new ApiConstruct (/Users/johndoe/Workspace/acme/api/template-api/packages/api-infra/src/constructs/api.ts:43:16)
@acme/infra:     at new ApplicationStack (/Users/johndoe/Workspace/acme/api/template-api/packages/api-infra/src/stacks/application-stack.ts:17:5)
@acme/infra:     at /Users/johndoe/Workspace/acme/api/template-api/packages/api-infra/src/main.ts:24:3
@acme/infra:     at Object.<anonymous> (/Users/johndoe/Workspace/acme/api/template-api/packages/api-infra/src/main.ts:41:3)

Reproduction Steps

With the default projenrc.ts

import { MonorepoTsProject } from "@aws/pdk/monorepo";
import {
  DocumentationFormat,
  Language,
  Library,
  ModelLanguage,
  TypeSafeApiProject,
} from "@aws/pdk/type-safe-api";
import { InfrastructureTsProject } from "@aws/pdk/infrastructure";

// Create the monorepo
const monorepo = new MonorepoTsProject({
  name: "my-project",
  devDeps: [
    "@aws/pdk",
  ],
});

// Create the API project
const api = new TypeSafeApiProject({
  name: "myapi",
  parent: monorepo,
  outdir: "packages/api",
  // Smithy as the model language. You can also use ModelLanguage.OPENAPI
  model: {
    language: ModelLanguage.OPENAPI,
    options: {
      openapi: {
        title: 'Sample API',
      },
    },
  },
  // CDK infrastructure in TypeScript
  infrastructure: {
    language: Language.TYPESCRIPT,
  },
  // Lambda handlers in TypeScript
  handlers: {
    languages: [Language.TYPESCRIPT],
  }
  // Generate HTML documentation
  documentation: {
    formats: [DocumentationFormat.HTML_REDOC],
  },
  // Generate react-query hooks to interact with the UI from a React website
  library: {
    libraries: [Library.TYPESCRIPT_REACT_QUERY_HOOKS],
  },
});

// Create a CDK infrastructure project
new InfrastructureTsProject({
    parent: monorepo,
    outdir: "packages/infra",
    name: "infra",
    typeSafeApi: api,
});

monorepo.synth();

Run pdk

Then add in main.yaml under a path:

summary: Summary
description: Description
parameters:
  name: query
  in: query
  description: Query parameter
  required: false
  schema:
    type: string

Run pdk build

Please note that this is supported in official OAS https://spec.openapis.org/oas/latest.html#pathItemObject

Possible Solution

No response

Additional Information/Context

No response

PDK version used

0.22.42

What languages are you seeing this issue on?

Typescript

Environment details (OS name and version, etc.)

macOS Sonoma 14.1.1 Apple M1 Pro

[cogwirrel]

Thanks for raising this! Looks like summary, description and parameters are also supported under a path in OpenAPI 3.0.3 which is the version we officially support!

[cogwirrel]

Fixed in 0.22.48 😄