Skip to content

Commit

Permalink
chore(doc): more spelling fixes (#142)
Browse files Browse the repository at this point in the history
Co-authored-by: Josh Gramoll <[email protected]>
  • Loading branch information
jgramoll and Josh Gramoll authored May 16, 2022
1 parent 070b00c commit e2b7dc0
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 44 deletions.
28 changes: 14 additions & 14 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
//! Want to have your API documented with OpenAPI? But you dont want to see the
//! Want to have your API documented with OpenAPI? But you don't want to see the
//! trouble with manual yaml or json tweaking? Would like it to be so easy that it would almost
//! be like utopic? Don't worry utoipa is just there to fill this gap. It aims to do if not all then
//! the most of heavy lifting for you enabling you to focus writing the actual API logic instead of
//! documentation. It aims to be *minimal*, *simple* and *fast*. It uses simple proc macros which
//! you can use to annotate your code to have items documented.
//!
//! Utoipa crate provides autogenerated OpenAPI documentation for Rust REST APIs. It treats
//! code first appoach as a first class citizen and simplifies API documentation by providing
//! code first approach as a first class citizen and simplifies API documentation by providing
//! simple macros for generating the documentation from your code.
//!
//! It also contains Rust types of OpenAPI spec allowing you to write the OpenAPI spec only using
//! Rust if autogeneration is not your flavor or does not fit your purpose.
//! Rust if auto-generation is not your flavor or does not fit your purpose.
//!
//! Long term goal of the library is to be the place to go when OpenAPI documentation is needed in Rust
//! codebase.
Expand All @@ -31,7 +31,7 @@
//! * **tide**
//! * **rocket**
//!
//! Even if there is no example for your favourite framework `utoipa` can be used with any
//! Even if there is no example for your favorite framework `utoipa` can be used with any
//! web framework which supports decorating functions with macros similarly to **warp** and **tide** examples.
//!
//! # What's up with the word play?
Expand All @@ -45,7 +45,7 @@
//! * **json** Enables **serde_json** serialization of OpenAPI objects which also allows usage of JSON within
//! OpenAPI values e.g. within `example` value. This is enabled by default.
//! * **yaml** Enables **serde_yaml** serialization of OpenAPI objects.
//! * **actix_extras** Enhances [actix-web](https://github.com/actix/actix-web/) intgration with being able to
//! * **actix_extras** Enhances [actix-web](https://github.com/actix/actix-web/) integration with being able to
//! parse `path` and `path and query parameters` from actix web path attribute macros. See [actix extras support][actix_path] or
//! [examples](https://github.com/juhaku/utoipa/tree/master/examples) for more details.
//! * **rocket_extras** Enhances [rocket](https://github.com/SergioBenitez/Rocket) framework integration with being
Expand Down Expand Up @@ -119,7 +119,7 @@
//! get,
//! path = "/pets/{id}",
//! responses(
//! (status = 200, description = "Pet found succesfully", body = Pet),
//! (status = 200, description = "Pet found successfully", body = Pet),
//! (status = 404, description = "Pet was not found")
//! ),
//! params(
Expand Down Expand Up @@ -155,7 +155,7 @@
//! # get,
//! # path = "/pets/{id}",
//! # responses(
//! # (status = 200, description = "Pet found succesfully", body = Pet),
//! # (status = 200, description = "Pet found successfully", body = Pet),
//! # (status = 404, description = "Pet was not found")
//! # ),
//! # params(
Expand Down Expand Up @@ -188,7 +188,7 @@
//! # Go beyond the surface
//!
//! * See how to serve OpenAPI doc via Swagger UI check [`utoipa-swagger-ui`][utoipa_swagger] crate for more details.
//! * Browse to [examples](https://github.com/juhaku/utoipa/tree/master/examples) for more comprehensinve examples.
//! * Browse to [examples](https://github.com/juhaku/utoipa/tree/master/examples) for more comprehensive examples.
//! * Modify generated OpenAPI at runtime check [`Modify`] trait for more details.
//! * More about OpenAPI security in [security documentation][security].
//!
Expand Down Expand Up @@ -254,7 +254,7 @@ pub trait OpenApi {

/// Trait for implementing OpenAPI Schema object.
///
/// This trait is deriveable and can be used with `[#derive]` attribute. For a details of
/// This trait is derivable and can be used with `[#derive]` attribute. For a details of
/// `#[derive(Component)]` refer to [derive documentation][derive].
///
/// [derive]: derive.Component.html
Expand Down Expand Up @@ -336,7 +336,7 @@ pub trait Component {
/// get,
/// path = "/pets/{id}",
/// responses(
/// (status = 200, description = "Pet found succesfully", body = Pet),
/// (status = 200, description = "Pet found successfully", body = Pet),
/// (status = 404, description = "Pet was not found")
/// ),
/// params(
Expand All @@ -363,7 +363,7 @@ pub trait Component {
/// .response(
/// "200",
/// utoipa::openapi::ResponseBuilder::new()
/// .description("Pet found succesfully")
/// .description("Pet found successfully")
/// .content("application/json",
/// utoipa::openapi::Content::new(
/// utoipa::openapi::Ref::from_component_name("Pet"),
Expand Down Expand Up @@ -398,7 +398,7 @@ pub trait Component {
pub trait Path {
fn path() -> &'static str;

fn path_item(defalt_tag: Option<&str>) -> openapi::path::PathItem;
fn path_item(default_tag: Option<&str>) -> openapi::path::PathItem;
}

/// Trait that allows OpenApi modification at runtime.
Expand Down Expand Up @@ -470,7 +470,7 @@ pub trait Modify {

/// Trait used to convert implementing type to OpenAPI parameters for **actix-web** framework.
///
/// This trait is [deriveable][derive] for structs which are used to describe `path` or `query` parameters.
/// This trait is [derivable][derive] for structs which are used to describe `path` or `query` parameters.
/// For more details of `#[derive(IntoParams)]` refer to [derive documentation][derive].
///
/// # Examples
Expand Down Expand Up @@ -537,7 +537,7 @@ pub trait IntoParams {
/// Internal trait used to provide [`ParameterIn`] definition for implementer type.
///
/// This is typically used in tandem with [`IntoParams`] trait and only from `utoipa-gen` library.
/// In manual implementation there is typially never a need to implement this trait since
/// In manual implementation there is typically never a need to implement this trait since
/// manual implementations can directly define the [`ParameterIn`] definition they see fit to the purpose.
#[cfg(feature = "actix_extras")]
#[doc(hidden)]
Expand Down
Loading

0 comments on commit e2b7dc0

Please sign in to comment.