Typefiles fields description

[mzawitowski]

Hi,

Are there any plans to add a possibility to describe fields in a *.ts files which are used to generate request and response swagger doc?

Regards,
Michal.

[bfaulk96]

I assume @mzawitowski is asking the same question as @jguerinet was in #2 (comment), so I'll post my answer here:

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]

If you are indeed talking about field descriptions, there is actually a way of doing that. More info in my answer here.

[bfaulk96]

I'm going to go ahead and repost your solution, just so it's here to answer the question:

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 grantila/typeconv#13, I have asked to see if it's something they would consider adding.