Skip to content

Commit 3b1babb

Browse files
mujammil10Naitik333
authored andcommitted
Update command docs
Signed-off-by: Ansari, Mujammil <mujammil.ansari@here.com>
1 parent 47fbcb9 commit 3b1babb

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

src/here-interactivemap.ts

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -66,21 +66,21 @@ program.version("0.1.0");
6666

6767
program
6868
.command("create [catalogHrn]")
69-
.description("create a new Interactive Map layer")
70-
.requiredOption("-i, --id <id>", "Id for Interactive Map layer")
71-
.requiredOption("-n, --layerName <layerName>", "Name for Interactive Map layer")
69+
.description("create a new interactive map layer")
70+
.requiredOption("-i, --id <id>", "Id for interactive map layer")
71+
.requiredOption("-n, --layerName <layerName>", "Name for interactive map layer")
7272
.option("-s, --summary <summary>", "Short summary")
73-
.option("-m, --message <message>", "Description for Interactive Map layer")
73+
.option("-m, --message <message>", "Description for interactive map layer")
7474
.option("-p, --searchableProperties <searchableProperties>", "a comma separated list of properties to be indexed for faster queries")
7575
.option("--tags <tags>", "a comma separated list of tags")
7676
.option("--billingTags <billingTags>", "a comma separated list of billing tags")
7777
.option("--token <token>", "a external token to create layer in other user's account")
7878
.action(async function (catalogHrn, options) {
7979
if (!options.summary) {
80-
options.summary = "a new Interactive map layer created from commandline";
80+
options.summary = "a new interactive map layer created from commandline";
8181
}
8282
if (!options.message) {
83-
options.message = "a new Interactive map layer created from commandline";
83+
options.message = "a new interactive map layer created from commandline";
8484
}
8585
try {
8686
if(!catalogHrn){
@@ -123,10 +123,10 @@ program
123123

124124
program
125125
.command("config [catalogHrn] [layerId]")
126-
.description("configure/update an Interactive Map layer in a catalog")
127-
.option("-n, --layerName <layerName>", "Name for Interactive Map layer")
126+
.description("configure/update an interactive map layer in a catalog")
127+
.option("-n, --layerName <layerName>", "Name for interactive map layer")
128128
.option("-s, --summary <summary>", "Short summary")
129-
.option("-m, --message <message>", "Description for Interactive Map layer")
129+
.option("-m, --message <message>", "Description for interactive map layer")
130130
.option("-p, --searchableProperties <searchableProperties>", "a comma separated list of properties to be indexed for faster queries")
131131
.option("--tags <tags>", "a comma separated list of tags")
132132
.option("--billingTags <billingTags>", "a comma separated list of billing tags")
@@ -191,7 +191,7 @@ program
191191
program
192192
.command("list")
193193
.alias("ls")
194-
.description("information about available Interactive map layers")
194+
.description("information about available interactive map layers")
195195
.option("-r, --raw", "show raw layer definition")
196196
.option("--token <token>", "a external token to access another user's layers")
197197
.option("--filter <filter>", "a comma separted strings to filter layers")
@@ -232,13 +232,13 @@ program
232232
});
233233

234234
program
235-
.command("show <catalogHrn> <id>")
236-
.description("shows the content of the given [id]")
235+
.command("show <catalogHrn> <layerId>")
236+
.description("shows the content of the given id")
237237
.option("-l, --limit <limit>", "Number of objects to be fetched")
238238
.option("-o, --offset <offset>", "The offset / handle to continue the iteration")
239239
//.option("-t, --tags <tags>", "Tags to filter on")
240-
.option("-r, --raw", "show raw Interactive Map layer content")
241-
.option("--all", "iterate over entire Interactive Map layer to get entire data of layer, output will be shown on the console in GeoJSON format")
240+
.option("-r, --raw", "show raw interactive map layer content")
241+
.option("--all", "iterate over entire interactive map layer to get entire data of layer, output will be shown on the console in GeoJSON format")
242242
.option("--geojsonl", "to print output of --all in geojsonl format")
243243
.option("-c, --chunk [chunk]", "chunk size to use in --all option, default 5000")
244244
.option("--token <token>", "a external token to access another user's layer")
@@ -255,20 +255,20 @@ program
255255
.option("--center <center>", "comma separated, double-quoted lon,lat values specifying the center point of a --radius search")
256256
.option("--feature <feature>", "comma separated 'catalogHrn,layerId,featureid' values specifying a reference geometry in another layer for a spatial query")
257257
.option("--geometry <geometry>", "geometry file to be uploaded for a --spatial query (a single feature in geojson file)")
258-
.action(async function (catalogHrn, id, options) {
258+
.action(async function (catalogHrn, layerId, options) {
259259
try {
260260
xyzutil.validateShowOptions(options);
261-
await catalogUtil.validateCatalogAndLayer(catalogHrn, id);//validate catalogHrn and layerId
261+
await catalogUtil.validateCatalogAndLayer(catalogHrn, layerId);//validate catalogHrn and layerId
262262
xyzutil.setCatalogHrn(catalogHrn);
263-
await xyzutil.showSpace(id, options)
263+
await xyzutil.showSpace(layerId, options)
264264
} catch(error) {
265265
common.handleError(error);
266266
}
267267
});
268268

269269
program
270270
.command("delete <catalogHrn> <layerId>")
271-
.description("delete the Interactive map layer with the given id")
271+
.description("delete the interactive map layer with the given id")
272272
.option("--force", "skip the confirmation prompt")
273273
.option("--token <token>", "a external token to delete another user's layer")
274274
.action(async (catalogHrn, layerId, options) => {
@@ -286,9 +286,9 @@ program
286286

287287
program
288288
.command("clear <catalogHrn> <layerId>")
289-
.description("clear data from Interactive map layer")
289+
.description("clear data from interactive map layer")
290290
//.option("-t, --tags <tags>", "tags for the Data Hub space")
291-
.option("-i, --ids <ids>", "IDs for the Interactive map layer")
291+
.option("-i, --ids <ids>", "IDs for the interactive map layer")
292292
.option("--token <token>", "a external token to clear another user's layer data")
293293
.option("--force", "skip the confirmation prompt")
294294
.action(async (catalogHrn, layerId, options) => {

0 commit comments

Comments
 (0)