An API for querying federated pediatric cancer data from the broader community.
Read the API specification »
·
Explore the CCDI Data Federation Resource »
Request Feature
·
Report A Bug
The specification is generated using the Rust packages contained with
packages
directory. In particular, utoipa
is used to autogenerate the
OpenAPI 3.0 specification. An Actix Web server is provided that (a) provides
the foundation for utoipa
to generate the API documentation and (b) provides
an example server using fake data. Please refer to the Learn Rust guide to
learn how to develop using Rust.
Contributions, issues, and feature requests are welcome! Feel free to check issues page.
- Changes are first discussed in the discussions section of the repo. The purpose of these discussions is to describe your idea(s), receive feedback from other implementors, and ultimately gain support within the community for these features.
- Once a set of changes has been approved via the discussions mechanism, work can commence on a pull request implementing these changes.
- This repository uses the Conventional Commit style for commit messages. Please make sure all commits conform to this style.
- This tooling that produces the API specification are versioned using the latest version of Semantic Versioning. The API itself is versioned according to the tooling that produced the specification (i.e., v1.0.0 of the tooling produces v1.0.0 of the specification).
- All changes will either be squashed and merged or rebased off of the
main
branch—no merge commits are allowed in this repository.
This project is licensed as either Apache 2.0 or MIT at your discretion.
Copyright © 2023-Present Childhood Cancer Data Initiative Federation