This repository was archived by the owner on Nov 14, 2023. It is now read-only.
docs: add code snippets for async api #18
Merged
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.
Previous PR is here: #5
The previous PR was deleted because @dizcology suggested that using the auto-generated code samples can already serve our purpose and can also provide the benefits of easy maintainability. However, after reviewing our product documents, TPM and eng raised the concern that customers may feel confused about the linked code samples. The code sample construct the request in the code. But in reality, customers tend to construct the request in a json file. Thus they may find it hard to parse and use the json file without us showing them how to do it in code. This PR is to add a code snippet for the sync API that reads the request from a json file.