Updated the rest api docs for `deposits/overview-all` #8364

jessy-p · 2024-03-11T13:16:30Z

Fixes #8346

Changes proposed in this Pull Request

Added default_external_accounts element to REST API docs for deposits/overview-all

Testing instructions

Verify the markdown
Can build docs locally to verify the REST API docs

Run npm run changelog to add a changelog file, choose patch to leave it empty if the change is not significant. You can add multiple changelog files in one PR by running this command a few times.
Covered with tests (or have a good reason not to test in description ☝️)
Tested on mobile (or does not apply)

Post merge

Link to testing instructions from release testing doc following these instructions : Add link here / 'QA Testing Not Applicable'
Add or update critical flows and testing instructions for critical flows, if applicable.
Add what's changed (description, screenshot, demo videos etc.) to the release announcement post, if applicable.

…s overview API

botwoo · 2024-03-11T13:23:52Z

Test the build

Option 1. Jetpack Beta

Install and activate Jetpack Beta.
Use this build by searching for PR number 8364 or branch name add/8346-deposits-overview-docs in your-test.site/wp-admin/admin.php?page=jetpack-beta&plugin=woocommerce-payments

Option 2. Jurassic Ninja - available for logged-in A12s

🚀 Launch a JN site with this branch 🚀

ℹ️ Install this Tampermonkey script to get more options.

Build info:

Latest commit: 519c448
Build time: 2024-03-14 06:30:02 UTC

Note: the build is updated when a new commit is pushed to this PR.

github-actions · 2024-03-11T13:26:03Z

Size Change: -16 B (0%)

Total Size: 1.28 MB

Filename	Size	Change
`release/woocommerce-payments/assets/css/admin.css`	1.06 kB	-8 B (-1%)
`release/woocommerce-payments/assets/css/admin.rtl.css`	1.06 kB	-8 B (-1%)

ℹ️ View Unchanged

