Skip to content

Document usage instructions for NoroSTAT #1209

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

Open
krivard opened this issue Jun 26, 2023 · 1 comment
Open

Document usage instructions for NoroSTAT #1209

krivard opened this issue Jun 26, 2023 · 1 comment
Labels
documentation prepandemic Affecting endpoints developed before 2020

Comments

@krivard
Copy link
Contributor

krivard commented Jun 26, 2023

The NoroSTAT endpoint has no useful documentation which might have prevented #1170. Proper endpoint documentation should include:

  • Authentication requirements
  • Required and optional request parameters
  • Valid locations, if public visibility of valid locations is permitted
@krivard krivard added documentation prepandemic Affecting endpoints developed before 2020 labels Jun 26, 2023
@krivard krivard changed the title Document usage for NoroSTAT Document usage instructions for NoroSTAT Jun 26, 2023
@brookslogan
Copy link
Contributor

Dropping some basic info here; not sure if formatting and fleshing this out properly is a priority, as we're not updating the DB with new data (but still wgetting it for history backup).

  • Authentication requirements: a key is required for any data. If we revive this endpoint I believe the auth parameter can probably be removed entirely, as it's a public, govt data set, and I don't see them state any restrictions on use.
  • Parameters: I expect all parameters are required: auth, locations, epiweeks for norostat and auth for the meta_norostat endpoint.
  • Valid locations: these change as the set of states in NoroSTAT changes. A list of valid locations is output by meta_norostat endpoint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation prepandemic Affecting endpoints developed before 2020
Projects
None yet
Development

No branches or pull requests

2 participants