Skip to content

Commit 50660b3

Browse files
authored
chore: further cleanup of casing for commands, README (#244)
1 parent 5219269 commit 50660b3

File tree

13 files changed

+1663
-3004
lines changed

13 files changed

+1663
-3004
lines changed

README.md

Lines changed: 64 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ trusted TLS certificate.
9494

9595
`--asynclimit -a`
9696
(optional) Limit for the maximum number of operations performed concurrently.
97-
Currently this only affects file uploads in the `deploynodeapp` command. Defaults to 4.
97+
Currently this only affects file uploads in the `deployNodeApp` command. Defaults to 4.
9898

9999
`--json -j`
100100
(optional) Formats the command's response as a JSON object.
@@ -122,30 +122,30 @@ Currently this only affects file uploads in the `deploynodeapp` command. Default
122122
* [addEntryToKVM](#addEntryToKVM)
123123
* [assignUserRole](#assignUserRole)
124124
* [attachFlowHook](#attachFlowHook)
125-
* [createappkey](#createappkey)
126-
* [createapp](#createapp)
127-
* [createcache](#createcache)
128-
* [createdeveloper](#createdeveloper)
129-
* [createKVMmap](#createKVMmap)
125+
* [createAppKey](#createAppKey)
126+
* [createApp](#createApp)
127+
* [createCache](#createCache)
128+
* [createDeveloper](#createDeveloper)
129+
* [createKVM](#createKVM)
130130
* [createProduct](#createproduct)
131131
* [createRole](#createRole)
132132
* [createTargetServer](#createTargetServer)
133-
* [deleteapp](#deleteapp)
134-
* [deletecache](#deletecache)
135-
* [deletedeveloper](#deletedeveloper)
133+
* [deleteApp](#deleteApp)
134+
* [deleteCache](#deleteCache)
135+
* [deleteDeveloper](#deleteDeveloper)
136136
* [deleteKVMentry](#deleteKVMentry)
137137
* [deleteKVMmap](#deleteKVMmap)
138-
* [deleteproduct](#deleteproduct)
138+
* [deleteProduct](#deleteProduct)
139139
* [deleteRole](#deleteRole)
140140
* [deleteSharedflow](#deleteSharedflow)
141141
* [deleteTargetServer](#deleteTargetServer)
142142
* [delete](#delete)
143-
* [deployhostedtarget](#deployhostedtarget)
144-
* [deploynodeapp](#deploynodeapp)
145-
* [deployproxy](#deployproxy)
143+
* [deployHostedTarget](#deployHostedTarget)
144+
* [deployNodeApp](#deployNodeApp)
145+
* [deployProxy](#deployProxy)
146146
* [deploySharedflow](#deploySharedflow)
147-
* [detachFlowHook](#detachFlowHook)
148-
* [fetchproxy](#fetchproxy)
147+
* [detachFlowHook](#detachFlowHook)
148+
* [fetchProxy](#fetchProxy)
149149
* [fetchSharedflow](#fetchSharedflow)
150150
* [getFlowHook](#getFlowHook)
151151
* [getKVMentry](#getKVMentry)
@@ -169,19 +169,19 @@ Currently this only affects file uploads in the `deploynodeapp` command. Default
169169
* [updateTargetServer](#updateTargetServer)
170170
* [verifyUserRole](#verifyUserRole)
171171

172-
## <a name="deploynodeapp"></a>deploynodeapp
172+
## <a name="deployNodeApp"></a>deployNodeApp
173173

174174
Deploys a Node.js app to Apigee Edge as an API proxy. With your Node.js app deployed to Edge, you can take advantage of Edge features like security, quotas, caching, analytics, trace tool, and more.
175175

176176
#### Examples
177177

178178
Deploys a Node.js app to Apigee Edge.
179179

180-
apigeetool deploynodeapp -u sdoe@apigee.com -o sdoe -e test -n 'Test Node App 2' -d . -m app.js -b /node2
180+
apigeetool deployNodeApp -u sdoe@apigee.com -o sdoe -e test -n 'Test Node App 2' -d . -m app.js -b /node2
181181

182182
Deploys a Node.js app to both the default (HTTP) and secure (HTTPS) virtual hosts.
183183

184-
apigeetool deploynodeapp -u sdoe@apigee.com -o sdoe -e test -n 'Test Node App 2' -d . -m app.js -b /node2 -v default,secure
184+
apigeetool deployNodeApp -u sdoe@apigee.com -o sdoe -e test -n 'Test Node App 2' -d . -m app.js -b /node2 -v default,secure
185185

186186
#### Required parameters
187187

@@ -229,7 +229,7 @@ for organization name, all of which are required.
229229
(optional) If specified, uploads Node.js modules from your system to Apigee Edge rather than resolving the modules directly on Apigee Edge (the default behavior).
230230

231231
`--virtualhosts -v`
232-
(optional) A comma-separated list of virtual hosts that the deployed app will use. The two most common options are `default` and `secure`. The `default` option is always HTTP and `secure` is always HTTPS. By default, `apigeetool deploynodeapp` uses `default,secure`.
232+
(optional) A comma-separated list of virtual hosts that the deployed app will use. The two most common options are `default` and `secure`. The `default` option is always HTTP and `secure` is always HTTPS. By default, `apigeetool deployNodeApp` uses `default,secure`.
233233

234234
`--bundled-dependencies`
235235
(optional) If specified, the source code will be uploaded with its `bundledDependencies` as defined in the `package.json`.
@@ -290,15 +290,15 @@ The name of the API proxy. The name of the API proxy must be unique within an or
290290
`--bundled-dependencies`
291291
(optional) If specified, the source code will be uploaded with its `bundledDependencies` as defined in the `package.json`.
292292

293-
## <a name="deployproxy"></a>deployproxy
293+
## <a name="deployProxy"></a>deployProxy
294294

295295
Deploys an API proxy to Apigee Edge. If the proxy is currently deployed, it will be undeployed first, and the newly deployed proxy's revision number is incremented.
296296

297297
#### Example
298298

299299
Deploys an API proxy called example-proxy to Apigee Edge. Per the `-d` flag, the command is executed in the root directory of the proxy bundle.
300300

301-
apigeetool deployproxy -u sdoe@example.com -o sdoe -e test -n example-proxy -d .
301+
apigeetool deployProxy -u sdoe@example.com -o sdoe -e test -n example-proxy -d .
302302

303303
#### Required parameters
304304

@@ -442,16 +442,16 @@ Fetches a deployed API proxy or Node.js application from Apigee Edge. The
442442
result will be a ZIP file that contains the contents of the entire
443443
proxy.
444444

445-
Regardless of whether "deployproxy" or "deploynodeapp" is used to deploy the
446-
proxy or app, the result of "fetchproxy" will always be a ZIP file that
445+
Regardless of whether "deployProxy" or "deployNodeApp" is used to deploy the
446+
proxy or app, the result of "fetchProxy" will always be a ZIP file that
447447
represents an API proxy. The resulting proxy may be "unzipped" and
448-
re-deployed using "deployproxy."
448+
re-deployed using "deployProxy."
449449

450450
#### Example
451451

452452
Fetch the deployed proxy named "example-proxy".
453453

454-
apigeetool fetchproxy -u sdoe@example.com -o sdoe -n example-proxy -r 1
454+
apigeetool fetchProxy -u sdoe@example.com -o sdoe -n example-proxy -r 1
455455

456456
#### Required parameters
457457

@@ -988,18 +988,18 @@ for organization name, all of which are required.
988988

989989
## <a name="Cache Operations"></a>Cache Operations
990990

991-
### <a name="createcache"></a>createcache
991+
### <a name="createCache"></a>createCache
992992

993993
Creates a Cache with the given name.
994994

995995
#### Example
996996
Create Cache map named "test-cache"
997997

998-
apigeetool createcache -u sdoe@example.com -o sdoe -e test -z test-cache
998+
apigeetool createCache -u sdoe@example.com -o sdoe -e test -z test-cache
999999

10001000
Create Cache map named "test-cache" (with description and expiry)
10011001

1002-
apigeetool createcache -u sdoe@example.com -o sdoe -e test -z test-cache --description "sample key" --cacheExpiryInSecs 40000
1002+
apigeetool createCache -u sdoe@example.com -o sdoe -e test -z test-cache --description "sample key" --cacheExpiryInSecs 40000
10031003

10041004
#### Required parameters
10051005

@@ -1481,16 +1481,14 @@ You could use apigeetool as an SDK to orchestrate tasks that you want to perform
14811481
//deploy failed
14821482
});
14831483

1484-
## <a name="createdeveloper"></a>Create Developer
1484+
## <a name="createDeveloper"></a>Create Developer
14851485

14861486
Creates a new Developer in Edge
14871487

1488-
#### Example
1489-
1490-
Create a developer.
1488+
#### Code Example
14911489

1492-
//see above for other required options
1493-
opts.email = DEVELOPER_EMAIL
1490+
//see above for other required options
1491+
opts.email = DEVELOPER_EMAIL
14941492
opts.firstName = 'Test'
14951493
opts.lastName = 'Test1'
14961494
opts.userName = 'runningFromTest123'
@@ -1509,14 +1507,14 @@ Create a developer.
15091507
}) ;
15101508

15111509

1512-
## <a name="deletedeveloper"></a>Delete Developer
1510+
## <a name="deleteDeveloper"></a>Delete Developer
15131511

15141512
Delete a Developer in Edge
15151513

1516-
#### Example
1514+
#### Code Example
15171515

1518-
//see above for other required options
1519-
opts.email = DEVELOPER_EMAIL
1516+
//see above for other required options
1517+
opts.email = DEVELOPER_EMAIL
15201518

15211519
sdk.deleteDeveloper(opts)
15221520
.then(function(result){
@@ -1529,7 +1527,7 @@ Delete a Developer in Edge
15291527

15301528
Creates a new API Product in Edge
15311529

1532-
#### Example
1530+
#### Code Example
15331531

15341532
opts.productName = APIGEE_PRODUCT_NAME
15351533
opts.productDesc = 'description'
@@ -1546,11 +1544,11 @@ Creates a new API Product in Edge
15461544
//product creation failed
15471545
}) ;
15481546

1549-
## <a name="deleteproduct"></a>Delete Product
1547+
## <a name="deleteProduct"></a>Delete Product
15501548

15511549
Delete API Product in Edge
15521550

1553-
#### Example
1551+
#### Code Example
15541552
opts.productName = APIGEE_PRODUCT_NAME
15551553

15561554
sdk.deleteProduct(opts)
@@ -1560,11 +1558,11 @@ Delete API Product in Edge
15601558
//delete failed
15611559
}) ;
15621560

1563-
## <a name="createapp"></a>Create App
1561+
## <a name="createApp"></a>Create App
15641562

15651563
Create App in Edge
15661564

1567-
#### Example
1565+
#### Code Example
15681566

15691567
opts.name = APP_NAME
15701568
opts.apiproducts = APIGEE_PRODUCT_NAME
@@ -1577,11 +1575,11 @@ Create App in Edge
15771575
//create app failed
15781576
}) ;
15791577

1580-
## <a name="deleteapp"></a>Delete App
1578+
## <a name="deleteApp"></a>Delete App
15811579

15821580
Delete App in Edge
15831581

1584-
#### Example
1582+
#### Code Example
15851583

15861584
opts.email = DEVELOPER_EMAIL
15871585
opts.name = APP_NAME
@@ -1593,11 +1591,11 @@ Delete App in Edge
15931591
//delete app failed
15941592
}) ;
15951593

1596-
## <a name="createappkey"></a>Create App Key
1594+
## <a name="createAppKey"></a>Create App Key
15971595

15981596
Create App Key in Edge
15991597

1600-
#### Example
1598+
#### Code Example
16011599

16021600
opts.key = APP_KEY;
16031601
opts.secret = APP_SECRET;
@@ -1606,36 +1604,38 @@ Create App Key in Edge
16061604
opts.apiProducts = PRODUCT_NAME;
16071605

16081606
sdk.createAppKey(opts)
1609-
.then(function(result){
1610-
//create key/secret success
1611-
},function(err){
1612-
//create key/secret failed
1613-
}) ;
1607+
.then(function(result){
1608+
//create key/secret success
1609+
},function(err){
1610+
//create key/secret failed
1611+
}) ;
16141612

1615-
## <a name="createcache"></a>Create Cache
1613+
## <a name="createCache"></a>Create Cache
16161614

16171615
Create Cache in Edge
16181616

1619-
#### Example
1617+
#### Code Example
1618+
16201619
opts.cache = CACHE_RESOURCE_NAME;
1621-
sdk.createcache(opts)
1622-
.then(function(result){
1623-
//cache create success
1620+
sdk.createCache(opts)
1621+
.then(function(result){
1622+
//create cache success
16241623
},function(err){
1625-
//cache create failed
1624+
//create cache failed
16261625
}) ;
16271626

1628-
## <a name="deletecache"></a>Delete Cache
1627+
## <a name="deleteCache"></a>Delete Cache
16291628

16301629
Delete Cache in Edge
16311630

1632-
#### Example
1631+
#### Code Example
1632+
16331633
opts.cache = CACHE_RESOURCE_NAME;
1634-
sdk.deletecache(opts)
1635-
.then(function(result){
1636-
//delete create success
1634+
sdk.deleteCache(opts)
1635+
.then(function(result){
1636+
//delete cache success
16371637
},function(err){
1638-
//delete create failed
1638+
//delete failed
16391639
}) ;
16401640

16411641
# <a name="history"></a>Some History

lib/commands/createKVMmap.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,5 @@ module.exports.run = function (opts, cb) {
7272
json: true
7373
};
7474

75-
command_utils.run("createKeyValueMap", opts, requestOpts, cb);
75+
command_utils.run("createKVMmap", opts, requestOpts, cb);
7676
};

lib/commands/deleteKVMmap.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ module.exports.descriptor = descriptor;
2929
module.exports.run = function (opts, cb) {
3030
options.validateSync(opts, descriptor);
3131
if (opts.debug) {
32-
console.log("deleteKeyVaueMap: %j", opts);
32+
console.log("deleteKVMmap: %j", opts);
3333
}
3434

3535
let uri = util.format(
@@ -63,5 +63,5 @@ module.exports.run = function (opts, cb) {
6363
uri,
6464
method: "DELETE"
6565
};
66-
command_utils.run("deleteKeyValueMap", opts, requestOpts, cb);
66+
command_utils.run("deleteKVMmap", opts, requestOpts, cb);
6767
};

lib/commands/getKVMmap.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ module.exports.run = function (opts, cb) {
6060
uri,
6161
method: "GET"
6262
};
63-
command_utils.run("getkvmmap", opts, requestOpts, cb);
63+
command_utils.run("getKVMmap", opts, requestOpts, cb);
6464
};

0 commit comments

Comments
 (0)