Skip to content

Commit e1e97be

Browse files
committed
docs(V5): document V5 API migration and add V5 signal documentation
1 parent 71ea28c commit e1e97be

19 files changed

Lines changed: 191 additions & 6 deletions

docs/api/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ nav_order: 4
66

77
# Other Endpoints
88

9+
> **Active endpoints are part of the legacy V4 API, which is being phased out.** See the [V4 to V5 Migration Guide](v5_migration.md) for details on the Delphi V5 transition.
10+
{: .warning }
11+
912
This is the home of [Delphi](https://delphi.cmu.edu/)'s epidemiological data
1013
API for tracking infectious diseases such as influenza, dengue,
1114
and norovirus. Note that additional data, including most COVID-19 signals, is

docs/api/covidcast-signals/doctor-visits.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ grand_parent: Main Endpoint (COVIDcast)
55
nav_order: 1
66
---
77

8+
> **Heads up:** This COVIDcast source is part of the legacy V4 API, which is being phased out. An actively maintained equivalent is available in V5 under the source `claims_data_outpatient`. See the [V4 to V5 Migration Guide](../v5_migration.md) for full details.
9+
{: .warning }
10+
811
# Doctor Visits
912
{: .no_toc}
1013

docs/api/covidcast-signals/hospital-admissions.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ grand_parent: Main Endpoint (COVIDcast)
55
nav_order: 1
66
---
77

8+
> **Heads up:** This COVIDcast source is part of the legacy V4 API, which is being phased out. An actively maintained equivalent is available in V5 under the source `claims_data_inpatient`. See the [V4 to V5 Migration Guide](../v5_migration.md) for full details.
9+
{: .warning }
10+
811
# Hospital Admissions
912
{: .no_toc}
1013

docs/api/covidcast-signals/nchs-mortality.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ grand_parent: Main Endpoint (COVIDcast)
55
nav_order: 1
66
---
77

8+
> **Heads up:** The legacy v4 Epidata API is being phased out. Check the [V4 to V5 Source Coverage](../v5_signals.md#v4-to-v5-source-coverage) table or query [`/epidata/v5/metadata/`](../v5_meta.md) directly (more up to date) for whether this source is available in V5 yet. See the [V4 to V5 Migration Guide](../v5_migration.md) for full details.
9+
{: .warning }
10+
811
# NCHS Mortality Data
912
{: .no_toc}
1013

docs/api/covidcast-signals/nhsn.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ parent: Data Sources and Signals
44
grand_parent: Main Endpoint (COVIDcast)
55
nav_order: 1
66
---
7+
8+
> **Heads up:** This COVIDcast source is part of the legacy V4 API, which is being phased out. An actively maintained equivalent is available in V5 under the source `nhsn`. See the [V4 to V5 Migration Guide](../v5_migration.md) for full details.
9+
{: .warning }
10+
711
# National Healthcare Safety Network Respiratory Hospitalizations
812
{: .no_toc}
913

docs/api/covidcast-signals/nssp.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ parent: Data Sources and Signals
44
grand_parent: Main Endpoint (COVIDcast)
55
nav_order: 1
66
---
7+
8+
> **Heads up:** This COVIDcast source is part of the legacy V4 API, which is being phased out. An actively maintained equivalent is available in V5 under the source `nssp`. See the [V4 to V5 Migration Guide](../v5_migration.md) for full details.
9+
{: .warning }
10+
711
# National Syndromic Surveillance Program Emergency Department Visits
812
{: .no_toc}
913

docs/api/covidcast-signals/quidel.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ grand_parent: Main Endpoint (COVIDcast)
55
nav_order: 1
66
---
77

8+
> **Heads up:** The legacy v4 Epidata API is being phased out. Check the [V4 to V5 Source Coverage](../v5_signals.md#v4-to-v5-source-coverage) table or query [`/epidata/v5/metadata/`](../v5_meta.md) directly (more up to date) for whether this source is available in V5 yet. See the [V4 to V5 Migration Guide](../v5_migration.md) for full details.
9+
{: .warning }
10+
811
# Quidel
912
{: .no_toc}
1013

docs/api/covidcast.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ nav_order: 3
66

77
# Main Epidata API
88

9+
> **This endpoint (`/epidata/covidcast/`) is part of the legacy V4 API, which is being phased out.** The legacy V4 API includes this endpoint. See the [V4 to V5 Migration Guide](v5_migration.md) for guidance on migrating your queries to the [Delphi V5 API](v5.md).
10+
{: .warning }
11+
912
This legacy Epidata API endpoint was formerly called COVIDcast.
1013

1114
This is the documentation for accessing all Delphi's indicators via the `covidcast` endpoint of [Delphi](https://delphi.cmu.edu/)'s

docs/api/covidcast_meta.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ grand_parent: Main Endpoint (COVIDcast)
55
nav_order: 0
66
---
77

8+
> **Heads up:** The legacy v4 Epidata API is being phased out. Please use the [V5 Metadata Discovery Endpoints](v5_meta.md) instead of this endpoint. See the [V4 to V5 Migration Guide](v5_migration.md) for full details.
9+
{: .warning }
10+
811
# COVIDcast Metadata
912

1013
The COVIDcast metadata endpoint (endpoint `covidcast_meta`) provides a list of all

docs/api/covidcast_signals.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ nav_order: 3
55
has_children: true
66

77
---
8+
9+
> **Heads up:** The legacy v4 Epidata API is being phased out. See the [V4 to V5 Migration Guide](v5_migration.md) and the [V4 to V5 Source Coverage](v5_signals.md#v4-to-v5-source-coverage) table for full details.
10+
{: .warning }
11+
812
# Delphi's COVID-19 Data Sources and Signals
913

1014
Delphi's COVID-19 Surveillance Streams data includes the following data sources.

0 commit comments

Comments
 (0)