(ApiGateway): Support loading API gateway Model schemas from an object

[mongeon]

Description

I would like to load JsonSchema from a class definition and populate a JsonSchema object.

Use Case

Being able to add models and validation in my ApiGateway definition based on a class. This will enable model validation at the ApiGateway level and won't call my lambda function.

Proposed Solution

This is a C# example:

var schema = JsonSchema.FromType<MyClass>();

var requestValidator = new RequestValidator(this, "APayloadValidator", new RequestValidatorProps
{
    RestApi = api,
    RequestValidatorName = "my-payload-validator",
    ValidateRequestBody = true
});

var model = new Model(this, "AModel", new ModelProps
{
    ContentType = "application/json",
    ModelName = "A-Model-name",
    RestApi = api,
    Schema = schema
});

resource.AddMethod(HttpMethod.Post, Integration, new MethodOptions
{
    RequestValidator = requestValidator,
    RequestModels = new Dictionary<string, IModel>
    {
        {"application/json", model }
    }
});

Other information

Similar to #17470 and #10818

See the JsonSchema implementation from code from others library: http://json-schema.org/implementations.html#from-code

Acknowledge

• I may be able to implement this feature request
• This feature might incur a breaking change

[github-actions]

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

[tomvonheill]

Dang, this is what I am looking for too. Any other way to create the models from the schemas? I'm still getting _ErrorResponse(error='Error: Resolution error: Supplied properties not correct for "CfnModelProps"\n schema: "{\\"title\\": \\"DateRange\\", \\"type\\": \\"object\\", \\"properties\\": {\\"startDate\\": {\\"title\\": \\"Startdate\\", \\"type\\": \\"string\\", \\"format\\": \\"date\\"}, \\"endDate\\": {\\"title\\": \\"Enddate\\", \\"type\\": \\"string\\", \\"format\\": \\"date\\"}}, \\"required\\": [\\"startDate\\", \\"endDate\\"]}" should be an \'object\'.', stack='@jsii/kernel.RuntimeError: Error: Resolution error: Supplied properties not correct for "CfnModelProps"\n schema: "{\\"title\\": \\"DateRange\\", \\"type\\": \\"object\\", \\"properties\\": {\\"startDate\\": {\\"title\\": \\"Startdate\\", \\"type\\": \\"string\\", \\"format\\": \\"date\\"}, \\"endDate\\": {\\"title\\": \\"Enddate\\", \\"type\\": \\"string\\", \\"format\\": \\"date\\"}}, \\"required\\": [\\"startDate\\", \\"endDate\\"]}" should be an \'object\'.\n at Kernel._ensureSync (/private/var/folders/9y/p5rv7rqx75j18s_3ttrlnxrw0000gq/T/tmpu60weq22/lib/program.js:10369:27)\n at Kernel.invoke (/private/var/folders/9y/p5rv7rqx75j18s_3ttrlnxrw0000gq/T/tmpu60weq22/lib/program.js:9769:34)\n at KernelHost.processRequest (/private/var/folders/9y/p5rv7rqx75j18s_3ttrlnxrw0000gq/T/tmpu60weq22/lib/program.js:11544:36)\n at KernelHost.run (/private/var/folders/9y/p5rv7rqx75j18s_3ttrlnxrw0000gq/T/tmpu60weq22/lib/program.js:11504:22)\n at Immediate._onImmediate (/private/var/folders/9y/p5rv7rqx75j18s_3ttrlnxrw0000gq/T/tmpu60weq22/lib/program.js:11505:46)\n at process.processImmediate (node:internal/timers:471:21)', name='@jsii/kernel.RuntimeError') which doesn't make too much sense to me. We need it to be a json schema and not converting automatically from json schema strings?