Skip to content

DEVDOCS-4105: [update] OAS files, use unexploded arrays for csv params#221

Merged
slsriehl merged 83 commits intomainfrom
DEVDOCS-4105-unexploded
Apr 11, 2024
Merged

DEVDOCS-4105: [update] OAS files, use unexploded arrays for csv params#221
slsriehl merged 83 commits intomainfrom
DEVDOCS-4105-unexploded

Conversation

@slsriehl
Copy link
Contributor

@slsriehl slsriehl commented Apr 11, 2024

DEVDOCS-4105

What changed?

  • Every CSV query param is now expressed as the following:
style: form
explode: false
schema:
  type: array
  items:
    type: <integer, string, uuid string, etc>
  • sporadic scope sprawl to clean things up

Release notes draft

Anything else?

ping @bc-tgomez @bc-andreadao @bc-traciporter @bobbyshaw

valentindellangela and others added 30 commits March 20, 2023 14:04
)

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>
Co-authored-by: Mark Murphy <mark.murphy@bigcommerce.com>
* DEVDOCS-4633

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

Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>

---------

Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>
…g and shipping (#1215)

* docs(orders): DEVDOCS-4800 allow updating billing address & shipping address custom form fields in Orders v2 API (#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 (#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 (#1043)

* DEVDOCS-4568: [revise open PR] Align dst_offset (#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 (#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 (#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 (#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 (#1156)

* DEVDOCS-4719: [migrate] remove x-stoplight  (#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 (#1162)

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

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

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

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

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

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

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

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

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

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

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

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

See also PR #1175

* apostrophes

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

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

* remove ambiguous hyphen

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

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

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

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

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

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

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

* move response example for Request Rates

* change example names

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

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

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

* change auth docs links (#1202)

* Migrate links #1 (#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 (#1206)

* Migrate links #2 (#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 (#1186)

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

Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Matthew Volk <matt.volk@bigcommerce.com>
Co-authored-by: stanzikratelbc <108146487+stanzikratelbc@users.noreply.github.com>
Co-authored-by: Nate Stewart <nate.stewart@bigcommerce.com>
Co-authored-by: Tina Gomez <94003415+bc-tgomez@users.noreply.github.com>
Co-authored-by: Valentin Dellangela <43359039+valentindellangela@users.noreply.github.com>
Co-authored-by: Donald Nguyen <donald.nguyen@bigcommerce.com>

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

Remove Batch endpoints for Refund Quotes and Refunds
)

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>
Co-authored-by: Mark Murphy <mark.murphy@bigcommerce.com>
* DEVDOCS-4633

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

Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>

---------

Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>
…g and shipping (#1215)

* docs(orders): DEVDOCS-4800 allow updating billing address & shipping address custom form fields in Orders v2 API (#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 (#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 (#1043)

* DEVDOCS-4568: [revise open PR] Align dst_offset (#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 (#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 (#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 (#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 (#1156)

* DEVDOCS-4719: [migrate] remove x-stoplight  (#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 (#1162)

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

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

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

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

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

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

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

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

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

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

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

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

See also PR #1175

* apostrophes

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

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

* remove ambiguous hyphen

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

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

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

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

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

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

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

* move response example for Request Rates

* change example names

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

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

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

* change auth docs links (#1202)

* Migrate links #1 (#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 (#1206)

* Migrate links #2 (#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 (#1186)

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

Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Matthew Volk <matt.volk@bigcommerce.com>
Co-authored-by: stanzikratelbc <108146487+stanzikratelbc@users.noreply.github.com>
Co-authored-by: Nate Stewart <nate.stewart@bigcommerce.com>
Co-authored-by: Tina Gomez <94003415+bc-tgomez@users.noreply.github.com>
Co-authored-by: Valentin Dellangela <43359039+valentindellangela@users.noreply.github.com>
Co-authored-by: Donald Nguyen <donald.nguyen@bigcommerce.com>

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

Remove Batch endpoints for Refund Quotes and Refunds
…tems Overrides (#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 <traci.porter@bigcommerce.com>

* Update reference/carts.v3.yml

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>

* Update reference/carts.v3.yml

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>

* Update reference/carts.v3.yml

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>

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

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>
Co-authored-by: Mark Murphy <mark.murphy@bigcommerce.com>

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

* DEVDOCS-4633

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

Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>

---------

Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>

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

* docs(orders): DEVDOCS-4800 allow updating billing address & shipping address custom form fields in Orders v2 API (#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 (#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 (#1043)

* DEVDOCS-4568: [revise open PR] Align dst_offset (#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 (#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 (#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 (#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 (#1156)

* DEVDOCS-4719: [migrate] remove x-stoplight  (#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 (#1162)

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

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

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

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

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

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

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

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

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

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

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

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

See also PR #1175

* apostrophes

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

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

* remove ambiguous hyphen

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

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

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

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

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

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

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

* move response example for Request Rates

* change example names

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

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

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

* change auth docs links (#1202)

* Migrate links #1 (#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 (#1206)

* Migrate links #2 (#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 (#1186)

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

Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Matthew Volk <matt.volk@bigcommerce.com>
Co-authored-by: stanzikratelbc <108146487+stanzikratelbc@users.noreply.github.com>
Co-authored-by: Nate Stewart <nate.stewart@bigcommerce.com>
Co-authored-by: Tina Gomez <94003415+bc-tgomez@users.noreply.github.com>
Co-authored-by: Valentin Dellangela <43359039+valentindellangela@users.noreply.github.com>
Co-authored-by: Donald Nguyen <donald.nguyen@bigcommerce.com>

* Remove duplicate consignment from Order_Put

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

Remove Batch endpoints for Refund Quotes and Refunds

---------

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>
Co-authored-by: Mark Murphy <mark.murphy@bigcommerce.com>
Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>
Co-authored-by: Tina Gomez <94003415+bc-tgomez@users.noreply.github.com>
…tems Overrides (#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 <traci.porter@bigcommerce.com>

* Update reference/carts.v3.yml

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>

* Update reference/carts.v3.yml

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>

* Update reference/carts.v3.yml

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>

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

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>
Co-authored-by: Mark Murphy <mark.murphy@bigcommerce.com>

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

* DEVDOCS-4633

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

Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>

---------

Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>

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

* docs(orders): DEVDOCS-4800 allow updating billing address & shipping address custom form fields in Orders v2 API (#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 (#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 (#1043)

* DEVDOCS-4568: [revise open PR] Align dst_offset (#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 (#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 (#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 (#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 (#1156)

* DEVDOCS-4719: [migrate] remove x-stoplight  (#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 (#1162)

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

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

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

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

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

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

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

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

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

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

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

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

See also PR #1175

* apostrophes

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

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

* remove ambiguous hyphen

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

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

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

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

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

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

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

* move response example for Request Rates

* change example names

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

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

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

* change auth docs links (#1202)

* Migrate links #1 (#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 (#1206)

* Migrate links #2 (#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 (#1186)

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

Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Matthew Volk <matt.volk@bigcommerce.com>
Co-authored-by: stanzikratelbc <108146487+stanzikratelbc@users.noreply.github.com>
Co-authored-by: Nate Stewart <nate.stewart@bigcommerce.com>
Co-authored-by: Tina Gomez <94003415+bc-tgomez@users.noreply.github.com>
Co-authored-by: Valentin Dellangela <43359039+valentindellangela@users.noreply.github.com>
Co-authored-by: Donald Nguyen <donald.nguyen@bigcommerce.com>

* Remove duplicate consignment from Order_Put

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

Remove Batch endpoints for Refund Quotes and Refunds

---------

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>
Co-authored-by: Mark Murphy <mark.murphy@bigcommerce.com>
Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>
Co-authored-by: Tina Gomez <94003415+bc-tgomez@users.noreply.github.com>
update minLength for Tree schema
* DEVDOCS-4693

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

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

* resolving errors

* resolving error

---------

Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>
update minLength for Tree schema
* DEVDOCS-4693

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

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

* resolving errors

* resolving error

---------

Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>
* DEVDOCS-4766
* updated X-Auth-Token to resolve error

---------

Authored by: @bc-traciporter
…ens (#1107)

DEVDOCS-4638: [value add] Checkouts V3, add detail about checkout tokens #1107

---------

Authored by: @bc-traciporter
…ition (#1108)

DEVDOCS-4684

* resolve conflicts

---------
Authored by: @bc-traciporter
* DEVDOCS-4693: [update] Get all states, add query parameters 

---------

Authored by: @bc-traciporter
* DEVDOCS-4766
* updated X-Auth-Token to resolve error

---------

Authored by: @bc-traciporter
…ens (#1107)

DEVDOCS-4638: [value add] Checkouts V3, add detail about checkout tokens #1107

---------

Authored by: @bc-traciporter
…ition (#1108)

DEVDOCS-4684

* resolve conflicts

---------
Authored by: @bc-traciporter
#1124)

* Update items array

* Added item_id tax exemption, corrected Example request body

* Remove order_id from return request example

* Spelling check and grammar edits

* Apply suggestions from code review

* Update item id description for tax exempt refunds

* Resolve conflicts in file
…with customer file uploads (#1116)

* Update with examples

* Update example response for Get an Order Product, add custom field info

* Update example response for Get an Order Product

* Update Order product options  description and example.

* Remove extra spacing in schema

* Update value description

* Add correct value file example

* Add correct value file example

* Correct problems

* string type
…source read only attribute (#1136)

* Revert "DEVDOCS-4575: [update] Catalog V3 API, update request response schemas (#1101)"
* Check out lint errors
* Attempt to fix linter issues
@slsriehl slsriehl merged commit 59cc924 into main Apr 11, 2024
@slsriehl slsriehl deleted the DEVDOCS-4105-unexploded branch April 11, 2024 19:48
@bobbyshaw
Copy link
Contributor

Hero.

bc-tgomez added a commit that referenced this pull request Apr 26, 2024
#221)

<!-- Ticket number or summary of work -->
# [DEVDOCS-4105]

## What changed?
<!-- Provide a bulleted list in the present tense -->
* Every CSV query param is now expressed as the following:
```yaml
style: form
explode: false
schema:
  type: array
  items:
    type: <integer, string, uuid string, etc>
```
* sporadic scope sprawl to clean things up

## Release notes draft
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
* 

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping @bc-tgomez @bc-andreadao @bc-traciporter @bobbyshaw 


[DEVDOCS-4105]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-4105?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

---------

Co-authored-by: Valentin Dellangela <43359039+valentindellangela@users.noreply.github.com>
Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>
Co-authored-by: Mark Murphy <mark.murphy@bigcommerce.com>
Co-authored-by: bc-andreadao <96258747+bc-andreadao@users.noreply.github.com>
Co-authored-by: Tina Gomez <tina.gomez@bigcommerce.com>
Co-authored-by: Tina Gomez <94003415+bc-tgomez@users.noreply.github.com>
Co-authored-by: Andrew Chan <andrew.chan@bigcommerce.com>
Co-authored-by: Mo <64647846+S48-Mo@users.noreply.github.com>
Co-authored-by: Josh Di Fabio <joshdifabio@gmail.com>
Co-authored-by: ansnaldo <34357510+ansnaldo@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants