Skip to content

Commit ccf70eb

Browse files
fix: updated descriptions
1 parent 9eed317 commit ccf70eb

12 files changed

Lines changed: 27 additions & 28 deletions

File tree

packages/contentstack-bulk-publish/src/commands/cm/assets/publish.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ class AssetsPublishCommand extends Command {
1414
assetsFlags.retryFailed = assetsFlags['retry-failed'] || assetsFlags.retryFailed || false;
1515
assetsFlags.folderUid = assetsFlags['folder-uid'] || assetsFlags.folderUid;
1616
assetsFlags.bulkPublish = assetsFlags['bulk-publish'] || assetsFlags.bulkPublish;
17-
assetsFlags.apiVersion = assetsFlags['api-version']
17+
assetsFlags.apiVersion = assetsFlags['api-version'] || '3'; // setting default value for apiVersion
1818
delete assetsFlags['api-version']
1919
delete assetsFlags['retry-failed'];
2020
delete assetsFlags['folder-uid'];
@@ -214,8 +214,7 @@ AssetsPublishCommand.flags = {
214214
parse: printFlagDeprecation(['-b', '--bulkPublish'], ['--bulk-publish']),
215215
}),
216216
'api-version': flags.string({
217-
description : "API Version to be used",
218-
default: '3'
217+
description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
219218
}),
220219
'delivery-token': flags.string({ description: 'Delivery token for source environment' }),
221220
'source-env': flags.string({ description: 'Source environment' }),

