You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-13Lines changed: 16 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,9 @@
1
1
# CDC Data Exchange (DEX) Upload
2
2
3
-
The CDC Data Exchage (DEX) Upload API is an open-source service created to support public health Data Senders in their effort to share critical public health data with internal CDC Programs. The open-source model allows users to tailor the tool to fit specific data needs. <br/>
3
+
The CDC Data Exchange (DEX) Upload API is an open-source service created to support public health data providers in their effort to share critical public health information with internal CDC Programs. The open-source model allows users to tailor the tool to fit specific data needs. <br/>
4
4
5
5
The Upload API service is a highly scalable, highly reliable means of transiting files of nearly any type and size from public health partners to the CDC, even when sent over unreliable network connections.
6
6
7
-
8
7
## Upload Services
9
8
10
9
**Resumable Uploads**: Implementation of the Tus service as a library in a Golang application, facilitating high volume file uploads over HTTP.
@@ -15,7 +14,7 @@ The Upload API service is a highly scalable, highly reliable means of transiting
15
14
16
15
**File Delivery**: Routing of uploaded files to configured target destinations.
17
16
18
-
**File Observability**: Upload lifecycle event tracking and endpoints for health check, information, and application version.
17
+
**File Observability**: Upload lifecycle event tracking, open telemetry traces and metrics, and endpoints for health check, information, and application version.
19
18
20
19
**Retry Delivery**: Tool that delivers files to target destinations that uploaded successfully, but were unsuccessful in delivery.
21
20
@@ -42,37 +41,45 @@ Smoke test suites leveraging kotlin (`/smoke/kotlin`) and playwright (`/smoke/pl
42
41
-[Kotlin Smoke Test README](https://github.com/CDCgov/data-exchange-upload/blob/main/tests/smoke/kotlin/README.md)
43
42
-[Playwright Smoke Test README](https://github.com/CDCgov/data-exchange-upload/blob/main/tests/smoke/playwright/README.md)
44
43
44
+
Load testing tool enabling high volumes of file uploads (`/bad-uploader`).
Configuration files containing manifest schema values and routing delivery details for specific data stream use cases (`/v2`). The JSON configuration files are utilized to verify metadata accommpanying uploads and to determine file delivery to specified target locations.
49
+
Configuration files containing manifest schema values and routing delivery details for specific data stream use cases. JSON configuration files are utilized to verify metadata accommpanying uploads and to determine file delivery to specified target locations.
Go application that fetches data from the [Processing Status GraphQL API](https://github.com/CDCgov/data-exchange-processing-status), generates a CSV report, and optionally uploads it to S3.
Upload server functionality leveraging Tus v2 capabilities written in Golang. Capabilities include resumable file uploads, metadata verification, event routing, observability endpoints, file delivery, distributed file locking, OAuth token verification, user interface, unit testing, and integration testing.
53
65
-[Upload Server README](https://github.com/CDCgov/data-exchange-upload/blob/main/upload-server/readme.md)
54
66
55
-
56
67
## TUS Protocol
57
68
58
69
This repository is using the TUS resumable upload protocol: [https://tus.io/](https://tus.io/), and reference implementation: [https://github.com/tus/tusd](https://github.com/tus/tusd)
59
70
60
-
61
71
## Example Usage
62
72
63
73
Example clients, for back-end or browser (front-end), to upload files: [https://github.com/CDCgov/data-exchange-api-examples](https://github.com/CDCgov/data-exchange-api-examples)
64
74
65
-
66
75
## Future Improvements
67
76
68
77
- Upload routing configuration defined within the upload server; removes JSON configuration file dependency
69
78
70
-
71
79
## Public Domain Standard Notice
72
80
73
81
This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/). All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.
74
82
75
-
76
83
## License Standard Notice
77
84
78
85
The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later. <br/>
@@ -85,24 +92,20 @@ You should have received a copy of the Apache Software License along with this p
85
92
86
93
The source code forked from other open source projects will inherit its license.
87
94
88
-
89
95
## Privacy Standard Notice
90
96
91
97
This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the [Disclaimer](https://github.com/CDCgov/template/blob/master/DISCLAIMER.md) and [Code of Conduct](https://github.com/CDCgov/template/blob/mastercode-of-conduct.md). For more information about CDC's privacy policy, please visit [http://www.cdc.gov/other/privacy.html](https://www.cdc.gov/other/privacy.html).
92
98
93
-
94
99
## Contributing Standard Notice
95
100
96
101
Anyone is encouraged to contribute to the repository by [forking](https://help.github.com/articles/fork-a-repo) and submitting a pull request. (If you are new to GitHub, you might start with a [basic tutorial](https://help.github.com/articles/set-up-git).) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the [Apache Software License v2](http://www.apache.org/licenses/LICENSE-2.0.html) or later. <br/>
97
102
98
103
All comments, messages, pull requests, and other submissions received through CDC including this GitHub page may be subject to applicable federal law, including but not limited to the Federal Records Act, and may be archived. Learn more at [http://www.cdc.gov/other/privacy.html](http://www.cdc.gov/other/privacy.html).
99
104
100
-
101
105
## Records Management Standard Notice
102
106
103
107
This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the [CDC web site](http://www.cdc.gov).
104
108
105
-
106
109
## Additional Standard Notices
107
110
108
111
Please refer to [CDC's Template Repository](https://github.com/CDCgov/template)for more information about [contributing to this repository](https://github.com/CDCgov/template/blob/master/CONTRIBUTING.md), [public domain notices and disclaimers](https://github.com/CDCgov/template/blob/master/DISCLAIMER.md), and [code of conduct](https://github.com/CDCgov/template/blob/master/code-of-conduct.md).
0 commit comments