-
Notifications
You must be signed in to change notification settings - Fork 218
Docs review for v2.https #1109
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
Docs review for v2.https #1109
Conversation
|
|
||
| /** | ||
| * Handles HTTPS requests. | ||
| */ |
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.
Please document req/res
egilmorez
left a comment
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.
Some thoughts Joe, thanks!
Kudos for staging and eyeballing the lists (I'm assuming you did that).
|
@egilmorez Addressed feedback. I haven't staged the list changes yet - I just manually reviewed the MD files and verified that the dcogen added linebreaks where expected. I'll take a crack at that now - however, my desktop is not in working condition RN so I may run into some issues. |
egilmorez
left a comment
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.
LG, thanks!
Description
Reviewed the staged HTTPS docs, and found +fixed the following issues:
Formatting Issues:
Missing descriptions:
onCall
onRequest
httpError.toJson - Added a brief description
https.HttpsOptions.cors - Added an explanation of what this option does with various types - please double check this to make sure I'm correct
request.rawBody - added a brief description