Skip to content

Commit 95c4cb9

Browse files
mcvincicursoragent
andauthored
[2026-04-rc] Make API headings consistent in POS UI and Admin UI (#3832)
* Standardize API documentation to use 'Methods' section headings Updated all Admin and POS API documentation files to consistently use "Methods" as the section heading instead of interface-specific names. Also updated descriptions to reference "methods" instead of "properties" for consistency. Changes: - 15 Admin API doc files (src/surfaces/admin/api/) - 20 POS API doc files (docs/surfaces/point-of-sale/reference/apis/) - Minor documentation improvements (storage limits, ID token guidance, wording) Co-authored-by: Cursor <cursoragent@cursor.com> * Rename 'Methods' to 'Properties' in API headings and descriptions Co-authored-by: Cursor <cursoragent@cursor.com> * Remove 'methods' from API description text, use 'properties' instead Co-authored-by: Cursor <cursoragent@cursor.com> * Revert title for applyMetafieldChange back to original name Co-authored-by: Cursor <cursoragent@cursor.com> * Revert title for picker back to original name Co-authored-by: Cursor <cursoragent@cursor.com> * Revert specific function/method titles back to original names Co-authored-by: Cursor <cursoragent@cursor.com> * Revert changes to using-polaris-web-components.doc.ts files Co-authored-by: Cursor <cursoragent@cursor.com> * Fix admin.app.tools.data description * Add more context re: admin.app.tools.data target --------- Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent bbbebf1 commit 95c4cb9

32 files changed

Lines changed: 58 additions & 58 deletions

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/action-api.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ const data: ReferenceEntityTemplateSchema = {
1313
type: 'APIs',
1414
definitions: [
1515
{
16-
title: 'ActionApi',
16+
title: 'Properties',
1717
description:
18-
'The `ActionApi` object provides methods for presenting modal interfaces. Access these methods through `shopify.action` to launch full-screen modal experiences.',
18+
'The `ActionApi` object provides properties for presenting modal interfaces. Access these properties through `shopify.action` to launch full-screen modal experiences.',
1919
type: 'ActionApiContent',
2020
},
2121
],

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/camera-api.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ const data: ReferenceEntityTemplateSchema = {
1212
type: 'APIs',
1313
definitions: [
1414
{
15-
title: 'CameraApi',
15+
title: 'Properties',
1616
description:
17-
'The `CameraApi` object provides methods for capturing photos using the device camera. Access these methods through `shopify.camera` to take photos and retrieve image data with metadata.',
17+
'The `CameraApi` object provides properties for capturing photos using the device camera. Access these properties through `shopify.camera` to take photos and retrieve image data with metadata.',
1818
type: 'CameraApiContent',
1919
},
2020
],

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/cart-api.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ const data: ReferenceEntityTemplateSchema = {
1313
type: 'APIs',
1414
definitions: [
1515
{
16-
title: 'CartApi',
16+
title: 'Properties',
1717
description:
1818
'The `CartApi` object provides access to cart management functionality and real-time cart state monitoring. Access these properties through `shopify.cart` to interact with the current POS cart.',
1919
type: 'CartApiContent',

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/cart-line-item-api.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ const data: ReferenceEntityTemplateSchema = {
1515
type: 'APIs',
1616
definitions: [
1717
{
18-
title: 'CartLineItemApi',
18+
title: 'Properties',
1919
description:
20-
'The `CartLineItemApi` object provides access to the current line item. Access this property through `api.cartLineItem` to interact with the current line item context.',
20+
'The `CartLineItemApi` object provides access to the current line item. Access these properties through `api.cartLineItem` to interact with the current line item context.',
2121
type: 'CartLineItemApi',
2222
},
2323
],

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/cash-drawer-api.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ const data: ReferenceEntityTemplateSchema = {
1515
type: 'APIs',
1616
definitions: [
1717
{
18-
title: 'CashDrawerApi',
18+
title: 'Properties',
1919
description:
20-
'The `CashDrawerApi` object provides methods for controlling cash drawer hardware. Access these methods through `shopify.cashDrawer` to trigger cash drawer operations.',
20+
'The `CashDrawerApi` object provides properties for controlling cash drawer hardware. Access these properties through `shopify.cashDrawer` to trigger cash drawer operations.',
2121
type: 'CashDrawerApiContent',
2222
},
2323
],

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/connectivity-api.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const data: ReferenceEntityTemplateSchema = {
1414
type: 'APIs',
1515
definitions: [
1616
{
17-
title: 'ConnectivityApi',
17+
title: 'Properties',
1818
description:
1919
'The `ConnectivityApi` object provides access to current connectivity information and change notifications. Access these properties through `shopify.connectivity` to monitor network status.',
2020
type: 'ConnectivityApiContent',

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/customer-api.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ const data: ReferenceEntityTemplateSchema = {
1313
type: 'APIs',
1414
definitions: [
1515
{
16-
title: 'CustomerApi',
16+
title: 'Properties',
1717
description:
18-
'The `CustomerApi` object provides access to customer data. Access this property through `shopify.customer` to interact with the current customer context.',
18+
'The `CustomerApi` object provides access to customer data. Access these properties through `shopify.customer` to interact with the current customer context.',
1919
type: 'CustomerApiContent',
2020
},
2121
],

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/device-api.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ const data: ReferenceEntityTemplateSchema = {
1212
type: 'APIs',
1313
definitions: [
1414
{
15-
title: 'DeviceApi',
15+
title: 'Properties',
1616
description:
17-
'The `DeviceApi` object provides access to device information and capabilities. Access these properties and methods through `shopify.device` to retrieve device details and check device characteristics.',
17+
'The `DeviceApi` object provides access to device information and capabilities. Access these properties through `shopify.device` to retrieve device details and check device characteristics.',
1818
type: 'DeviceApiContent',
1919
},
2020
],

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/draft-order-api.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ const data: ReferenceEntityTemplateSchema = {
1515
type: 'APIs',
1616
definitions: [
1717
{
18-
title: 'DraftOrderApi',
18+
title: 'Properties',
1919
description:
20-
'The `DraftOrderApi` object provides access to draft order data. Access this property through `api.draftOrder` to interact with the current draft order context.',
20+
'The `DraftOrderApi` object provides access to draft order data. Access these properties through `api.draftOrder` to interact with the current draft order context.',
2121
type: 'DraftOrderApiContent',
2222
},
2323
],

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/locale-api.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const data: ReferenceEntityTemplateSchema = {
1212
type: 'APIs',
1313
definitions: [
1414
{
15-
title: 'LocaleApi',
15+
title: 'Properties',
1616
description:
1717
'The `LocaleApi` object provides access to current locale information and change notifications. Access these properties through `shopify.locale` to retrieve and monitor locale data.',
1818
type: 'LocaleApiContent',

0 commit comments

Comments
 (0)