Update standardization ingestion docs #567
Merged
Conversation
This file contains 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
emmastephenson
commented
May 11, 2023
| :param input: A dictionary with the schema specified by the StandardizePhonesInput | ||
| model. | ||
|
|
There was a problem hiding this comment.
Question for others - I know the :param and :return is standard for other Python documentation libraries, but doesn't seem to be recognized by OpenAPI. Given that our docs page has more detailed information about the requests and responses, any objection to me removing these?
Codecov Report
@@ Coverage Diff @@
## main #567 +/- ##
=======================================
Coverage 96.49% 96.49%
=======================================
Files 45 45
Lines 2481 2481
=======================================
Hits 2394 2394
Misses 87 87
Flags with carried forward coverage won't be shown. Click here to find out more. |
emmastephenson
requested review from
DanPaseltiner,
nickclyde,
robertmitchellv and
mattmgoldberg
nickclyde
reviewed
May 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PULL REQUEST
Summary
Update the standardization ingestion API docs to include sample requests and responses, as well as some quick content updates.
Related Issue
Related to #488, but more PRs incoming to fix it. (I'm planning to split up the different routers to different PRs so the review burden isn't too bad)
Additional Information
Before:
After:
