-
Notifications
You must be signed in to change notification settings - Fork 86
[docs] update extractor docs: fix a typo, increase verbosity #1388
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
joelsa
wants to merge
1
commit into
oxidecomputer:main
Choose a base branch
from
joelsa:improve-extractor-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -17,11 +17,14 @@ use crate::{ | |||||||||||||
use super::{metadata::get_metadata, ExtractorMetadata, SharedExtractor}; | ||||||||||||||
|
||||||||||||||
/// `Header<HeaderType>` is an extractor used to deserialize an instance of | ||||||||||||||
/// `HeaderType` from an HTTP request's header values. `PathType` may be any | ||||||||||||||
/// structure that implements [serde::Deserialize] and [schemars::JsonSchema]. | ||||||||||||||
/// While headers are accessible through [RequestInfo::headers], using this | ||||||||||||||
/// extractor in an entrypoint causes header inputs to be documented in | ||||||||||||||
/// OpenAPI output. See the crate documentation for more information. | ||||||||||||||
/// `HeaderType` from an HTTP request's header values. `HeaderType` may be any | ||||||||||||||
/// struct of yours that implements [serde::Deserialize] and | ||||||||||||||
/// [schemars::JsonSchema], where primitives and enums have to be wrapped in | ||||||||||||||
/// an outer struct and enums need to be flattened using the | ||||||||||||||
/// `#[serde(flatten)]` attribute. While headers are accessible through | ||||||||||||||
/// [RequestInfo::headers], using this extractor in an entrypoint causes header | ||||||||||||||
/// inputs to be documented in OpenAPI output. | ||||||||||||||
Comment on lines
+24
to
+26
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
/// See the crate documentation for more information. | ||||||||||||||
pub struct Header<HeaderType: DeserializeOwned + JsonSchema + Send + Sync> { | ||||||||||||||
inner: HeaderType, | ||||||||||||||
} | ||||||||||||||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -16,10 +16,12 @@ use schemars::JsonSchema; | |||||
use serde::de::DeserializeOwned; | ||||||
use std::fmt::Debug; | ||||||
|
||||||
/// `Path<PathType>` is an extractor used to deserialize an instance of | ||||||
/// `PathType` from an HTTP request's path parameters. `PathType` is any | ||||||
/// structure of yours that implements [serde::Deserialize] and | ||||||
/// [schemars::JsonSchema]. See the crate documentation for more information. | ||||||
/// `Path<PathType>` is an extractor used to deserialize an instance of | ||||||
/// `PathType` from an HTTP request's path parameters. `PathType` may be any | ||||||
/// struct of yours that implements [serde::Deserialize] and | ||||||
/// [schemars::JsonSchema], where primitives and enums have to be wrapped in an | ||||||
/// outer struct and enums need to be flattened using the `#[serde(flatten)]` | ||||||
/// attribute. See this module's documentation formore information. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
#[derive(Debug)] | ||||||
pub struct Path<PathType: JsonSchema + Send + Sync> { | ||||||
inner: PathType, | ||||||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.