Skip to content

Commit a98c67c

Browse files
fix grammar in "a OpenAPI" (#909)
Co-authored-by: Jakob Ladegaard Møller <[email protected]>
1 parent f7bb838 commit a98c67c

File tree

14 files changed

+18
-18
lines changed

14 files changed

+18
-18
lines changed

poem-openapi/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -542,7 +542,7 @@ enum UploadImageRequest {
542542

543543
# [1.0.35] 2021-12-05
544544

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

547547
# [1.0.33] 2021-11-30
548548

poem-openapi/src/base.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ impl<T> Default for ExtractParamOptions<T> {
8888
}
8989
}
9090

91-
/// Represents a OpenAPI extractor.
91+
/// Represents an OpenAPI extractor.
9292
///
9393
/// # Provided Implementations
9494
///
@@ -221,7 +221,7 @@ impl<'a, T: FromRequest<'a>> ApiExtractor<'a> for T {
221221
}
222222
}
223223

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

247-
/// Represents a OpenAPI responses object.
247+
/// Represents an OpenAPI responses object.
248248
///
249249
/// # Provided Implementations
250250
///
@@ -366,7 +366,7 @@ where
366366
fn register(_registry: &mut Registry) {}
367367
}
368368

369-
/// Represents a OpenAPI tags.
369+
/// Represents an OpenAPI tags.
370370
pub trait Tags {
371371
/// Register this tag type to registry.
372372
fn register(&self, registry: &mut Registry);
@@ -395,7 +395,7 @@ impl Display for OperationId {
395395
}
396396
}
397397

398-
/// Represents a OpenAPI object.
398+
/// Represents an OpenAPI object.
399399
pub trait OpenApi: Sized {
400400
/// Gets metadata of this API object.
401401
fn meta() -> Vec<MetaApi>;

poem-openapi/src/docs/enum.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Define a OpenAPI enum
1+
Define an OpenAPI enum
22

33
# Macro parameters
44

poem-openapi/src/docs/multipart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Define a OpenAPI payload.
1+
Define an OpenAPI payload.
22

33
# Macro parameters
44

poem-openapi/src/docs/object.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Define a OpenAPI object
1+
Define an OpenAPI object
22

33
# Macro parameters
44

poem-openapi/src/docs/openapi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Define a OpenAPI.
1+
Define an OpenAPI.
22

33
# Macro parameters
44

poem-openapi/src/docs/request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Define a OpenAPI request.
1+
Define an OpenAPI request.
22

33
# Item parameters
44

poem-openapi/src/docs/response.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Define a OpenAPI response.
1+
Define an OpenAPI response.
22

33
# Macro parameters
44

poem-openapi/src/docs/response_content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Define a OpenAPI response content.
1+
Define an OpenAPI response content.
22

33
# Item parameters
44

poem-openapi/src/docs/security_scheme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Define a OpenAPI Security Scheme.
1+
Define an OpenAPI Security Scheme.
22

33
# Macro parameters
44

0 commit comments

Comments
 (0)