Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

(no ticket): [external] Webhooks, create webhook_Put schema without required fields #1241

Merged
merged 13 commits into from
Dec 26, 2023

Conversation

kzhang-dsg
Copy link
Contributor

The put request object incorrectly references the webhook_Base object which has required fields. This fix creates a new webhook_Put object to remove the required fields for the put request.

valentindellangela and others added 9 commits March 21, 2023 17:30
…ce#1125)

* DEVDOCS-4633

* DEVDOCS-4575: [update] Catalog V3 API, update request response schemas (bigcommerce#1101)

Co-authored-by: Tina Gomez <[email protected]>
Co-authored-by: Sarah Riehl <[email protected]>

---------

Co-authored-by: bc-andreadao <[email protected]>
Co-authored-by: Tina Gomez <[email protected]>
Co-authored-by: Sarah Riehl <[email protected]>
…g and shipping (bigcommerce#1215)

* docs(orders): DEVDOCS-4800 allow updating billing address & shipping address custom form fields in Orders v2 API (bigcommerce#1177)

* Change example names and moved reference out of GET

* Update reference/orders.v2.oas2.yml

Incorporate peer review feedback

* Fix merge conflicts

* Remove orderShippingAddress_Resp examples

* Fix problems with grammar in doc

* Update form fields schema example

* Rebase with BOPIS, Checkout, and OrdersV2

* DEVDOCS-4651: [new] SF Checkout, Checkout V3, & Orders V2 endpoints, incorporate BOPIS (bigcommerce#1209)

* links for abandoned carts

* changed Abandoned Cart Emails

* changed carts V3 and catalog V3

* changed Channels

* changed checkouts

* changed currencies

* changed custom template associations

* changed customers

* changed customers V3

* changed email templates

* changed geography

* changed marketing

* changed orders v2

* changed orders v3

* changed pages v3

* changed payment methods

* changed payment processing

* changed price lists

* changed redirects

* changed scripts

* changed settings and shipping

* changed shipping V3

* changed sites

* changed store content

* changed store information

* changed store logs

* changed subscribers

* changed tax classes

* changed tax properties

* changed tax settings

* changes tax connection

* changed themes

* edited themes

* changed webhooks

* changed widgets

* changed wishlists

* changed carts SF

* changed checkouts SF

* changed consent SF

* changed customers SF

* changed form fields SF

* changed orders SF

* changed pricing

* changed subscriptions SF

* changed Tax Provider API

* changed Shipping Provider API, fixed Tax Provider API

* changed Current Customer

* changed Customer Login

* DEVDOCS-4568: [update] Remove negative numbers (bigcommerce#1043)

* DEVDOCS-4568: [revise open PR] Align dst_offset (bigcommerce#1054)

* scripts, verify name of checkout content scope, ancillary

* debug store_content

* debug currencies

* checkouts, remove duplicate key

* put openapi versions in quotes

* wishlists add to info field

* tax settings, update name of api key

* all, add description of API gateway

* tax provider, remove quotes

* update tax_properties API Key name

* DEVDOCS-4605: [update] Payments, add bigpay_token 2 (bigcommerce#1066)

* reorder security section

* ace, param sh-a-ct

* ac, param sh-a-ct

* ac rearrange

* ac typos

* carts v3 tos, contact

* cv3, param sh-a-ct

* catalog tos, contact

* chv3, rearrange

* DEVDOCS-4575: [update] Catalog V3 API, update request response schemas (bigcommerce#1101)

* style

* add path variables

* terms of service, file order

* terms of service

* remove request runner

* remove duplicate auth section

* storefront tokens move auth section

* remove request runner

* add v2 and v3 to rates

* add paths

* remove store_hash path parameter from all endpoints.

* cleaned up some store_hash and x-stoplight artifacts

* empty parameters type error after store_hash deletes

* remove ''s and ''t syntax errors

* add description to store hash

* add description to storefront url store domain

* add description to app api app_domain

* move orders file front matter to front

* price lists -- add header parameters, fix typos

* wishlists & widgets, parameter cleanup

* tax settings, reorganize, add header parameters

* themes parameters

* tax properties spacing and schemas

* tax classes, quote endpoints, parameters

* subscribers, parameters, spaces

* storefront tokens, add header parameters

* sites, add header parameters

* store content, add header parameters

* tax provider connection, add header parameters

* shipping v2, add header parameters

* scripts, add header parameters

* redirects, add header parameters

* payment methods, add header parameters

* orders v3, add info, header parameters

* marketing, add info, header parameters

* customers, add info, header parameters

* channels, add header parameters

* payment processing, add header parameters, revise security schemes

* orders v2. SHE LINTS.

* catalog, add header parameters, debug

* (no ticket): [tools] MDX linter, create + add github action (bigcommerce#1150)

* tax provider, change oas 3.1 --> 3.0.3, lint null object

* tax rates & zone, oas 3.1 --> 3.0.3, remove oas 3.1 feature

* convert .md to .mdx

* channels, update image paths

* DEVDOCS-4719: [migrate] Settings, Customer Login, revise linter

* DEVDOCS-4719: [migrate] Stoplight links (bigcommerce#1156)

* DEVDOCS-4719: [migrate] remove x-stoplight  (bigcommerce#1157)

* correct current customer path

* update current_customer per Slack

* shipping version quotes

* updated meta object in Carts V3

* meta updates in carts.v3 file

* DEVDOCS-4719: [migrate] Shipping V3, remove truly redundant examples (bigcommerce#1162)

* DEVDOCS-4719: [migrate] Many, give meta objects properties (bigcommerce#1158)

* DEVDOCS-4719: [migrate] Handle callouts (bigcommerce#1164)

* DEVDOCS-4719: [migrate] Many, add array items (bigcommerce#1160)

* DEVDOCS-4719: [migrate] Many, add object properties (bigcommerce#1161)

* DEVDOCS-4719: [migrate] response bodies (bigcommerce#1165)

* (no ticket): [migrate] Many, resolve errors

* (no ticket): [migrate] Carts SF, re-lint

* (no ticket): [revise] Customers SF, Standardize create a customer summary (bigcommerce#1176)

* DEVDOCS-4719: [migrate] Catalog V3, fix request body not rendering  (bigcommerce#1163)

* DEVDOCS-4719: [migrate] Catalog V3, rendering issues (bigcommerce#1166)

* DEVDOCS-4719: [migrate] Many, update additionalProperties (bigcommerce#1174)

* (no ticket): [remove] Catalog V3, generic catalog tag (bigcommerce#1180)

See also PR bigcommerce#1175

* apostrophes

* DEVDOCS-4719: [migrate] Email Templates and Custom Template Associations, migrate syntax (bigcommerce#1181)

* DEVDOCS-4719: [migrate] Email templates, unify (bigcommerce#1188)

* remove ambiguous hyphen

* DEVDOCS-4719: [migrate] Webhook schemas (bigcommerce#1189)

* Change 'description' to 'properties' within store_cart_created.yml (bigcommerce#1191)

* DEVDOCS-4719: [migrate] Price Lists V3 API, remove content type header from GET (bigcommerce#1187)

* DEVDOCS-4719 [migrate] Orders, summary/table cleanup (bigcommerce#1185)

* DEVDOCS-4719: [migrate] Tax V3 API, rendering (bigcommerce#1183)

* DEVDOCS-4719: [migrate] Tax Provider API, request example rendering (bigcommerce#1195)

* DEVDOCS-4719: [migrate] Shipping provider API, move example (bigcommerce#1194)

* move response example for Request Rates

* change example names

* DEVDOCS-4719: [migrate] Tax APIs  (bigcommerce#1196)

* DEVDOCS-4719: [migrate] Shipping APIs, move example (bigcommerce#1197)

* DEVDOCS-4719: [migrate] Carts SF & V3, rendering-based changes (bigcommerce#1199)

* change auth docs links (bigcommerce#1202)

* Migrate links bigcommerce#1 (bigcommerce#1204)

* available-apis, storefront-graphql
* storefront carts
* carts v3
* catalog
* channels
* sf checkouts
* sf carts, change links to sf from v3
* checkouts v3
* sf consent
* currencies
* wishlists
* widgets
* webhooks
* tax provider
* customers v2
* shipping v2
* customers v3
* orders v2
* payment processing

* add tags to email templates and custom template associations (bigcommerce#1206)

* Migrate links bigcommerce#2 (bigcommerce#1207)

* incorporate BOPIS changes, SF checkouts

* incorporate BOPIS changes, checkouts V3

* incorporate BOPIS changes, orders V2

* incorporate BOPIS changes

* manual resolution commits

* fix incorrect casing for pickup method id field

* copyedit description

* fix(checkout): CHECKOUT-7328 Update discounted_amount description (bigcommerce#1186)

* docs(orders): DEVDOCS-4800 allow updating billing address & shipping address custom form fields in Orders v2 API

Co-authored-by: bc-andreadao <[email protected]>
Co-authored-by: Traci Porter <[email protected]>
Co-authored-by: Sarah Riehl <[email protected]>
Co-authored-by: Tina Gomez <[email protected]>
Co-authored-by: Matthew Volk <[email protected]>
Co-authored-by: stanzikratelbc <[email protected]>
Co-authored-by: Nate Stewart <[email protected]>
Co-authored-by: Tina Gomez <[email protected]>
Co-authored-by: Valentin Dellangela <[email protected]>
Co-authored-by: Donald Nguyen <[email protected]>

* Remove duplicate consignment from Order_Put
…otes and Refunds (bigcommerce#1216)

Remove Batch endpoints for Refund Quotes and Refunds
…tems Overrides (bigcommerce#1140)

* feat(checkout): CHECKOUT-7264 Update our Dev Docs with the new Line Items Overrides

* Update reference/carts.v3.yml

Co-authored-by: Traci Porter <[email protected]>

* Update reference/carts.v3.yml

Co-authored-by: Traci Porter <[email protected]>

* Update reference/carts.v3.yml

Co-authored-by: Traci Porter <[email protected]>

* Update reference/carts.v3.yml

Co-authored-by: Traci Porter <[email protected]>

* fix(checkout): CHECKOUT-7328 Update discounted_amount description (bigcommerce#1186)

Co-authored-by: Traci Porter <[email protected]>
Co-authored-by: Mark Murphy <[email protected]>

* DEVDOCS-4633: [revise] Storefront Customers, update schema (bigcommerce#1125)

* DEVDOCS-4633

* DEVDOCS-4575: [update] Catalog V3 API, update request response schemas (bigcommerce#1101)

Co-authored-by: Tina Gomez <[email protected]>
Co-authored-by: Sarah Riehl <[email protected]>

---------

Co-authored-by: bc-andreadao <[email protected]>
Co-authored-by: Tina Gomez <[email protected]>
Co-authored-by: Sarah Riehl <[email protected]>

* DEVDOCS-4800: [update] OrdersV2, update custom form fields for billing and shipping  (bigcommerce#1215)

* docs(orders): DEVDOCS-4800 allow updating billing address & shipping address custom form fields in Orders v2 API (bigcommerce#1177)

* Change example names and moved reference out of GET

* Update reference/orders.v2.oas2.yml

Incorporate peer review feedback

* Fix merge conflicts

* Remove orderShippingAddress_Resp examples

* Fix problems with grammar in doc

* Update form fields schema example

* Rebase with BOPIS, Checkout, and OrdersV2

* DEVDOCS-4651: [new] SF Checkout, Checkout V3, & Orders V2 endpoints, incorporate BOPIS (bigcommerce#1209)

* links for abandoned carts

* changed Abandoned Cart Emails

* changed carts V3 and catalog V3

* changed Channels

* changed checkouts

* changed currencies

* changed custom template associations

* changed customers

* changed customers V3

* changed email templates

* changed geography

* changed marketing

* changed orders v2

* changed orders v3

* changed pages v3

* changed payment methods

* changed payment processing

* changed price lists

* changed redirects

* changed scripts

* changed settings and shipping

* changed shipping V3

* changed sites

* changed store content

* changed store information

* changed store logs

* changed subscribers

* changed tax classes

* changed tax properties

* changed tax settings

* changes tax connection

* changed themes

* edited themes

* changed webhooks

* changed widgets

* changed wishlists

* changed carts SF

* changed checkouts SF

* changed consent SF

* changed customers SF

* changed form fields SF

* changed orders SF

* changed pricing

* changed subscriptions SF

* changed Tax Provider API

* changed Shipping Provider API, fixed Tax Provider API

* changed Current Customer

* changed Customer Login

* DEVDOCS-4568: [update] Remove negative numbers (bigcommerce#1043)

* DEVDOCS-4568: [revise open PR] Align dst_offset (bigcommerce#1054)

* scripts, verify name of checkout content scope, ancillary

* debug store_content

* debug currencies

* checkouts, remove duplicate key

* put openapi versions in quotes

* wishlists add to info field

* tax settings, update name of api key

* all, add description of API gateway

* tax provider, remove quotes

* update tax_properties API Key name

* DEVDOCS-4605: [update] Payments, add bigpay_token 2 (bigcommerce#1066)

* reorder security section

* ace, param sh-a-ct

* ac, param sh-a-ct

* ac rearrange

* ac typos

* carts v3 tos, contact

* cv3, param sh-a-ct

* catalog tos, contact

* chv3, rearrange

* DEVDOCS-4575: [update] Catalog V3 API, update request response schemas (bigcommerce#1101)

* style

* add path variables

* terms of service, file order

* terms of service

* remove request runner

* remove duplicate auth section

* storefront tokens move auth section

* remove request runner

* add v2 and v3 to rates

* add paths

* remove store_hash path parameter from all endpoints.

* cleaned up some store_hash and x-stoplight artifacts

* empty parameters type error after store_hash deletes

* remove ''s and ''t syntax errors

* add description to store hash

* add description to storefront url store domain

* add description to app api app_domain

* move orders file front matter to front

* price lists -- add header parameters, fix typos

* wishlists & widgets, parameter cleanup

* tax settings, reorganize, add header parameters

* themes parameters

* tax properties spacing and schemas

* tax classes, quote endpoints, parameters

* subscribers, parameters, spaces

* storefront tokens, add header parameters

* sites, add header parameters

* store content, add header parameters

* tax provider connection, add header parameters

* shipping v2, add header parameters

* scripts, add header parameters

* redirects, add header parameters

* payment methods, add header parameters

* orders v3, add info, header parameters

* marketing, add info, header parameters

* customers, add info, header parameters

* channels, add header parameters

* payment processing, add header parameters, revise security schemes

* orders v2. SHE LINTS.

* catalog, add header parameters, debug

* (no ticket): [tools] MDX linter, create + add github action (bigcommerce#1150)

* tax provider, change oas 3.1 --> 3.0.3, lint null object

* tax rates & zone, oas 3.1 --> 3.0.3, remove oas 3.1 feature

* convert .md to .mdx

* channels, update image paths

* DEVDOCS-4719: [migrate] Settings, Customer Login, revise linter

* DEVDOCS-4719: [migrate] Stoplight links (bigcommerce#1156)

* DEVDOCS-4719: [migrate] remove x-stoplight  (bigcommerce#1157)

* correct current customer path

* update current_customer per Slack

* shipping version quotes

* updated meta object in Carts V3

* meta updates in carts.v3 file

* DEVDOCS-4719: [migrate] Shipping V3, remove truly redundant examples (bigcommerce#1162)

* DEVDOCS-4719: [migrate] Many, give meta objects properties (bigcommerce#1158)

* DEVDOCS-4719: [migrate] Handle callouts (bigcommerce#1164)

* DEVDOCS-4719: [migrate] Many, add array items (bigcommerce#1160)

* DEVDOCS-4719: [migrate] Many, add object properties (bigcommerce#1161)

* DEVDOCS-4719: [migrate] response bodies (bigcommerce#1165)

* (no ticket): [migrate] Many, resolve errors

* (no ticket): [migrate] Carts SF, re-lint

* (no ticket): [revise] Customers SF, Standardize create a customer summary (bigcommerce#1176)

* DEVDOCS-4719: [migrate] Catalog V3, fix request body not rendering  (bigcommerce#1163)

* DEVDOCS-4719: [migrate] Catalog V3, rendering issues (bigcommerce#1166)

* DEVDOCS-4719: [migrate] Many, update additionalProperties (bigcommerce#1174)

* (no ticket): [remove] Catalog V3, generic catalog tag (bigcommerce#1180)

See also PR bigcommerce#1175

* apostrophes

* DEVDOCS-4719: [migrate] Email Templates and Custom Template Associations, migrate syntax (bigcommerce#1181)

* DEVDOCS-4719: [migrate] Email templates, unify (bigcommerce#1188)

* remove ambiguous hyphen

* DEVDOCS-4719: [migrate] Webhook schemas (bigcommerce#1189)

* Change 'description' to 'properties' within store_cart_created.yml (bigcommerce#1191)

* DEVDOCS-4719: [migrate] Price Lists V3 API, remove content type header from GET (bigcommerce#1187)

* DEVDOCS-4719 [migrate] Orders, summary/table cleanup (bigcommerce#1185)

* DEVDOCS-4719: [migrate] Tax V3 API, rendering (bigcommerce#1183)

* DEVDOCS-4719: [migrate] Tax Provider API, request example rendering (bigcommerce#1195)

* DEVDOCS-4719: [migrate] Shipping provider API, move example (bigcommerce#1194)

* move response example for Request Rates

* change example names

* DEVDOCS-4719: [migrate] Tax APIs  (bigcommerce#1196)

* DEVDOCS-4719: [migrate] Shipping APIs, move example (bigcommerce#1197)

* DEVDOCS-4719: [migrate] Carts SF & V3, rendering-based changes (bigcommerce#1199)

* change auth docs links (bigcommerce#1202)

* Migrate links bigcommerce#1 (bigcommerce#1204)

* available-apis, storefront-graphql
* storefront carts
* carts v3
* catalog
* channels
* sf checkouts
* sf carts, change links to sf from v3
* checkouts v3
* sf consent
* currencies
* wishlists
* widgets
* webhooks
* tax provider
* customers v2
* shipping v2
* customers v3
* orders v2
* payment processing

* add tags to email templates and custom template associations (bigcommerce#1206)

* Migrate links bigcommerce#2 (bigcommerce#1207)

* incorporate BOPIS changes, SF checkouts

* incorporate BOPIS changes, checkouts V3

* incorporate BOPIS changes, orders V2

* incorporate BOPIS changes

* manual resolution commits

* fix incorrect casing for pickup method id field

* copyedit description

* fix(checkout): CHECKOUT-7328 Update discounted_amount description (bigcommerce#1186)

* docs(orders): DEVDOCS-4800 allow updating billing address & shipping address custom form fields in Orders v2 API

Co-authored-by: bc-andreadao <[email protected]>
Co-authored-by: Traci Porter <[email protected]>
Co-authored-by: Sarah Riehl <[email protected]>
Co-authored-by: Tina Gomez <[email protected]>
Co-authored-by: Matthew Volk <[email protected]>
Co-authored-by: stanzikratelbc <[email protected]>
Co-authored-by: Nate Stewart <[email protected]>
Co-authored-by: Tina Gomez <[email protected]>
Co-authored-by: Valentin Dellangela <[email protected]>
Co-authored-by: Donald Nguyen <[email protected]>

* Remove duplicate consignment from Order_Put

* DEVDOCS-4702: [remove] OrdersV3, Remove batch endpoints for Refund Quotes and Refunds (bigcommerce#1216)

Remove Batch endpoints for Refund Quotes and Refunds

---------

Co-authored-by: Traci Porter <[email protected]>
Co-authored-by: Mark Murphy <[email protected]>
Co-authored-by: bc-andreadao <[email protected]>
Co-authored-by: Tina Gomez <[email protected]>
Co-authored-by: Sarah Riehl <[email protected]>
Co-authored-by: Tina Gomez <[email protected]>
…rce#1126)

* DEVDOCS-4693

* DEVDOCS-4575: [update] Catalog V3 API, update request response schemas (bigcommerce#1101)

* Added /stores/{store_hash}/v2 to the paths

* resolving errors

* resolving error

---------

Co-authored-by: bc-andreadao <[email protected]>
Co-authored-by: Tina Gomez <[email protected]>
Co-authored-by: Sarah Riehl <[email protected]>
@slsriehl slsriehl changed the base branch from main to DEVDOCS-4878 April 10, 2023 04:57
@slsriehl slsriehl self-assigned this Apr 10, 2023
@slsriehl slsriehl changed the base branch from DEVDOCS-4878 to main June 9, 2023 00:50
@slsriehl
Copy link
Contributor

slsriehl commented Jun 9, 2023

rebase this one too, please.

@slsriehl
Copy link
Contributor

Thanks, @kzhang-dsg !

@slsriehl slsriehl changed the title create webhook_Put object to fix the required fields (no ticket): [external] Webhooks, create webhook_Put schema without required fields Dec 26, 2023
@slsriehl slsriehl merged commit 83029d0 into bigcommerce:main Dec 26, 2023
2 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants