woocommerce/plugins/woocommerce-blocks/docs/extensibility
Mike Jolley a58b2d0ac4 Store API: Introduce API Versioning System (https://github.com/woocommerce/woocommerce-blocks/pull/5911)
* Fix missing dependency

* Min version exceeds required 5.6

* Move exceptions

* Move schemas under V1 namespace

* Move routes to v1

* Move RouteException

* Route versioning

* Update route and schema identifiers/init

* Rework route init to support multiple versions and multiple schema

* Tests for cart routes

* Cart coupons tests

* Batch

* extensions

* Update docs

* Update remaining tests

* woocommerce_store_api_route_version was unused

* Revert unrelated change

* Fix phpcs

* Update src/StoreApi/docs/guiding-principles.md

Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com>

* Update src/StoreApi/docs/cart-items.md

Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com>

* Update src/StoreApi/RoutesController.php

Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com>

* Note about v1 unversioned endpoints

* Remove unused get_route_version

* 409 comment in tests

* Remove copy pasted comments

* Update all usage to v1

* Correct namespace

* More v1 namespaces

* More missing v1

* fix mocks

Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com>
2022-02-23 12:00:45 +00:00
..
README.md Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) 2022-02-02 14:27:46 +00:00
actions.md Store API: Introduce API Versioning System (https://github.com/woocommerce/woocommerce-blocks/pull/5911) 2022-02-23 12:00:45 +00:00
available-endpoints-to-extend.md Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) 2022-02-02 14:27:46 +00:00
available-filters.md Update some Cart and Checkout extensibility docs to include the Mini Cart block (https://github.com/woocommerce/woocommerce-blocks/pull/5815) 2022-02-21 16:29:29 +01:00
available-slot-fills.md Pass context information about parent block to the existing Slots (https://github.com/woocommerce/woocommerce-blocks/pull/5885) 2022-02-22 10:33:52 +01:00
checkout-flow-and-events.md Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) 2022-02-02 14:27:46 +00:00
dom-events.md Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) 2022-02-02 14:27:46 +00:00
extend-rest-api-add-data.md Update some Cart and Checkout extensibility docs to include the Mini Cart block (https://github.com/woocommerce/woocommerce-blocks/pull/5815) 2022-02-21 16:29:29 +01:00
extend-rest-api-formatters.md Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) 2022-02-02 14:27:46 +00:00
extend-rest-api-new-endpoint.md Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) 2022-02-02 14:27:46 +00:00
extend-rest-api-update-cart.md Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) 2022-02-02 14:27:46 +00:00
filtering-payment-methods.md Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) 2022-02-02 14:27:46 +00:00
filters.md Store API: Introduce API Versioning System (https://github.com/woocommerce/woocommerce-blocks/pull/5911) 2022-02-23 12:00:45 +00:00
integration-interface.md Update some Cart and Checkout extensibility docs to include the Mini Cart block (https://github.com/woocommerce/woocommerce-blocks/pull/5815) 2022-02-21 16:29:29 +01:00
payment-method-integration.md Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) 2022-02-02 14:27:46 +00:00
slot-fills.md Pass context information about parent block to the existing Slots (https://github.com/woocommerce/woocommerce-blocks/pull/5885) 2022-02-22 10:33:52 +01:00

README.md

Extensibility in WooCommerce Blocks

These documents are all dealing with extensibility in the various WooCommerce Blocks.

Table of Contents

Hooks (actions and filters)

Document Description
Actions Documentation covering action hooks on the server side.
Filters Documentation covering filter hooks on the server side.

REST API

Document Description
Exposing your data in the Store API. Explains how you can add additional data to Store API endpoints.
Available endpoints to extend with ExtendRestAPI. A list of all available endpoints to extend.
Adding an endpoint to ExtendRestAPI. A step by step process for contributors to expose a new endpoint via ExtendRestApi.
Available Formatters Available Formatters to format data for use in the Store API.

Checkout Payment Methods

Document Description
Checkout Flow and Events All about the checkout flow in the checkout block and the various emitted events that can be subscribed to.
Payment Method Integration Information about implementing payment methods.
Filtering Payment Methods Information about filtering the payment methods available in the Checkout Block.

Checkout Block

In addition to the reference material below, please see the block-checkout package documentation which is used to extend checkout with Filters, Slot Fills, and Inner Blocks.

Document Description
IntegrationInterface The IntegrationInterface class and how to use it to register scripts, styles, and data with WooCommerce Blocks.
Available Filters All about the filters that you may use to change values of certain elements of WooCommerce Blocks.
Slots and Fills. Explains Slot Fills and how to use them to render your own components in Cart and Checkout.
Available Slot Fills. Available Slots that you can use and their positions in Cart and Checkout.
DOM Events A list of DOM Events used by some blocks to communicate between them and with other parts of WooCommerce.

We're hiring! Come work with us!

🐞 Found a mistake, or have a suggestion? Leave feedback about this document here.