docs: add sync api samples with json request #13

changsongd · 2022-04-05T22:18:37Z

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.

snippet-bot · 2022-04-05T22:18:40Z

Here is the summary of possible violations 😱

There is a possible violation for not having product prefix.

samples/snippets/sync_api.py:15, tag cloudoptimization_sync_api

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.

samples/snippets/sync_api.py:15, tag cloudoptimization_sync_api

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

samples/snippets/sync_api.py

leahecole · 2022-04-06T18:20:35Z

I'm noticing that samples tests are passing but aren't actually running due to the lack of noxfile. I've flagged this to @googleapis/python-samples-owners as a concern to address. I'll send you individual instructions for running local samples tests as a workaround.

leahecole

I added a few comments, but I also have a few overall requests

Please add a requirements.txt file to the same directory your samples are in with libraries needed for your sample to run and have them pinned to specific versions (for example - https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/composer/rest/requirements.txt)
Please add a requirements.txt file to the same directory your samples are in with libraries needed for tests to run. It will likely be identical to this one since your test doesn't call any additional 3rd party libraries (https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/composer/rest/requirements-test.txt)
Please add a noxfile-config.py file to the directory where your samples are. This will enforce type hinting and specify which versions of Python to test in (by default, we test in 3.7, 3.8, 3.9, and 3.10. If your product does not support one of those versions, please exempt it in this file by adding the version to the list with 2.7 and 3.6). You can copy this file directly. This configuration file will interact with a noxfile that will be generated once a requirements file is present. The noxfile configures nox, our test runner
Please add type hints, they are required per the authoring guide

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

leahecole · 2022-04-06T18:40:09Z

@changsongd I pinged you about why the noxfile reappeared! one that was generated SHOULD be there now - sorry - so confusing, I know!

changsongd · 2022-04-06T18:42:32Z

@changsongd I pinged you about why the noxfile reappeared! one that was generated SHOULD be there now - sorry - so confusing, I know!

Oh, I think I accidentally deleted it. Will the OwlBot be triggered again and re-generate that file?

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

leahecole · 2022-04-06T19:27:37Z

I've now enabled the maps plugin and will retry

leahecole · 2022-04-06T19:36:42Z

Weird, I'm seeing 403s on two versions of Python but not on two others? 🤔 I'll try a re-run to see if it's consistent

leahecole · 2022-04-06T19:48:20Z

Still trying to get the samples lint check to show up

leahecole · 2022-04-06T21:05:36Z

trigger owlbot because it looks a lil stuck

* add code snippets for sync and async api * remove async test samples * use f-string * change project_id to input arg * add noxfile * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * rename noxfile and add requirements * rm noxfile * rm noxfile local * add root noxfile * Update noxfile.py * Update noxfile.py * Update noxfile.py Co-authored-by: Leah E. Cole <6719667+leahecole@users.noreply.github.com> * Apply suggestions from code review * Update noxfile.py * Update noxfile.py * Update noxfile.py * Update noxfile.py * Update noxfile.py * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Add commit to trigger kokoro * add indentation * add type annotations Co-authored-by: Jeffrey Rennie <rennie@google.com> Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Leah E. Cole <6719667+leahecole@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>

