Any way to add descriptions for query params and model properties ?

[the-dext]

Thanks for creating this serverless plugin, I've found it really useful.

Is there a way to document query string parameters and provide descriptions on model properties ?

[SamWSoftware]

Not yet. That was going to be the next feature.

[SamWSoftware]

This has recent;y been added

[jguerinet]

@SamWSoftware I see the documentation options for the query string parameters, is there a way to provide descriptions on the model properties?
When looking at my models, I see that if I put a comment in /** */ at the type level it gets parsed to be the description of the model. But if I put comments at the property level it doesn't get added as description for the property (all I see is title: ModelName.propertyName under the property type). Is there a way to add this with the current version of serverless-auto-swagger?

[bfaulk96]

@jguerinet We're using typeconv to convert TS to JSON Schema, so this is likely out of the scope of what we can accomplish in this library, although I haven't had time to look into improving types.

[jguerinet]

I dug a bit in typeconv and you can actually do this with the following syntax:

export type Object = {
    /** This will generate a description for the field */
    field: string;
};

Here's the result:

No way to remove the title field unfortunately, I find it a bit redundant but typeconv keeps it by default. The issue was discussed here, I have asked to see if it's something they would consider adding.

[chelodegli]

Is there a way to add "example" value in queryStringParameters?

I tried a few ways but didn't work, not sure if it's an actual feature.

I'm thinking something like this with a new key "example":

queryStringParameters: {
                  limit: {
                      required: false,
                      type: 'integer',
                      description: 'Maximum amount of registers to query',
                      example: 25,
                  }

[bfaulk96]

@chelodegli since it's a separate issue than this one, I moved your question to its own issue