Implementation and Usage Description Sections?

[techana]

I think it would be nice to have two description sections: one for users describing how the resource will be used, and one for API developer describing how the resource should be implemented.

What do you think?

[tony tam]

Consider using “summary” and “description” for short / long explanations.  For extra long explanations the externalDocs should be used.

On May 20, 2016, at 10:46 AM, techana <tec...@gmail.com> wrote:

I think it would be nice to have two description sections: one for users describing how the resource will be used, and one for API developer describing how the resource should be implemented.

What do you think?

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[techana]

Yes, externalDocs will do. Thank you.

On Friday, May 20, 2016 at 5:49:32 PM UTC+3, tony tam wrote:

Consider using “summary” and “description” for short / long explanations.  For extra long explanations the externalDocs should be used.

On May 20, 2016, at 10:46 AM, techana <tec...@gmail.com> wrote:

I think it would be nice to have two description sections: one for users describing how the resource will be used, and one for API developer describing how the resource should be implemented.

What do you think?

--
You received this message because you are subscribed to the Google Groups "Swagger" group.

To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.

[techana]

I start adding externalDocs to my api description yaml file, but they are not rendered in editor or in UI! Any help please?