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.
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.
Resumable Uploads: Implementation of the Tus service as a library in a Golang application, facilitating high volume file uploads over HTTP.
Authentication: OAuth provider approval enforcement to ensure security.
Metadata Verification: Enforcement of upload submission metadata standards.
File Delivery: Routing of uploaded files to configured target destinations.
File Observability: Upload lifecycle event tracking and endpoints for health check, information, and application version.
Retry Delivery: Tool that delivers files to target destinations that uploaded successfully, but were unsuccessful in delivery.
User Interface: Facilitates uploads and observability within a user interface.
Utilized for test and CI/CD automation (/workflows).
Release Notes (/Release Notes), OAS3 API Documentation, and other relevant documentation.
Retry functionality that delivers files to target destinations that have uploaded successfully, but were unsuccessful in delivery.
Smoke test suites leveraging kotlin (/smoke/kotlin) and playwright (/smoke/playwright).
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.
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.
This repository is using the TUS resumable upload protocol: https://tus.io/, and reference implementation: https://github.com/tus/tusd
Example clients, for back-end or browser (front-end), to upload files: https://github.com/CDCgov/data-exchange-api-examples
- Upload routing configuration defined within the upload server; removes JSON configuration file dependency
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. 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.
The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.
This source code in this repository is free: you can redistribute it and/or modify it under the terms of the Apache Software License version 2, or (at your option) any later version.
This source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.
You should have received a copy of the Apache Software License along with this program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html.
The source code forked from other open source projects will inherit its license.
This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit http://www.cdc.gov/other/privacy.html.
Anyone is encouraged to contribute to the repository by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) 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 or later.
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.
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.
Please refer to CDC's Template Repositoryfor more information about contributing to this repository, public domain notices and disclaimers, and code of conduct.