add example to string parameter in request body

[eric-lee-ltk]

Problem statement

When I generate spec from go code, the example and default tag of string parameter in request body is missing

Swagger specification

expected:

{
            "description": "desc",
            "name": "Body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "string",
              "example": "example"
            }
}

actual:

{
            "description": "desc",
            "name": "Body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "string"
            }
}

Steps to reproduce

original code:

// swagger:parameters Service
type Req struct {
    // desc
    // in: body
    // required: true
    // example: example
    Body string
}

Environment

swagger version: v0.20.1
go version: 1.12.7
OS: CentOS 6

[ilyakaznacheev]

@eric-lee-ltk it works for me.

Go code

package main

// swagger:route GET /foobar foobar-tag Service

// swagger:parameters Service
type Req struct {
	// desc
	// in: body
	// required: true
	// example: example
	Body string
}

generated json:

{
  "swagger": "2.0",
  "paths": {
    "/foobar": {
      "get": {
        "tags": [
          "foobar-tag"
        ],
        "operationId": "Service",
        "parameters": [
          {
            "example": "example",
            "description": "desc",
            "name": "Body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    }
  }
}

What am I missing?

[eric-lee-ltk]

@ilyakaznacheev I just copy and paste your generated json to swagger ui .

There has a structural error: should NOT have additional properties additionalProperty: example and the value in example dialog is still string instead of example.

It seems that the example section should be part of schema section instead of parameters section. Following is a working result:

[rashmi-tondare]

@eric-lee-ltk were you able to successfully add an example to a request body field? I'm still facing the same issue where the "example" field is wrongly getting added under parameters instead of schema. Or is there another way to set an example field?

[starsz]

Hi, @eric-lee-ltk maybe you can try this.

package main

type Body struct {
    // example: example
    Fielld string `json:"field"`
}

// swagger:route GET /foobar foobar-tag Service

// swagger:parameters Service
type Req struct {
    // desc
    // in: body
    // required: true
    Body Body `json:",inline"`
}

It's look good to me.