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

include swagger endpoint description in the generated doc #135

Open
nofun97 opened this issue Jul 7, 2020 · 0 comments
Open

include swagger endpoint description in the generated doc #135

nofun97 opened this issue Jul 7, 2020 · 0 comments
Labels
enhancement New feature or request P0

Comments

@nofun97
Copy link
Member

nofun97 commented Jul 7, 2020

For example this swagger:

{
	"swagger": "2.0",
	"info": {
		"title": "Sample API",
		"description": "API description in Markdown.",
		"version": "1.0.0"
	},
	"host": "api.example.com",
	"basePath": "/v1",
	"schemes": [
		"https"
	],
	"paths": {
		"/users": {
			"get": {
				"summary": "Returns a list of users.",
				"description": "Optional extended description in Markdown.",
				"produces": [
					"application/json"
				],
				"responses": {
					"200": {
						"description": "OK"
					}
				}
			}
		}
	}
}

The endpoint GET /users has a description Returns a list of users in the summary field but this information is not included in the generated doc.
image

@nofun97 nofun97 added the enhancement New feature or request label Jul 7, 2020
@ChloePlanet ChloePlanet added the P0 label Jul 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request P0
Projects
None yet
Development

No branches or pull requests

2 participants