From 906d965a4a7df856bb591dad715602f2a21d02bb Mon Sep 17 00:00:00 2001 From: Juha Kukkonen Date: Wed, 27 Apr 2022 20:06:49 +0300 Subject: [PATCH] Bump up next release versions (#112) --- Cargo.toml | 4 ++-- README.md | 20 ++++++++++---------- src/lib.rs | 4 ++-- utoipa-gen/Cargo.toml | 2 +- utoipa-swagger-ui/Cargo.toml | 4 ++-- utoipa-swagger-ui/README.md | 11 ++++++----- utoipa-swagger-ui/src/lib.rs | 4 ++-- 7 files changed, 25 insertions(+), 24 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 3e6ba9fb..6ef95d08 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "utoipa" description = "Compile time generated OpenAPI documentation for Rust" -version = "0.2.1" +version = "1.0.0" edition = "2021" license = "MIT OR Apache-2.0" readme = "README.md" @@ -35,7 +35,7 @@ uuid = ["utoipa-gen/uuid"] serde = { version = "1.0", features = ["derive"] } serde_json = { version = "1.0", optional = true } serde_yaml = { version = "0.8", optional = true } -utoipa-gen = { version = "0.2.1", path = "./utoipa-gen" } +utoipa-gen = { version = "1.0.0", path = "./utoipa-gen" } [dev-dependencies] actix-web = { version = "4" } diff --git a/README.md b/README.md index 86579bbc..f3979cb1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # utoipa - Auto generated OpenAPI documentation [![Utoipa build](https://github.com/juhaku/utoipa/actions/workflows/build.yaml/badge.svg)](https://github.com/juhaku/utoipa/actions/workflows/build.yaml) -[![crates.io](https://img.shields.io/static/v1?label=crates.io&message=0.2.0&color=orange&logo=rust)](https://crates.io/crates/utoipa/0.2.0) -[![docs.rs](https://img.shields.io/static/v1?label=docs.rs&message=utoipa&color=blue&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K)](https://docs.rs/utoipa/0.2.0/utoipa/) +[![crates.io](https://img.shields.io/static/v1?label=crates.io&message=1.0.0&color=orange&logo=rust)](https://crates.io/crates/utoipa/1.0.0) +[![docs.rs](https://img.shields.io/static/v1?label=docs.rs&message=utoipa&color=blue&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K)](https://docs.rs/utoipa/1.0.0/utoipa/) ![rustc](https://img.shields.io/static/v1?label=rustc&message=1.60%2B&color=orange&logo=rust) Want to have your API documented with OpenAPI? But you dont want to see the @@ -50,9 +50,9 @@ and the `ipa` is _api_ reversed. Aaand... `ipa` is also awesome type of beer :be * **yaml** Enables **serde_yaml** serialization of OpenAPI objects. * **actix_extras** Enhances [actix-web](https://github.com/actix/actix-web/) intgration with being able to parse `path` and `path and query parameters` from actix web path attribute macros. See - [docs](https://docs.rs/utoipa/0.2.0/utoipa/attr.path.html#actix_extras-support-for-actix-web) or [examples](./examples) for more details. + [docs](https://docs.rs/utoipa/1.0.0/utoipa/attr.path.html#actix_extras-support-for-actix-web) or [examples](./examples) for more details. * **rocket_extras** Enhances [rocket](https://github.com/SergioBenitez/Rocket) framework integration with being - able to parse `path`, `path and query parameters` from rocket path attribute macros. See [docs](https://docs.rs/utoipa/0.2.0/utoipa/attr.path.html#rocket_extras-support-for-rocket) + able to parse `path`, `path and query parameters` from rocket path attribute macros. See [docs](https://docs.rs/utoipa/1.0.0/utoipa/attr.path.html#rocket_extras-support-for-rocket) or [examples](./examples) for more details. * **debug** Add extra traits such as debug traits to openapi definitions and elsewhere. * **chrono** Add support for [chrono](https://crates.io/crates/chrono) `DateTime`, `Date` and `Duration` @@ -64,25 +64,25 @@ and the `ipa` is _api_ reversed. Aaand... `ipa` is also awesome type of beer :be [RFC3339](https://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14) as `ISO-8601`. * **decimal** Add support for [rust_decimal](https://crates.io/crates/rust_decimal) `Decimal` type. **By default** it is interpreted as `String`. If you wish to change the format you need to override the type. - See the `value_type` in [component derive docs](https://docs.rs/utoipa/0.2.0/utoipa/derive.Component.html). + See the `value_type` in [component derive docs](https://docs.rs/utoipa/1.0.0/utoipa/derive.Component.html). * **uuid** Add support for [uuid](https://github.com/uuid-rs/uuid). `Uuid` type will be presented as `String` with format `uuid` in OpenAPI spec. -Utoipa implicitly has partial support for `serde` attributes. See [docs](https://docs.rs/utoipa/0.2.0/utoipa/derive.Component.html#partial-serde-attributes-support) for more details. +Utoipa implicitly has partial support for `serde` attributes. See [docs](https://docs.rs/utoipa/1.0.0/utoipa/derive.Component.html#partial-serde-attributes-support) for more details. ## Install Add minimal dependency declaration to Cargo.toml. ``` [dependencies] -utoipa = "0.2.0" +utoipa = "1.0.0" ``` To enable more features such as use actix framework extras you could define the dependency as follows. ``` [dependencies] -utoipa = { version = "0.2.0", features = ["actix_extras"] } +utoipa = { version = "1.0.0", features = ["actix_extras"] } ``` **Note!** To use `utoipa` together with Swagger UI you can use the [utoipa-swagger-ui](https://docs.rs/utoipa-swagger-ui/) crate. @@ -228,8 +228,8 @@ This would produce api doc something similar to: * See how to serve OpenAPI doc via Swagger UI check [utoipa-swagger-ui](https://docs.rs/utoipa-swagger-ui/) crate for more details. * Browse to [examples](https://github.com/juhaku/utoipa/tree/master/examples) for more comprehensive examples. -* Modify generated OpenAPI at runtime check [Modify](https://docs.rs/utoipa/0.2.0/utoipa/trait.Modify.html) trait for more details. -* More about OpenAPI security in [security documentation](https://docs.rs/utoipa/0.2.0/utoipa/openapi/security/index.html). +* Modify generated OpenAPI at runtime check [Modify](https://docs.rs/utoipa/1.0.0/utoipa/trait.Modify.html) trait for more details. +* More about OpenAPI security in [security documentation](https://docs.rs/utoipa/1.0.0/utoipa/openapi/security/index.html). # License diff --git a/src/lib.rs b/src/lib.rs index 97d7163b..8730d528 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -71,14 +71,14 @@ //! Add minimal dependency declaration to Cargo.toml. //! ```text //! [dependencies] -//! utoipa = "0.2.0" +//! utoipa = "1.0.0" //! ``` //! //! To enable more features such as use actix framework extras you could define the //! dependency as follows. //! ```text //! [dependencies] -//! utoipa = { version = "0.2.0", features = ["actix_extras"] } +//! utoipa = { version = "1.0.0", features = ["actix_extras"] } //! ``` //! //! **Note!** To use `utoipa` together with Swagger UI you can use the [`utoipa-swagger-ui`][utoipa_swagger] crate. diff --git a/utoipa-gen/Cargo.toml b/utoipa-gen/Cargo.toml index 427a99df..6ad2f654 100644 --- a/utoipa-gen/Cargo.toml +++ b/utoipa-gen/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "utoipa-gen" description = "Code generation implementation for utoipa" -version = "0.2.1" +version = "1.0.0" edition = "2021" license = "MIT OR Apache-2.0" readme = "README.md" diff --git a/utoipa-swagger-ui/Cargo.toml b/utoipa-swagger-ui/Cargo.toml index 004c4690..664d1106 100644 --- a/utoipa-swagger-ui/Cargo.toml +++ b/utoipa-swagger-ui/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "utoipa-swagger-ui" description = "Swagger UI for utoipa" -version = "0.3.1" +version = "1.0.0" edition = "2021" license = "MIT OR Apache-2.0" readme = "README.md" @@ -20,7 +20,7 @@ rust-embed = { version = "6.3", features = ["interpolate-folder-path"] } mime_guess = { version = "2.0" } actix-web = { version = "4", optional = true } rocket = { version = "0.5.0-rc.1", features = ["json"], optional = true } -utoipa = { version = "0.2", path = "..", default-features = false, features = [] } +utoipa = { version = "1", path = "..", default-features = false, features = [] } [package.metadata.docs.rs] features = ["actix-web", "rocket"] diff --git a/utoipa-swagger-ui/README.md b/utoipa-swagger-ui/README.md index e88dd93e..37a6c349 100644 --- a/utoipa-swagger-ui/README.md +++ b/utoipa-swagger-ui/README.md @@ -1,8 +1,9 @@ # utoipa-swagger-ui [![Utoipa build](https://github.com/juhaku/utoipa/actions/workflows/build.yaml/badge.svg)](https://github.com/juhaku/utoipa/actions/workflows/build.yaml) -[![crates.io](https://img.shields.io/static/v1?label=crates.io&message=0.3.0&color=orange&logo=rust)](https://crates.io/crates/utoipa-swagger-ui/0.3.0) -[![docs.rs](https://img.shields.io/static/v1?label=docs.rs&message=utoipa-swagger-ui&color=blue&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K)](https://docs.rs/utoipa-swagger-ui/0.3.0/utoipa_swagger_ui/) +[![crates.io](https://img.shields.io/static/v1?label=crates.io&message=1.0.0&color=orange&logo=rust)](https://crates.io/crates/utoipa-swagger-ui/1.0.0) +[![docs.rs](https://img.shields.io/static/v1?label=docs.rs&message=utoipa-swagger-ui&color=blue&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K)](https://docs.rs/utoipa-swagger-ui/1.0.0/utoipa_swagger_ui/) +![rustc](https://img.shields.io/static/v1?label=rustc&message=1.60%2B&color=orange&logo=rust) This crate implements necessary boiler plate code to serve Swagger UI via web server. It works as a bridge for serving the OpenAPI documetation created with @@ -15,7 +16,7 @@ works as a bridge for serving the OpenAPI documetation created with Serving Swagger UI is framework independant thus this crate also supports serving the Swagger UI with other frameworks as well. With other frameworks there is bit more manual implementation to be done. See -more details at [serve](https://docs.rs/utoipa-swagger-ui/0.3.0/utoipa_swagger_ui/fn.serve.html) or +more details at [serve](https://docs.rs/utoipa-swagger-ui/1.0.0/utoipa_swagger_ui/fn.serve.html) or [examples](https://github.com/juhaku/utoipa/tree/master/examples). # Features @@ -30,13 +31,13 @@ more details at [serve](https://docs.rs/utoipa-swagger-ui/0.3.0/utoipa_swagger_u Use only the raw types without any boiler plate implementation. ```text [dependencies] -utoipa-swagger-ui = "0.3.0" +utoipa-swagger-ui = "1.0.0" ``` Enable actix-web framework with Swagger UI you could define the dependency as follows. ```text [dependencies] -utoipa-swagger-ui = { version = "0.3.0", features = ["actix-web"] } +utoipa-swagger-ui = { version = "1.0.0", features = ["actix-web"] } ``` **Note!** Also remember that you already have defined `utoipa` dependency in your `Cargo.toml` diff --git a/utoipa-swagger-ui/src/lib.rs b/utoipa-swagger-ui/src/lib.rs index 4ac8effc..59806ecf 100644 --- a/utoipa-swagger-ui/src/lib.rs +++ b/utoipa-swagger-ui/src/lib.rs @@ -27,13 +27,13 @@ //! Use only the raw types without any boiler plate implementation. //! ```text //! [dependencies] -//! utoipa-swagger-ui = "0.3.0" +//! utoipa-swagger-ui = "1.0.0" //! //! ``` //! Enable actix-web framework with Swagger UI you could define the dependency as follows. //! ```text //! [dependencies] -//! utoipa-swagger-ui = { version = "0.3.0", features = ["actix-web"] } +//! utoipa-swagger-ui = { version = "1.0.0", features = ["actix-web"] } //! ``` //! //! **Note!** Also remember that you already have defined `utoipa` dependency in your `Cargo.toml`