tomjoht/learnapidoc

Confusing use of "zip" in sample SurfReport API request

Opened this issue · 1 comments

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

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