Skip to content

Commit 49f4d4d

Browse files
anakafeelanakafeel
committed
chore(docs): rebuild dev docs
1 parent 9d1641b commit 49f4d4d

File tree

4 files changed

+167
-0
lines changed

4 files changed

+167
-0
lines changed

‎docs-shopify.dev/commands/app-config-pull.doc.ts‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
3+
4+
const data: ReferenceEntityTemplateSchema = {
5+
name: 'app config pull',
6+
description: `Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file.
7+
8+
This command reuses the existing linked app and organization and skips all interactive prompts. Use \`--config\` to target a specific configuration file, or omit it to use the default one.`,
9+
overviewPreviewDescription: `Refresh an already-linked app configuration without prompts.`,
10+
type: 'command',
11+
isVisualComponent: false,
12+
defaultExample: {
13+
codeblock: {
14+
tabs: [
15+
{
16+
title: 'app config pull',
17+
code: './examples/app-config-pull.example.sh',
18+
language: 'bash',
19+
},
20+
],
21+
title: 'app config pull',
22+
},
23+
},
24+
definitions: [
25+
{
26+
title: 'Flags',
27+
description: 'The following flags are available for the `app config pull` command:',
28+
type: 'appconfigpull',
29+
},
30+
],
31+
category: 'app',
32+
related: [
33+
],
34+
}
35+
36+
export default data

‎docs-shopify.dev/commands/examples/app-config-pull.example.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
shopify app config pull [flags]

‎docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
export interface appconfigpull {
3+
/**
4+
* The Client ID of your app.
5+
* @environment SHOPIFY_FLAG_CLIENT_ID
6+
*/
7+
'--client-id <value>'?: string
8+
9+
/**
10+
* The name of the app configuration.
11+
* @environment SHOPIFY_FLAG_APP_CONFIG
12+
*/
13+
'-c, --config <value>'?: string
14+
15+
/**
16+
* Disable color output.
17+
* @environment SHOPIFY_FLAG_NO_COLOR
18+
*/
19+
'--no-color'?: ''
20+
21+
/**
22+
* The path to your app directory.
23+
* @environment SHOPIFY_FLAG_PATH
24+
*/
25+
'--path <value>'?: string
26+
27+
/**
28+
* Reset all your settings.
29+
* @environment SHOPIFY_FLAG_RESET
30+
*/
31+
'--reset'?: ''
32+
33+
/**
34+
* Increase the verbosity of the output.
35+
* @environment SHOPIFY_FLAG_VERBOSE
36+
*/
37+
'--verbose'?: ''
38+
}

‎docs-shopify.dev/generated/generated_docs_data.json‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,98 @@
192192
"category": "app",
193193
"related": []
194194
},
195+
{
196+
"name": "app config pull",
197+
"description": "Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file.\n\nThis command reuses the existing linked app and organization and skips all interactive prompts. Use `--config` to target a specific configuration file, or omit it to use the default one.",
198+
"overviewPreviewDescription": "Refresh an already-linked app configuration without prompts.",
199+
"type": "command",
200+
"isVisualComponent": false,
201+
"defaultExample": {
202+
"codeblock": {
203+
"tabs": [
204+
{
205+
"title": "app config pull",
206+
"code": "shopify app config pull [flags]",
207+
"language": "bash"
208+
}
209+
],
210+
"title": "app config pull"
211+
}
212+
},
213+
"definitions": [
214+
{
215+
"title": "Flags",
216+
"description": "The following flags are available for the `app config pull` command:",
217+
"type": "appconfigpull",
218+
"typeDefinitions": {
219+
"appconfigpull": {
220+
"filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
221+
"name": "appconfigpull",
222+
"description": "",
223+
"members": [
224+
{
225+
"filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
226+
"syntaxKind": "PropertySignature",
227+
"name": "--client-id <value>",
228+
"value": "string",
229+
"description": "The Client ID of your app.",
230+
"isOptional": true,
231+
"environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
232+
},
233+
{
234+
"filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
235+
"syntaxKind": "PropertySignature",
236+
"name": "--no-color",
237+
"value": "\"\"",
238+
"description": "Disable color output.",
239+
"isOptional": true,
240+
"environmentValue": "SHOPIFY_FLAG_NO_COLOR"
241+
},
242+
{
243+
"filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
244+
"syntaxKind": "PropertySignature",
245+
"name": "--path <value>",
246+
"value": "string",
247+
"description": "The path to your app directory.",
248+
"isOptional": true,
249+
"environmentValue": "SHOPIFY_FLAG_PATH"
250+
},
251+
{
252+
"filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
253+
"syntaxKind": "PropertySignature",
254+
"name": "--reset",
255+
"value": "\"\"",
256+
"description": "Reset all your settings.",
257+
"isOptional": true,
258+
"environmentValue": "SHOPIFY_FLAG_RESET"
259+
},
260+
{
261+
"filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
262+
"syntaxKind": "PropertySignature",
263+
"name": "--verbose",
264+
"value": "\"\"",
265+
"description": "Increase the verbosity of the output.",
266+
"isOptional": true,
267+
"environmentValue": "SHOPIFY_FLAG_VERBOSE"
268+
},
269+
{
270+
"filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
271+
"syntaxKind": "PropertySignature",
272+
"name": "-c, --config <value>",
273+
"value": "string",
274+
"description": "The name of the app configuration.",
275+
"isOptional": true,
276+
"environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
277+
}
278+
],
279+
"value": "export interface appconfigpull {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id <value>'?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config <value>'?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
280+
}
281+
}
282+
}
283+
],
284+
"category": "app",
285+
"related": []
286+
},
195287
{
196288
"name": "app config use",
197289
"description": "Sets default configuration when you run app-related CLI commands. If you omit the `config-name` parameter, then you'll be prompted to choose from the configuration files in your project.",

0 commit comments

Comments
 (0)