Filename	Size
`release/woocommerce-payments/assets/css/success.css`	158 B
`release/woocommerce-payments/assets/css/success.rtl.css`	158 B
`release/woocommerce-payments/dist/blocks-checkout-rtl.css`	1.92 kB
`release/woocommerce-payments/dist/blocks-checkout.css`	1.91 kB
`release/woocommerce-payments/dist/blocks-checkout.js`	85.6 kB
`release/woocommerce-payments/dist/cart.js`	4.02 kB
`release/woocommerce-payments/dist/checkout-rtl.css`	405 B
`release/woocommerce-payments/dist/checkout.css`	406 B
`release/woocommerce-payments/dist/checkout.js`	36.9 kB
`release/woocommerce-payments/dist/index-rtl.css`	40 kB
`release/woocommerce-payments/dist/index.css`	40 kB
`release/woocommerce-payments/dist/index.js`	291 kB
`release/woocommerce-payments/dist/multi-currency-analytics.js`	1.05 kB
`release/woocommerce-payments/dist/multi-currency-rtl.css`	3.28 kB
`release/woocommerce-payments/dist/multi-currency-switcher-block.js`	59.4 kB
`release/woocommerce-payments/dist/multi-currency.css`	3.29 kB
`release/woocommerce-payments/dist/multi-currency.js`	54.4 kB
`release/woocommerce-payments/dist/order-rtl.css`	719 B
`release/woocommerce-payments/dist/order.css`	721 B
`release/woocommerce-payments/dist/order.js`	41.7 kB
`release/woocommerce-payments/dist/payment-gateways-rtl.css`	1.21 kB
`release/woocommerce-payments/dist/payment-gateways.css`	1.21 kB
`release/woocommerce-payments/dist/payment-gateways.js`	38.4 kB
`release/woocommerce-payments/dist/payment-request-rtl.css`	155 B
`release/woocommerce-payments/dist/payment-request.css`	155 B
`release/woocommerce-payments/dist/payment-request.js`	12.4 kB
`release/woocommerce-payments/dist/product-details-rtl.css`	155 B
`release/woocommerce-payments/dist/product-details.css`	155 B
`release/woocommerce-payments/dist/product-details.js`	9.09 kB
`release/woocommerce-payments/dist/settings-rtl.css`	11 kB
`release/woocommerce-payments/dist/settings.css`	10.8 kB
`release/woocommerce-payments/dist/settings.js`	230 kB
`release/woocommerce-payments/dist/subscription-edit-page.js`	669 B
`release/woocommerce-payments/dist/subscription-product-onboarding-modal-rtl.css`	527 B
`release/woocommerce-payments/dist/subscription-product-onboarding-modal.css`	527 B
`release/woocommerce-payments/dist/subscription-product-onboarding-modal.js`	19.4 kB
`release/woocommerce-payments/dist/subscription-product-onboarding-toast.js`	710 B
`release/woocommerce-payments/dist/subscriptions-empty-state-rtl.css`	120 B
`release/woocommerce-payments/dist/subscriptions-empty-state.css`	120 B
`release/woocommerce-payments/dist/subscriptions-empty-state.js`	18.5 kB
`release/woocommerce-payments/dist/tos-rtl.css`	235 B
`release/woocommerce-payments/dist/tos.css`	236 B
`release/woocommerce-payments/dist/tos.js`	21 kB
`release/woocommerce-payments/dist/woopay-direct-checkout.js`	4.15 kB
`release/woocommerce-payments/dist/woopay-express-button-rtl.css`	155 B
`release/woocommerce-payments/dist/woopay-express-button.css`	155 B
`release/woocommerce-payments/dist/woopay-express-button.js`	52.6 kB
`release/woocommerce-payments/dist/woopay-rtl.css`	4.44 kB
`release/woocommerce-payments/dist/woopay.css`	4.41 kB
`release/woocommerce-payments/dist/woopay.js`	71 kB
`release/woocommerce-payments/includes/subscriptions/assets/css/plugin-page.css`	622 B
`release/woocommerce-payments/includes/subscriptions/assets/js/plugin-page.js`	812 B
`release/woocommerce-payments/vendor/automattic/jetpack-assets/build/i18n-loader.js`	2.43 kB
`release/woocommerce-payments/vendor/automattic/jetpack-assets/src/js/i18n-loader.js`	1.01 kB
`release/woocommerce-payments/vendor/automattic/jetpack-connection/dist/tracks-ajax.js`	522 B
`release/woocommerce-payments/vendor/automattic/jetpack-connection/dist/tracks-callables.js`	581 B
`release/woocommerce-payments/vendor/automattic/jetpack-identity-crisis/babel.config.js`	160 B
`release/woocommerce-payments/vendor/automattic/jetpack-identity-crisis/build/index.css`	2.37 kB
`release/woocommerce-payments/vendor/automattic/jetpack-identity-crisis/build/index.js`	13.5 kB
`release/woocommerce-payments/vendor/automattic/jetpack-identity-crisis/build/index.rtl.css`	2.37 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/css/about.css`	1.03 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/css/admin-empty-state.css`	291 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/css/admin-order-statuses.css`	403 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/css/admin.css`	3.6 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/css/checkout.css`	299 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/css/modal.css`	742 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/css/view-subscription.css`	572 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/css/wcs-upgrade.css`	411 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/admin/admin-pointers.js`	544 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/admin/admin.js`	9.4 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/admin/jstz.js`	6.8 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/admin/jstz.min.js`	3.83 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/admin/meta-boxes-coupon.js`	544 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/admin/meta-boxes-subscription.js`	2.52 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/admin/moment.js`	22.1 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/admin/moment.min.js`	11.6 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/admin/payment-method-restrictions.js`	1.29 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/admin/wcs-meta-boxes-order.js`	502 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/frontend/payment-methods.js`	355 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/frontend/single-product.js`	429 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/frontend/view-subscription.js`	1.38 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/frontend/wcs-cart.js`	781 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/modal.js`	1.1 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/assets/js/wcs-upgrade.js`	1.27 kB
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/build/index.css`	392 B
`release/woocommerce-payments/vendor/woocommerce/subscriptions-core/build/index.js`	3.05 kB

_{compressed-size-action}

naman03malhotra

Approving, looks good to me!

docs/rest-api/source/includes/wp-api-v3/deposits.md

…Automattic/woocommerce-payments into add/8346-deposits-overview-docs

Jinksi

Looks good @jessy-p 💯

I've checked this by running build.sh from /docs/rest-api/ and viewing the changes to the docs ✅

Co-authored-by: Jessy <[email protected]> Co-authored-by: Eric Jinks <[email protected]>

Jessy added 4 commits March 11, 2024 18:33

Updated the rest api docs to add default_external_accounts to deposit…

0055b3e

…s overview API

Added changelog

85ade84

updated changelog

cd6fe94

updated example in docs

39ecfe6

jessy-p requested a review from a team March 11, 2024 13:21

jessy-p added the pr: needs review label Mar 11, 2024

jessy-p requested review from naman03malhotra and Jinksi March 13, 2024 15:13

naman03malhotra approved these changes Mar 13, 2024

View reviewed changes

jessy-p added this pull request to the merge queue Mar 14, 2024

jessy-p removed this pull request from the merge queue due to a manual request Mar 14, 2024

Jinksi reviewed Mar 14, 2024

View reviewed changes

docs/rest-api/source/includes/wp-api-v3/deposits.md Outdated Show resolved Hide resolved

Adding more context to default_external_accounts

726177d

jessy-p requested review from Jinksi and a team March 14, 2024 05:20

jessy-p and others added 4 commits March 14, 2024 10:50

Merge branch 'develop' into add/8346-deposits-overview-docs

cd915ea

Removed reference to Stripe to keep it generic

7096b69

Merge branch 'add/8346-deposits-overview-docs' of https://github.com/…

540d0a3

…Automattic/woocommerce-payments into add/8346-deposits-overview-docs

Fix typo

8b4cf9e

Jinksi approved these changes Mar 14, 2024

View reviewed changes

Wrap example values in backticks

519c448

Jinksi added pr: ready to merge and removed pr: needs review labels Mar 14, 2024

jessy-p added this pull request to the merge queue Mar 14, 2024

Merged via the queue into develop with commit 9e98720 Mar 14, 2024
25 of 26 checks passed

jessy-p deleted the add/8346-deposits-overview-docs branch March 14, 2024 15:29

Jinksi added a commit that referenced this pull request Mar 28, 2024

Updated the rest api docs for deposits/overview-all (#8364)

022e8c6

Co-authored-by: Jessy <[email protected]> Co-authored-by: Eric Jinks <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated the rest api docs for `deposits/overview-all` #8364

Updated the rest api docs for `deposits/overview-all` #8364

jessy-p commented Mar 11, 2024

botwoo commented Mar 11, 2024 •

edited

Loading

github-actions bot commented Mar 11, 2024 •

edited

Loading

naman03malhotra left a comment

Jinksi left a comment

Updated the rest api docs for deposits/overview-all #8364

Updated the rest api docs for deposits/overview-all #8364

Conversation

jessy-p commented Mar 11, 2024

Changes proposed in this Pull Request

Testing instructions

botwoo commented Mar 11, 2024 • edited Loading

Test the build

Option 1. Jetpack Beta

Option 2. Jurassic Ninja - available for logged-in A12s

github-actions bot commented Mar 11, 2024 • edited Loading

naman03malhotra left a comment

Choose a reason for hiding this comment

Jinksi left a comment

Choose a reason for hiding this comment

Updated the rest api docs for `deposits/overview-all` #8364

Updated the rest api docs for `deposits/overview-all` #8364

botwoo commented Mar 11, 2024 •

edited

Loading

github-actions bot commented Mar 11, 2024 •

edited

Loading