Add description field
#176
Conversation
|
Deploy preview for open-api ready! Built with commit 0606b4e |
swagger.yml
Outdated
|
|
||
|
|
||
| This document describes common usage in some detail. There is also an | ||
| OpenAPI reference for the Netlify API that you can explore. Visit our |
There was a problem hiding this comment.
The "OpenAPI reference" mentioned here is this very page! I would reverse those two descriptions. In other words, explain that this site is a reference, and for more detailed instructions for common uses, visit netlify.com/docs/api.
swagger.yml
Outdated
|
|
||
| This document describes common usage in some detail. There is also an | ||
| OpenAPI reference for the Netlify API that you can explore. Visit our | ||
| Community forum to join the conversation about understanding and using |
There was a problem hiding this comment.
I'd also add back the community link that's in that intro at netlify.com/docs/api.
ehmicky
force-pushed
the
doc/add-description
branch
from
cbab012 to
741fb4c
Compare
|
Thanks for the review @DavidWells and @verythorough! Note that Swagger UI does not seem to understand Markdown in description (although that's valid OpenAPI), so it's shown as one big link with no formatting. However the new UI based ReDoc (#182) should fix that. |
ehmicky
force-pushed
the
doc/add-description
branch
from
29dcbf3 to
fd10aae
Compare
This adds a
descriptionfield which shows up on top the documentation explaining what Netlify API does.