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

Add caution message around "internal" API #30

Open
drew-russell opened this issue Jun 23, 2020 · 0 comments
Open

Add caution message around "internal" API #30

drew-russell opened this issue Jun 23, 2020 · 0 comments
Labels

Comments

@drew-russell
Copy link
Contributor

Describe the solution you'd like

For API calls that fall under the "internal" API version we include the following in the Response Header:

warning: 199 - This API Resource is subject to ongoing development. 
The endpoint and the parameters may change in the future. Only use this 
API when necessary. USE AT YOUR OWN RISK.

To prevent any potential issues with the API version we need to include a similar message in the Chrome extension. We could:

  • Add a UI element that "highlights" the internal API calls and then provides additional context (similar to the message above). Or maybe just add a UI element (think a small info icon) for all internal endpoints
  • Make sure to call out the warning in the API documentation (Link to API Documentation #14)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant