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

Guidance for marking an API as a prototype #28

Open
Ryandaydev opened this issue Apr 18, 2017 · 0 comments
Open

Guidance for marking an API as a prototype #28

Ryandaydev opened this issue Apr 18, 2017 · 0 comments

Comments

@Ryandaydev
Copy link

Ryandaydev commented Apr 18, 2017

Add guidance for methods that can be used to mark an API as a prototype, non-production API.

A few methods we have implemented with the City Pairs Prototype:

  • API documentation includes "Prototype" in the title.
  • API documentation includes the following statement "It is not a production API, and it is not intended for use by the public."
  • API version is "V0"
  • Response object contains a message "This is a prototype API. These results are for demonstration purposes only." in the payload.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant