Skip to content

Commit fc6b5c9

Browse files
committed
IA for Target APIs and components
revert .nvmrc file revert .nvmrc file
1 parent c16f464 commit fc6b5c9

File tree

50 files changed

+168
-78
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+168
-78
lines changed

packages/ui-extensions/src/surfaces/admin/api/action/action.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ const data: ReferenceEntityTemplateSchema = {
1313
type: 'ActionExtensionApi',
1414
},
1515
],
16-
category: 'API',
17-
subCategory: 'Target APIs',
16+
category: 'Target APIs',
17+
subCategory: 'Core APIs',
1818
related: [],
1919
};
2020

packages/ui-extensions/src/surfaces/admin/api/block/block.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ const data: ReferenceEntityTemplateSchema = {
1313
type: 'BlockExtensionApi',
1414
},
1515
],
16-
category: 'API',
17-
subCategory: 'Target APIs',
16+
category: 'Target APIs',
17+
subCategory: 'Core APIs',
1818
related: [],
1919
};
2020

packages/ui-extensions/src/surfaces/admin/api/checkout-rules/validation-settings.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ const data: ReferenceEntityTemplateSchema = {
1818
type: 'ValidationData',
1919
},
2020
],
21-
category: 'API',
22-
subCategory: 'Target APIs',
21+
category: 'Target APIs',
22+
subCategory: 'Contextual APIs',
2323
related: [],
2424
};
2525

packages/ui-extensions/src/surfaces/admin/api/customer-segment-template/customer-segment-template.doc.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
22

33
const data: ReferenceEntityTemplateSchema = {
4-
name: 'CustomerSegmentTemplate Extension API',
4+
name: 'Customer Segment Template Extension API',
55
description:
66
'This API is available to all customer segment template extension types.',
77
isVisualComponent: false,
@@ -13,8 +13,8 @@ const data: ReferenceEntityTemplateSchema = {
1313
type: 'CustomerSegmentTemplateApi',
1414
},
1515
],
16-
category: 'API',
17-
subCategory: 'Target APIs',
16+
category: 'Target APIs',
17+
subCategory: 'Contextual APIs',
1818
related: [],
1919
};
2020

packages/ui-extensions/src/surfaces/admin/api/discount-function-settings/discount-function-settings.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ const data: ReferenceEntityTemplateSchema = {
1919
type: 'DiscountFunctionSettingsData',
2020
},
2121
],
22-
category: 'API',
23-
subCategory: 'Target APIs',
22+
category: 'Target APIs',
23+
subCategory: 'Contextual APIs',
2424
related: [],
2525
};
2626

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
2+
3+
const data: ReferenceEntityTemplateSchema = {
4+
name: 'Order Routing Rule API',
5+
description:
6+
'This API is available to extensions that render in the order routing settings using the `admin.settings.order-routing-rule.render` target.',
7+
isVisualComponent: false,
8+
type: 'API',
9+
definitions: [
10+
{
11+
title: 'OrderRoutingRuleApi',
12+
description: '',
13+
type: 'OrderRoutingRuleApi',
14+
},
15+
],
16+
category: 'Target APIs',
17+
subCategory: 'Contextual APIs',
18+
related: [],
19+
};
20+
21+
export default data;
22+

packages/ui-extensions/src/surfaces/admin/api/picker/picker.doc.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
22

33
const data: ReferenceEntityTemplateSchema = {
4-
name: 'Picker',
4+
name: 'Picker API',
55
overviewPreviewDescription: 'Opens a Picker in your app',
66
description: `The Picker API provides a search-based interface to help users find and select one or more resources that you provide, such as product reviews, email templates, or subscription options, and then returns the selected resource ids to your extension.
77
88
> Tip:
99
> If you are picking products, product variants, or collections, you should use the [Resource Picker](resource-picker) API instead.`,
1010
isVisualComponent: true,
11-
category: 'API',
11+
category: 'Target APIs',
12+
subCategory: 'Utility APIs',
1213
thumbnail: 'picker.png',
1314
requires:
1415
'an Admin [block](/docs/api/admin-extensions/unstable/extension-targets#block-locations), [action](/docs/api/admin-extensions/unstable/extension-targets#action-locations), or [print](/docs/api/admin-extensions/unstable/extension-targets#print-locations) extension.',
@@ -102,7 +103,7 @@ const data: ReferenceEntityTemplateSchema = {
102103
},
103104
related: [
104105
{
105-
name: 'Resource Picker',
106+
name: 'Resource Picker API',
106107
subtitle: 'APIs',
107108
url: 'resource-picker',
108109
type: 'pickaxe-3',

packages/ui-extensions/src/surfaces/admin/api/print-action/print-action.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ const data: ReferenceEntityTemplateSchema = {
1313
type: 'PrintActionExtensionApi',
1414
},
1515
],
16-
category: 'API',
17-
subCategory: 'Target APIs',
16+
category: 'Target APIs',
17+
subCategory: 'Core APIs',
1818
related: [],
1919
};
2020

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
2+
3+
const data: ReferenceEntityTemplateSchema = {
4+
name: 'Product Details Configuration API',
5+
description:
6+
'This API is available to product configuration extensions that render on the product details page. See the [tutorial](/docs/apps/selling-strategies/bundles/product-config) for more information.',
7+
isVisualComponent: false,
8+
type: 'API',
9+
definitions: [
10+
{
11+
title: 'ProductDetailsConfigurationApi',
12+
description: '',
13+
type: 'ProductDetailsConfigurationApi',
14+
},
15+
],
16+
category: 'Target APIs',
17+
subCategory: 'Contextual APIs',
18+
related: [],
19+
};
20+
21+
export default data;
22+
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
2+
3+
const data: ReferenceEntityTemplateSchema = {
4+
name: 'Product Variant Details Configuration API',
5+
description:
6+
'This API is available to product configuration extensions that render on the product variant details page. See the [tutorial](/docs/apps/selling-strategies/bundles/product-config) for more information.',
7+
isVisualComponent: false,
8+
type: 'API',
9+
definitions: [
10+
{
11+
title: 'ProductVariantDetailsConfigurationApi',
12+
description: '',
13+
type: 'ProductVariantDetailsConfigurationApi',
14+
},
15+
],
16+
category: 'Target APIs',
17+
subCategory: 'Contextual APIs',
18+
related: [],
19+
};
20+
21+
export default data;
22+

0 commit comments

Comments
 (0)