Issues with defining JsonSchema

[dbartholomae]

Describe the bug

When hand-writing a schema where it is defined as const and trying to use it in apigateway, TypeScript rejects the schema:

const analyticsEventInputSchema = {
  // The next line is needed due to the unrelated issue described in #20055 
  type: JsonSchemaType.OBJECT,
  properties: {
    name: { type: 'string' }
  },
  required: ['name']
} as const

const analyticsEventModel = api.addModel("AnalyticsEvent", {
  modelName: "AnalyticsEvent",
  contentType: "application/json",
  schema: analyticsEventInputSchema,
});

Expected Behavior

This should just work

Current Behavior

Types of property 'required' are incompatible.
The type 'readonly ["name"]' is 'readonly' and cannot be assigned to the mutable type 'string[]'.

Reproduction Steps

If the example above is not enough to show the issue, I can create a reproducing repo.

Possible Solution

Change the array into a ReadonlyArray:
https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/aws-apigateway/lib/json-schema.ts#L70

Additional Information/Context

No response

CDK CLI Version

2.20.0

Framework Version

No response

Node.js Version

v16.13.1

OS

Windows 11

Language

Typescript

Language Version

No response

Other information

See #20055 for a related issue

[peterwoodworth]

Hey @dbartholomae, converting this to a discussion.

You're setting the type of the const as const. You'll want to set it as type JsonSchema, as that is the type the schema property expects in the addModel() method. Additionally, instead of inputting 'string' for properties.type, you'll want to use the JsonSchemaType enum. See below for a working example:

        const schema: JsonSchema = {
            type: JsonSchemaType.OBJECT,
            properties: {
                name: {
                    type: JsonSchemaType.STRING
                }
            },
            required: ['name']
        }
        api.addModel('event', {
            modelName: 'aanalytivcevent',
            contentType: 'application/json',
            schema: schema
        })

[dbartholomae]

Thanks! This unfortunately isn't a solution for this specific problem. Let's keep the discussion in one place for now:
#20055

[github-actions[bot]]

Hello! Reopening this discussion to make it searchable.