Skip to content

Better describe meaning/context of endpoints in documentation #233

Open
@nmdefries

Description

@nmdefries

These are many issues with lack of information in the Epidata doc website. We'll probably end up mirroring info from there, so will need to wait for those to be updated (project planned for this semester, maybe).

  • unclear what pub_covid_hosp_facility signal cols represent. There are covariance columns (names end with "_cov")??
  • what locations are allowed for pub_flusurv?
  • pub_ecdc_ili not clear what are valid region names. Example uses a (lowercase and unabbreviated) country name. online docs don't list allowed regions either, and is basically a stub.
  • pub_kcdc_ili not clear what are valid region names. Example uses a (uppercase and abbreviated) acronym -- unclear what it means. online docs don't list allowed regions either, and is basically a stub. Nowhere does it say what the KCDC is or link to any additional info
  • Private endpoints need more info about authorization required. Can non-Delphi users get access to the private endpoints? Why are they private?
  • hard to tell that pub_nidss_flu has non-US data, has Taiwanese data, and what the regions to request are
  • can't tell what pub_meta returns. What API? How is it different than pub_covidcast_meta? Docs and blurb in avail_endpoints need more fleshing out

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions