How do i add a description to a @BodyParams

[VictoriqueMoe]

I have the following params:

@Description("The file you want to upload")
        @MultipartFile("file")
        file?: PlatformMulterFile,

        @Description("The URL of the file you want to upload")
        @BodyParams("url")
        url?: string,

        @Description(
            "Set a password for this file, this will encrypt the file on the server that not even the server owner can obtain it, when fetching the file. you can fill out the `x-password` http header with your password to obtain the file via API",
        )
        @BodyParams("password")
        password?: string,

but the generated swagger doc is:

"requestBody": {
          "required": false,
          "description": "The file you want to upload",
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary"
                  },
                  "url": {
                    "type": "string"
                  },
                  "password": {
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          }
        },

as you can see, there is only one description and it's on the top level for some reason.

so in the UI, it looks weird

Is it possible to add description for each body param? or am i doing it wrong :(

[Romakita]

I have to fix the @tsed/schema. There is no workaround and this usecase isn't covered. I'll make a PR Asap!

[VictoriqueMoe]

@Romakita thank you, will keep my eyes open for the fix :)

[Romakita]

Fix released =D

[Romakita]

@VictoriqueMoe Have you tested the fix ?

See you ;)

[VictoriqueMoe]

ah, yes, i said it worked on your PR, buit sorry, didn't reply here. yes this works fine :)