Skip to content

Commit

Permalink
fix grammar in "a OpenAPI" (#909)
Browse files Browse the repository at this point in the history
Co-authored-by: Jakob Ladegaard Møller <[email protected]>
  • Loading branch information
jakob753951 and Jakob Ladegaard Møller authored Nov 25, 2024
1 parent f7bb838 commit a98c67c
Show file tree
Hide file tree
Showing 14 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion poem-openapi/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ enum UploadImageRequest {

# [1.0.35] 2021-12-05

- If a OpenAPI name conflict is detected when creating schema, it will cause panic.
- If an OpenAPI name conflict is detected when creating schema, it will cause panic.

# [1.0.33] 2021-11-30

Expand Down
10 changes: 5 additions & 5 deletions poem-openapi/src/base.rs
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ impl<T> Default for ExtractParamOptions<T> {
}
}

/// Represents a OpenAPI extractor.
/// Represents an OpenAPI extractor.
///
/// # Provided Implementations
///
Expand Down Expand Up @@ -221,7 +221,7 @@ impl<'a, T: FromRequest<'a>> ApiExtractor<'a> for T {
}
}

/// Represents a OpenAPI response content object.
/// Represents an OpenAPI response content object.
pub trait ResponseContent {
/// Returns the media types in this content.
fn media_types() -> Vec<MetaMediaType>;
Expand All @@ -244,7 +244,7 @@ impl<T: Payload> ResponseContent for T {
}
}

/// Represents a OpenAPI responses object.
/// Represents an OpenAPI responses object.
///
/// # Provided Implementations
///
Expand Down Expand Up @@ -366,7 +366,7 @@ where
fn register(_registry: &mut Registry) {}
}

/// Represents a OpenAPI tags.
/// Represents an OpenAPI tags.
pub trait Tags {
/// Register this tag type to registry.
fn register(&self, registry: &mut Registry);
Expand Down Expand Up @@ -395,7 +395,7 @@ impl Display for OperationId {
}
}

/// Represents a OpenAPI object.
/// Represents an OpenAPI object.
pub trait OpenApi: Sized {
/// Gets metadata of this API object.
fn meta() -> Vec<MetaApi>;
Expand Down
2 changes: 1 addition & 1 deletion poem-openapi/src/docs/enum.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Define a OpenAPI enum
Define an OpenAPI enum

# Macro parameters

Expand Down
2 changes: 1 addition & 1 deletion poem-openapi/src/docs/multipart.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Define a OpenAPI payload.
Define an OpenAPI payload.

# Macro parameters

Expand Down
2 changes: 1 addition & 1 deletion poem-openapi/src/docs/object.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Define a OpenAPI object
Define an OpenAPI object

# Macro parameters

Expand Down
2 changes: 1 addition & 1 deletion poem-openapi/src/docs/openapi.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Define a OpenAPI.
Define an OpenAPI.

# Macro parameters

Expand Down
2 changes: 1 addition & 1 deletion poem-openapi/src/docs/request.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Define a OpenAPI request.
Define an OpenAPI request.

# Item parameters

Expand Down
2 changes: 1 addition & 1 deletion poem-openapi/src/docs/response.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Define a OpenAPI response.
Define an OpenAPI response.

# Macro parameters

Expand Down
2 changes: 1 addition & 1 deletion poem-openapi/src/docs/response_content.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Define a OpenAPI response content.
Define an OpenAPI response content.

# Item parameters

Expand Down
2 changes: 1 addition & 1 deletion poem-openapi/src/docs/security_scheme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Define a OpenAPI Security Scheme.
Define an OpenAPI Security Scheme.

# Macro parameters

Expand Down
2 changes: 1 addition & 1 deletion poem-openapi/src/docs/tags.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Define a OpenAPI Tags.
Define an OpenAPI Tags.

# Macro parameters

Expand Down
2 changes: 1 addition & 1 deletion poem-openapi/src/docs/union.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Define a OpenAPI discriminator object.
Define an OpenAPI discriminator object.

# Macro parameters

Expand Down
2 changes: 1 addition & 1 deletion poem-openapi/src/docs/webhook.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Define a OpenApi webhooks.
Define an OpenAPI webhooks.

# Macro parameters

Expand Down
2 changes: 1 addition & 1 deletion poem-openapi/src/types/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ pub use string_types::Password;

use crate::registry::{MetaSchemaRef, Registry};

/// Represents a OpenAPI type.
/// Represents an OpenAPI type.
pub trait Type: Send + Sync {
/// If it is `true`, it means that this type is required.
const IS_REQUIRED: bool;
Expand Down

0 comments on commit a98c67c

Please sign in to comment.