8000 doc.go fails to compile when passed a certain invalid mime-type · Issue #1663 · go-swagger/go-swagger · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
doc.go fails to compile when passed a certain invalid mime-type #1663
Closed
@pa3ng

Description

@pa3ng

Problem statement

This is a relatively small issue, but it's something I wanted to point out.

I was running the generate server command on a spec that had a (probably invalid) mime-type value in the produces field. The value was */*. See spec below.

Upon generation, the generated comment block in the doc.go was escaped by an asterisk in the mentioned */* value. Meaning,

/*
  This comment block is now broken because of */*
*/

It doesn't seem like */* is a valid mime-type definition. Should this be handeled in the validation command?

Swagger specification

swagger.json

{
  "swagger": "2.0",
  "info": {
    "description": "From the todo list tutorial on goswagger.io",
    "title": "A Todo list application",
    "version": "1.0.0"
  },
  "consumes": [
    "application/io.goswagger.examples.todo-list.v1+json"
  ],
  "produces": [
    "application/io.goswagger.examples.todo-list.v1+json"
  ],
  "schemes": [
    "http"
  ],
  "paths": {
    "/": {
      "get": {
        "produces": [
          "*/*"
        ],
        "tags": [
          "todos"
        ],
        "parameters": [
          {
            "name": "since",
            "in": "query",
            "type": "integer",
            "format": "int64"
          },
          {
            "name": "limit",
            "in": "query",
            "type": "integer",
            "format": "int32",
            "default": 20
          }
        ],
        "responses": {
          "200": {
            "description": "list the todo operations",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/item"
              }
            }
          },
          "default": {
            "description": "generic error response",
            "schema": {
              "$ref": "#/definitions/error"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "item": {
      "type": "object",
      "required": [
        "description"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "description": {
          "type": "string",
          "minLength": 1
        },
        "completed": {
          "type": "boolean"
        }
      }
    },
    "error": {
      "type": "object",
      "required": [
        "message"
      ],
      "properties": {
        "code": {
          "type": "integer",
          "format": "int64"
        },
        "message": {
          "type": "string"
        }
      }
    }
  }
}

Steps to reproduce

swagger generate server -A example -f swagger.json

Environment

swagger version: 0.16.0
go version: 1.10.3
OS: OsS Sierra 10.12.6

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    0