docs/refactor: add documentation for invoking HTTP functions locally #601
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.
Summary
As mentioned in #599, I have added some light documentation for invoking the HTTP Lambda functions locally. Additionally, I have fixed all of the non-visual markdown lint warnings/errors. I did not fix all of them to preserve the styling of the original authors in the case that it was done intentionally.
I have also converted
Utc.ymd
to the non-deprecatedUtc.with_ymd_and_hms
. Tested and functional.Explanation
When a reader looks at Deploying with Cargo Lambda, the reader has likely not read the official
cargo-lambda
documentation. It is then possible that there may be an assumption, through disjunction, that it is possible to executecargo lambda invoke
without the--remote
flag.The user may then try this command on the first given example to find that the command runs successfully. Later on, they may write a HTTP function and assume that the command is a signal of correctness, only to find that the command fails.
Inevitably, after several futile attempts at debugging, the user may come back to the documentation and notice there is no documentation describing their issue until they finally choose to look at the
cargo-lambda
documentation where they must notice the following in a glance, along with the context of the first paragraph.With the updated documentation, the user will likely perform a search for
data did not match any variant of untagged enum LambdaRequest
and quickly realise their blunder.Disclaimer
By submitting this pull request