How Do I Display Examples with FormData in Swagger UI?

[Jennifer Coston]

Hello,

I have an API that is displaying as below. However, I want it to show an example of the format for the json string that the user is required to enter with a larger box for the users to enter it. Is it possible to specify any of this is my YAML?



Here is my current YAML:

paths:
  /Plugin:
    post:
      tags:
        - Plugin
      summary: Upload Plugin
      description: This can only be done by the logged in user.
      operationId: createPlugin
      consumes:
      - "multipart/form-data"
      produces:
        - application/json
        - application/xml
      parameters:
        - in: formData
          name: json
          description: Uploaded Plugin
          required: true
          type: string
        - in: formData
          name: jarFile
          description: Jar File to upload
          required: true
          type: file
        - in: formData
          name: configFile
          description: config File to upload
          required: true
          type: file
      responses:
        200:
          description: successful operation

Thanks!
Jennifer

[smk]

Hi

I am facing the same issue. Can you please provide a solution if you resolved it? 

[Jennifer Coston]

It turns out this functionality isn't supported by the UI.

- Jennifer

On Jul 28, 2016 5:46 PM, "smk" <smuk...@gmail.com> wrote:

Hi , 

I am facing the same issue. Can you please provide an solution if you resolved it?

--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/w1_jPwWiGzE/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[smk]

Thanks for the update. In that case is there a way where we could write a custom json schema and let swagger find it to display in the model/schema.?

do you have any workarounds for this.?

To unsubscribe from this group and all its topics, send an email to swagger-swaggersocket+unsub...@googlegroups.com.