Swagger-ui: Swagger-UI doesn't render model's description

Created on 30 Jun 2015  路  11Comments  路  Source: swagger-api/swagger-ui

According to https://github.com/swagger-api/swagger-ui/issues/751 , I expected swagger-ui to renders model's description, but it seem's it doesn't.
I checked my swagger JSON as it contains model's description.

Can you please let me know whether this feature has been implemented or not?

myModel:

{
description: "my model description.",
type: "object",
properties: {id: {format: "int32" ,description: "Property description.",type: "integer"}
}
feature

Most helpful comment

+1
No milestone for this feature ??

All 11 comments

feature request+1 !

+1

+1

The key benefit here is that you don't have to maintain two entirely different sets of documentation - a document that describes the domain model and entities, and the api calls to mine it.

Having the ability to expose a brief explanation of what an entity represents and how it is used would be of massive benefit.

+1

+1

+1

+1
No milestone for this feature ??

It does now.

@webron
Hi, I was just wondering, in which version the "model description feature" is released.

Should be any version under 3.x.

Was this page helpful?
0 / 5 - 0 ratings