From ff63dda0cc788290948c70dd6853956a1c0f7b41 Mon Sep 17 00:00:00 2001 From: Clay McLeod Date: Mon, 25 Mar 2024 15:27:50 -0500 Subject: [PATCH] release: bumps version to v0.7.0 --- CHANGELOG.md | 28 +++++++++++++++++-- packages/Cargo.lock | 10 +++---- packages/Cargo.toml | 2 +- packages/ccdi-openapi/src/api.rs | 2 +- .../ccdi-server/src/responses/info/api.rs | 2 +- swagger.yml | 4 +-- 6 files changed, 36 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 766eaa4..e5682b1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -- Updates the name of the API to be the "CCDI Data Federation API". +## [v0.7.0] — 03-25-2024 + +### Added + +- Five new metadata elements were added for files ([#63](https://github.com/CBIIT/ccdi-federation-api/pull/63)). + - The identifier for the file (CDE 11284037 v1.00, [#52](https://github.com/CBIIT/ccdi-federation-api/discussions/#52)) + - The type of file (CDE 11416926 v1.00, [#53](https://github.com/CBIIT/ccdi-federation-api/discussions/#53)). + - The size of the file (CDE 11479876 v1.00, [#55](https://github.com/CBIIT/ccdi-federation-api/discussions/#55)). + - The md5 checksum of the file (CDE 11556150 v1.00, [#56](https://github.com/CBIIT/ccdi-federation-api/discussions/#56)). + - A description of the file (CDE 11280338 v1.00, [#54](https://github.com/CBIIT/ccdi-federation-api/discussions/#54)). - A `Namespace` now represents a top-level governance grouping of entities within the CCDI Federation API. See the new "Organizations", "Namespaces", and "Assigning Organizations and Namespaces" sections in the Swagger @@ -36,6 +45,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - The only current valid value for the `partition` query parameter at the moment is `namespace`, though this may be expanded in the future. +## Changed + +- Pagination is now required by default for primary entity root endpoints + (`/subject`, `/sample`, and `/file`) + ([#59](https://github.com/CBIIT/ccdi-federation-api/pull/59)). +- HTTPS served on port 443 is now required + ([#60](https://github.com/CBIIT/ccdi-federation-api/pull/60)). +- Updates the name of the API to be the "CCDI Data Federation API". + +## Fixed + +- The pagination via `Link` headers was fixed + (Thanks @e-t-k! [#61](https://github.com/CBIIT/ccdi-federation-api/pull/61)). + ## [v0.6.1] — 01-16-2024 ### Changed @@ -129,7 +152,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Adds Pediatric Cancer Data Commons (PCDC) endpoint ([#10](https://github.com/CBIIT/ccdi-federation-api/pull/10)). - Rust tooling was added to the `packages` directory ([#14](https://github.com/CBIIT/ccdi-federation-api/pull/14)). -[Unreleased]: https://github.com/cbiit/ccdi-federation-api/compare/v0.6.1...HEAD +[Unreleased]: https://github.com/cbiit/ccdi-federation-api/compare/v0.7.0...HEAD +[v0.7.0]: https://github.com/cbiit/ccdi-federation-api/compare/v0.6.1...v0.7.0 [v0.6.1]: https://github.com/cbiit/ccdi-federation-api/compare/v0.6.0...v0.6.1 [v0.6.0]: https://github.com/cbiit/ccdi-federation-api/compare/v0.5.0...v0.6.0 [v0.5.0]: https://github.com/cbiit/ccdi-federation-api/compare/v0.4.0...v0.5.0 diff --git a/packages/Cargo.lock b/packages/Cargo.lock index 6a8388f..e582842 100644 --- a/packages/Cargo.lock +++ b/packages/Cargo.lock @@ -404,7 +404,7 @@ dependencies = [ [[package]] name = "ccdi-cde" -version = "0.6.1" +version = "0.7.0" dependencies = [ "indexmap 2.0.2", "introspect", @@ -419,7 +419,7 @@ dependencies = [ [[package]] name = "ccdi-models" -version = "0.6.1" +version = "0.7.0" dependencies = [ "ccdi-cde", "chrono", @@ -440,7 +440,7 @@ dependencies = [ [[package]] name = "ccdi-openapi" -version = "0.6.1" +version = "0.7.0" dependencies = [ "ccdi-cde", "ccdi-models", @@ -450,7 +450,7 @@ dependencies = [ [[package]] name = "ccdi-server" -version = "0.6.1" +version = "0.7.0" dependencies = [ "actix-web", "ccdi-cde", @@ -474,7 +474,7 @@ dependencies = [ [[package]] name = "ccdi-spec" -version = "0.6.1" +version = "0.7.0" dependencies = [ "actix-web", "ccdi-cde", diff --git a/packages/Cargo.toml b/packages/Cargo.toml index ce2780a..d23f79b 100644 --- a/packages/Cargo.toml +++ b/packages/Cargo.toml @@ -11,7 +11,7 @@ resolver = "2" [workspace.package] license = "MIT OR Apache-2.0" edition = "2021" -version = "0.6.1" +version = "0.7.0" [workspace.dependencies] actix-web = "4.4.0" diff --git a/packages/ccdi-openapi/src/api.rs b/packages/ccdi-openapi/src/api.rs index b010b68..5d485de 100644 --- a/packages/ccdi-openapi/src/api.rs +++ b/packages/ccdi-openapi/src/api.rs @@ -207,7 +207,7 @@ partition primary entities to a set of namespaces under that situation: name = "Childhood Cancer Data Initiative support email", email = "NCIChildhoodCancerDataInitiative@mail.nih.gov", ), - version = "v0.6.1", + version = "v0.7.0", ), external_docs( description = "Learn more about the Childhood Cancer Data Initiative", diff --git a/packages/ccdi-server/src/responses/info/api.rs b/packages/ccdi-server/src/responses/info/api.rs index b1c36a0..7a2ddb9 100644 --- a/packages/ccdi-server/src/responses/info/api.rs +++ b/packages/ccdi-server/src/responses/info/api.rs @@ -10,7 +10,7 @@ use utoipa::ToSchema; #[schema(as = responses::info::api::Information)] pub struct Information { /// The version of the API that this server supports. - #[schema(example = "v0.6.1")] + #[schema(example = "v0.7.0")] api_version: String, /// A URL pointing to the latest version of the Swagger documentation. diff --git a/swagger.yml b/swagger.yml index 84b90a9..026be40 100644 --- a/swagger.yml +++ b/swagger.yml @@ -5,7 +5,7 @@ info: contact: name: Childhood Cancer Data Initiative support email email: NCIChildhoodCancerDataInitiative@mail.nih.gov - version: v0.6.1 + version: v0.7.0 servers: - url: https://ccdi.stjude.cloud/api/v0 description: St. Jude Children's Research Hospital CCDI API server @@ -2909,7 +2909,7 @@ components: api_version: type: string description: The version of the API that this server supports. - example: v0.6.1 + example: v0.7.0 documentation_url: type: string description: |-