Skip to content
This repository has been archived by the owner on Nov 14, 2023. It is now read-only.

docs: add code snippets for async api #18

Merged
merged 7 commits into from
Apr 8, 2022

Conversation

changsongd
Copy link
Contributor

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.

@changsongd changsongd requested a review from a team as a code owner April 7, 2022 16:49
@changsongd changsongd requested a review from loferris April 7, 2022 16:49
@product-auto-label product-auto-label bot added the size: l Pull request size is large. label Apr 7, 2022
@snippet-bot
Copy link

snippet-bot bot commented Apr 7, 2022

Here is the summary of possible violations 😱

There is a possible violation for not having product prefix.

The end of the violation section. All the stuff below is FYI purposes only.


Here is the summary of changes.

You are about to add 1 region tag.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@product-auto-label product-auto-label bot added the api: cloudoptimization Issues related to the googleapis/python-optimization API. label Apr 7, 2022
@changsongd
Copy link
Contributor Author

Here is the summary of possible violations 😱

There is a possible violation for not having product prefix.
The end of the violation section. All the stuff below is FYI purposes only.

Here is the summary of changes.

You are about to add 1 region tag.
This comment is generated by snippet-bot. If you find problems with this result, please file an issue at: https://github.com/googleapis/repo-automation-bots/issues. To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

Optimization AI is in restricted GA (GA with allowlist). The region tag prefix can be found here: https://devrel.corp.google.com/admin/products/463?t=snippets

@loferris loferris added the kokoro:run Add this label to force Kokoro to re-run the tests. label Apr 8, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:run Add this label to force Kokoro to re-run the tests. label Apr 8, 2022
@loferris loferris added the kokoro:run Add this label to force Kokoro to re-run the tests. label Apr 8, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:run Add this label to force Kokoro to re-run the tests. label Apr 8, 2022
@loferris loferris added the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 8, 2022
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 8, 2022
@loferris loferris merged commit 60b35a0 into googleapis:main Apr 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api: cloudoptimization Issues related to the googleapis/python-optimization API. size: l Pull request size is large.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants