Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace \n with spaces in swagger definitions #426

Closed
boosh opened this issue Jul 4, 2017 · 1 comment
Closed

Replace \n with spaces in swagger definitions #426

boosh opened this issue Jul 4, 2017 · 1 comment

Comments

@boosh
Copy link

boosh commented Jul 4, 2017

Multi-line comments in .proto files are inserted into generated swagger files complete with new line characters, e.g.:

message Event {
    // Resource name, e.g. `event/{datetime}`
    // where `datetime` is an ISO date
    string name = 1;
}

will be outputted as something like:

...
"name": {
      "type": "string",
      "title": "Resource name, e.g. `event/{datetime}`\nwhere `datetime` is an ISO date"
},

It'd be neater if \n characters were replaced with spaces.

@boosh
Copy link
Author

boosh commented Jul 4, 2017

Actually, this is probably correct.

@boosh boosh closed this as completed Jul 4, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant