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

Confusing use of "zip" in sample SurfReport API request #39

Open
ghost opened this issue Mar 29, 2021 · 1 comment
Open

Confusing use of "zip" in sample SurfReport API request #39

ghost opened this issue Mar 29, 2021 · 1 comment

Comments

@ghost
Copy link

ghost commented Mar 29, 2021

URL: https://idratherbewriting.com/learnapidoc/docapis_finished_doc_result.html

In the example SurfReport API request in the Documenting API endpoints module, in keeping with the description of the path parameter, it would be preferable to replace zip with beachId to avoid confusion. (Also, a dummy beachID value could be used instead of an actual zip code?)

sample-surfreport-request

@ghost
Copy link
Author

ghost commented Mar 29, 2021

The example at https://idratherbewriting.com/learnapidoc/docapis_new_endpoint_to_doc.html does show a dummy beachId (123). However, the rest of the URL has a different format from that of the example shown above.

sample-surfreport-request-with-beachId

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

0 participants