Skip to content

Add description field #176

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

Merged
merged 4 commits into from
Sep 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion swagger.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,26 @@ info:
termsOfService: https://www.netlify.com/legal/terms-of-use/
externalDocs:
url: https://www.netlify.com/docs/api/
description: Netlify API online documentation
description: >-
Netlify is a hosting service for the programmable web. It understands your
documents and provides an API to handle atomic deploys of websites, manage
form submissions, inject JavaScript snippets, and much more. This is a
REST-style API that uses JSON for serialization and OAuth 2 for
authentication.


This document is an OpenAPI reference for the Netlify API that you can
explore. For more detailed instructions for common uses, please visit the
[online documentation](https://www.netlify.com/docs/api/). Visit our
Community forum to join the conversation about
[understanding and using Netlify’s API](https://community.netlify.com/t/common-issue-understanding-and-using-netlifys-api/160).


Additionally, we have two API clients for your convenience:

- [Go Client](https://github.com/netlify/open-api#go-client)

- [JS Client](https://github.com/netlify/js-client)
securityDefinitions:
netlifyAuth:
type: oauth2
Expand Down
8 changes: 7 additions & 1 deletion test/snapshots/main.js.md
Original file line number Diff line number Diff line change
Expand Up @@ -1950,7 +1950,13 @@ Generated by [AVA](https://ava.li).
},
},
externalDocs: {
description: 'Netlify API online documentation',
description: `Netlify is a hosting service for the programmable web. It understands your documents and provides an API to handle atomic deploys of websites, manage form submissions, inject JavaScript snippets, and much more. This is a REST-style API that uses JSON for serialization and OAuth 2 for authentication.␊
This document is an OpenAPI reference for the Netlify API that you can explore. For more detailed instructions for common uses, please visit the [online documentation](https://www.netlify.com/docs/api/). Visit our Community forum to join the conversation about [understanding and using Netlify’s API](https://community.netlify.com/t/common-issue-understanding-and-using-netlifys-api/160).␊
Additionally, we have two API clients for your convenience:␊
- [Go Client](https://github.com/netlify/open-api#go-client)␊
- [JS Client](https://github.com/netlify/js-client)`,
url: 'https://www.netlify.com/docs/api/',
},
host: 'api.netlify.com',
Expand Down
Binary file modified test/snapshots/main.js.snap
Binary file not shown.