packages/contentstack-bulk-publish/src/commands/cm/assets/unpublish.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class UnpublishCommand extends Command {
1515
unpublishFlags.retryFailed = unpublishFlags['retry-failed'] || unpublishFlags.retryFailed || false;
1616
unpublishFlags.bulkUnpublish = unpublishFlags['bulk-unpublish'] || unpublishFlags.bulkUnpublish;
1717
unpublishFlags.deliveryToken = unpublishFlags['delivery-token'] || unpublishFlags.deliveryToken;
18-
unpublishFlags.apiVersion = unpublishFlags['api-version']
18+
unpublishFlags.apiVersion = unpublishFlags['api-version'] || '3';
1919
unpublishFlags.onlyAssets = true;
2020
unpublishFlags.onlyEntries = false;
2121
delete unpublishFlags['api-version']
@@ -158,8 +158,7 @@ UnpublishCommand.flags = {
158158
default: 'true',
159159
}),
160160
'api-version': flags.string({
161-
description : "API Version to be used",
162-
default: '3'
161+
description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
163162
}),
164163
'delivery-token': flags.string({
165164
description: 'Delivery Token for source environment',

packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ class CrossPublishCommand extends Command {
134134
delete _flags['bulk-publish'];
135135
}
136136
if ('api-version' in _flags) {
137-
_flags.apiVersion = _flags['api-version'];
137+
_flags.apiVersion = _flags['api-version'] || '3';
138138
delete _flags['api-version'];
139139
}
140140
if ('source-env' in _flags) {
@@ -185,8 +185,7 @@ CrossPublishCommand.flags = {
185185
default: 'true',
186186
}),
187187
'api-version': flags.string({
188-
description : "API Version to be used",
189-
default: '3'
188+
description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
190189
}),
191190
contentType: flags.string({
192191
char: 't',

packages/contentstack-bulk-publish/src/commands/cm/entries/publish-modified.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class PublishModifiedCommand extends Command {
1616
entryEditsFlags.contentTypes = entryEditsFlags['content-types'] || entryEditsFlags.contentTypes;
1717
entryEditsFlags.bulkPublish = entryEditsFlags['bulk-publish'] || entryEditsFlags.bulkPublish;
1818
entryEditsFlags.sourceEnv = entryEditsFlags['source-env'] || entryEditsFlags.sourceEnv;
19-
entryEditsFlags.apiVersion = entryEditsFlags['api-version']
19+
entryEditsFlags.apiVersion = entryEditsFlags['api-version'] || '3';
2020
delete entryEditsFlags['api-version']
2121
delete entryEditsFlags['retry-failed'];
2222
delete entryEditsFlags['content-types'];
@@ -143,8 +143,7 @@ PublishModifiedCommand.flags = {
143143
default: 'true',
144144
}),
145145
'api-version': flags.string({
146-
description : "API Version to be used",
147-
default: '3'
146+
description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
148147
}),
149148
sourceEnv: flags.string({
150149
char: 's',

packages/contentstack-bulk-publish/src/commands/cm/entries/publish-non-localized-fields.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class NonlocalizedFieldChangesCommand extends Command {
1919
nonlocalizedFieldChangesFlags['source-env'] || nonlocalizedFieldChangesFlags.sourceEnv;
2020
nonlocalizedFieldChangesFlags.contentTypes =
2121
nonlocalizedFieldChangesFlags['content-types'] || nonlocalizedFieldChangesFlags.contentTypes;
22-
nonlocalizedFieldChangesFlags.apiVersion = nonlocalizedFieldChangesFlags['api-version']
22+
nonlocalizedFieldChangesFlags.apiVersion = nonlocalizedFieldChangesFlags['api-version'] || '3';
2323

2424
delete nonlocalizedFieldChangesFlags['api-version']
2525
delete nonlocalizedFieldChangesFlags['retry-failed'];
@@ -173,8 +173,7 @@ NonlocalizedFieldChangesCommand.flags = {
173173
parse: printFlagDeprecation(['-b', '--bulkPublish'], ['--bulk-publish']),
174174
}),
175175
'api-version': flags.string({
176-
description : "API Version to be used",
177-
default: '3'
176+
description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
178177
}),
179178
sourceEnv: flags.string({
180179
char: 's',

packages/contentstack-bulk-publish/src/commands/cm/entries/publish-only-unpublished.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@ PublishOnlyUnpublished.flags = {
4646
default: 'true',
4747
}),
4848
'api-version': flags.string({
49-
description : "API Version to be used",
50-
default: '3'
49+
description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
5150
}),
5251
sourceEnv: flags.string({
5352
char: 's',

packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class PublishEntriesCommand extends Command {
2020
entriesFlags.bulkPublish = entriesFlags['bulk-publish'] || entriesFlags.bulkPublish;
2121
entriesFlags.publishAllContentTypes =
2222
entriesFlags['publish-all-content-types'] || entriesFlags.publishAllContentTypes || false;
23-
entriesFlags.apiVersion = entriesFlags['api-version']
23+
entriesFlags.apiVersion = entriesFlags['api-version'] || '3';
2424
delete entriesFlags['api-version'];
2525
delete entriesFlags['retry-failed'];
2626
delete entriesFlags['content-types'];
@@ -188,8 +188,7 @@ PublishEntriesCommand.flags = {
188188
default: 'true',
189189
}),
190190
'api-version': flags.string({
191-
description : "API Version to be used",
192-
default: '3'
191+
description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
193192
}),
194193
'publish-all-content-types': flags.boolean({
195194
description: '(optional) Publish all contenttypes (cannot be set when contentTypes flag is set)',

packages/contentstack-bulk-publish/src/commands/cm/entries/unpublish.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class UnpublishCommand extends Command {
1818
unpublishFlags.deliveryToken = unpublishFlags['delivery-token'] || unpublishFlags.deliveryToken;
1919
unpublishFlags.onlyAssets = false;
2020
unpublishFlags.onlyEntries = true;
21-
unpublishFlags.apiVersion = unpublishFlags['api-version'];
21+
unpublishFlags.apiVersion = unpublishFlags['api-version'] || '3';
2222
delete unpublishFlags['api-version'];
2323
delete unpublishFlags['retry-failed'];
2424
delete unpublishFlags['bulk-unpublish'];
@@ -159,8 +159,7 @@ UnpublishCommand.flags = {
159159
default: 'true',
160160
}),
161161
'api-version': flags.string({
162-
description : "API Version to be used",
163-
default: '3'
162+
description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
164163
}),
165164
'content-type': flags.string({
166165
description: 'Content type filter',

packages/contentstack-bulk-publish/src/commands/cm/entries/update-and-publish.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class UpdateAndPublishCommand extends Command {
1515
addFieldsFlags.retryFailed = addFieldsFlags['retry-failed'] || addFieldsFlags.retryFailed || false;
1616
addFieldsFlags.contentTypes = addFieldsFlags['content-types'] || addFieldsFlags.contentTypes;
1717
addFieldsFlags.bulkPublish = addFieldsFlags['bulk-publish'] || addFieldsFlags.bulkPublish;
18-
addFieldsFlags.apiVersion = addFieldsFlags['api-version'];
18+
addFieldsFlags.apiVersion = addFieldsFlags['api-version'] || '3';
1919
delete addFieldsFlags['api-version'];
2020
delete addFieldsFlags['retry-failed'];
2121
delete addFieldsFlags['content-types'];
@@ -123,8 +123,7 @@ UpdateAndPublishCommand.flags = {
123123
default: 'true',
124124
}),
125125
'api-version': flags.string({
126-
description : "API Version to be used",
127-
default: '3'
126+
description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
128127
}),
129128
'content-types': flags.string({
130129
description: 'The Contenttypes from which entries will be published',

packages/contentstack-bulk-publish/src/commands/cm/stacks/publish.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,10 @@ StackPublishCommand.examples = [
5050
'csdx cm:stacks:publish --retry-failed [LOG FILE NAME]',
5151
'',
5252
'Using --branch flag',
53-
'csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]'
53+
'csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]',
54+
'',
55+
'Using --api-version flag',
56+
'csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --api-version [API VERSION]',
5457
];
5558

5659
StackPublishCommand.flags = []; // Same as entries and assets.

0 commit comments

Comments
 (0)