* Add get_operation code snippets * update comment * docs: add sync api samples with json request (#13) * add code snippets for sync and async api * remove async test samples * use f-string * change project_id to input arg * add noxfile * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * rename noxfile and add requirements * rm noxfile * rm noxfile local * add root noxfile * Update noxfile.py * Update noxfile.py * Update noxfile.py Co-authored-by: Leah E. Cole <6719667+leahecole@users.noreply.github.com> * Apply suggestions from code review * Update noxfile.py * Update noxfile.py * Update noxfile.py * Update noxfile.py * Update noxfile.py * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Add commit to trigger kokoro * add indentation * add type annotations Co-authored-by: Jeffrey Rennie <rennie@google.com> Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Leah E. Cole <6719667+leahecole@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com> * rebase and add type annotations * fix operation_id type * Update samples/snippets/get_operation.py Co-authored-by: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> * Update samples/snippets/get_operation_test.py Co-authored-by: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> * move TODO outside func, create operation in test * lint fix * fix asyncmodelconfig * change model_config to list * add blank line * change request to dict * change parent to project id * remove model config * Update samples/snippets/get_operation.py Co-authored-by: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> * add TODO back Co-authored-by: Jeffrey Rennie <rennie@google.com> Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Leah E. Cole <6719667+leahecole@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com> Co-authored-by: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com>

changsongd added 2 commits April 5, 2022 14:30

add code snippets for sync and async api

5f3eda6

remove async test samples

0395102

changsongd requested a review from a team as a code owner April 5, 2022 22:18

changsongd requested a review from leahecole April 5, 2022 22:18

product-auto-label bot added size: m Pull request size is medium. api: cloudoptimization Issues related to the googleapis/python-optimization API. samples Issues that are directly related to samples. labels Apr 5, 2022

changsongd mentioned this pull request Apr 5, 2022

snippet-bot complaining about region tag prefix #14

Closed

Merge branch 'main' into add_samples_with_json_request

f0402ca

leahecole reviewed Apr 6, 2022

View reviewed changes

samples/snippets/sync_api.py Outdated Show resolved Hide resolved

use f-string

874b775

changsongd added 2 commits April 6, 2022 11:25

change project_id to input arg

d3c576c

add noxfile

28a094a

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Apr 6, 2022

leahecole suggested changes Apr 6, 2022

View reviewed changes

xiliucity approved these changes Apr 6, 2022

View reviewed changes

leahecole added the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 6, 2022

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 6, 2022

gcf-owl-bot bot and others added 3 commits April 6, 2022 18:34

🦉 Updates from OwlBot post-processor

49f2075

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

rename noxfile and add requirements

91281a5

rm noxfile

3a64e68

changsongd requested a review from a team as a code owner April 6, 2022 18:38

rm noxfile local

b71b679

leahecole added the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 6, 2022

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 6, 2022

Update noxfile.py

b41a644

leahecole added the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 6, 2022

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 6, 2022

🦉 Updates from OwlBot post-processor

fe62741

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Apr 6, 2022

leahecole added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 6, 2022

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 6, 2022

leahecole mentioned this pull request Apr 6, 2022

Snippet bot failing on proper product prefix (I think) googleapis/repo-automation-bots#3400

Closed

leahecole added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 6, 2022

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 6, 2022

leahecole added the kokoro:run Add this label to force Kokoro to re-run the tests. label Apr 6, 2022

Add commit to trigger kokoro

5d048ee

parthea added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 6, 2022

yoshi-kokoro removed kokoro:run Add this label to force Kokoro to re-run the tests. kokoro:force-run Add this label to force Kokoro to re-run the tests. labels Apr 6, 2022

changsongd added 2 commits April 6, 2022 13:02

add indentation

0f3bcb1

add type annotations

2b4c26e

leahecole added the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 6, 2022

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 6, 2022

leahecole approved these changes Apr 6, 2022

View reviewed changes

leahecole merged commit c3d6087 into googleapis:main Apr 6, 2022

release-please bot mentioned this pull request Apr 6, 2022

chore(main): release 0.1.1 #17

Merged

changsongd deleted the add_samples_with_json_request branch April 6, 2022 21:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add sync api samples with json request #13

docs: add sync api samples with json request #13

changsongd commented Apr 5, 2022

snippet-bot bot commented Apr 5, 2022 •

edited

Loading

leahecole commented Apr 6, 2022

leahecole left a comment

leahecole commented Apr 6, 2022

changsongd commented Apr 6, 2022

leahecole commented Apr 6, 2022

leahecole commented Apr 6, 2022

leahecole commented Apr 6, 2022

leahecole commented Apr 6, 2022

docs: add sync api samples with json request #13

docs: add sync api samples with json request #13

Conversation

changsongd commented Apr 5, 2022

snippet-bot bot commented Apr 5, 2022 • edited Loading

leahecole commented Apr 6, 2022

leahecole left a comment

Choose a reason for hiding this comment

leahecole commented Apr 6, 2022

changsongd commented Apr 6, 2022

leahecole commented Apr 6, 2022

leahecole commented Apr 6, 2022

leahecole commented Apr 6, 2022

leahecole commented Apr 6, 2022

snippet-bot bot commented Apr 5, 2022 •

edited

Loading