@itentialopensource/adapter-redis_cloud 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. package/CALLS.md +68 -68
  2. package/CHANGELOG.md +8 -1
  3. package/README.md +10 -6
  4. package/adapterBase.js +103 -0
  5. package/changelogs/changelog.md +9 -0
  6. package/metadata.json +53 -49
  7. package/package.json +8 -8
  8. package/pronghorn.json +1 -1
  9. package/propertiesSchema.json +74 -1
  10. package/refs?service=git-upload-pack +0 -0
  11. package/report/adapter-openapi.json +8093 -0
  12. package/report/adapter-openapi.yaml +8639 -0
  13. package/report/adapterInfo.json +5 -5
  14. package/report/updateReport1698422107795.json +120 -0
  15. package/sampleProperties.json +46 -34
  16. package/test/unit/adapterBaseTestUnit.js +6 -6
  17. package/test/unit/adapterTestUnit.js +11 -5
  18. package/utils/methodDocumentor.js +71 -23
package/CALLS.md CHANGED
@@ -168,271 +168,271 @@ Specific adapter calls are built based on the API of the Redis_cloud. The Adapte
168
168
  </tr>
169
169
  <tr>
170
170
  <td style="padding:15px">getUserById(userId, callback)</td>
171
- <td style="padding:15px">Information on user identified by user Id</td>
171
+ <td style="padding:15px">Get user by id</td>
172
172
  <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td>
173
173
  <td style="padding:15px">Yes</td>
174
174
  </tr>
175
175
  <tr>
176
176
  <td style="padding:15px">updateUser(userId, body, callback)</td>
177
- <td style="padding:15px">Update an existing user by Id</td>
177
+ <td style="padding:15px">Update user</td>
178
178
  <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td>
179
179
  <td style="padding:15px">Yes</td>
180
180
  </tr>
181
181
  <tr>
182
182
  <td style="padding:15px">deleteUserById(userId, callback)</td>
183
- <td style="padding:15px">Delete a user from current account</td>
183
+ <td style="padding:15px">Delete user</td>
184
184
  <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td>
185
185
  <td style="padding:15px">Yes</td>
186
186
  </tr>
187
187
  <tr>
188
188
  <td style="padding:15px">getAllUsers(callback)</td>
189
- <td style="padding:15px">Information on current account's users</td>
189
+ <td style="padding:15px">Get users</td>
190
190
  <td style="padding:15px">{base_path}/{version}/users?{query}</td>
191
191
  <td style="padding:15px">Yes</td>
192
192
  </tr>
193
193
  <tr>
194
194
  <td style="padding:15px">getSubscriptionById(subscriptionId, callback)</td>
195
- <td style="padding:15px">Information on subscription identified by subscription Id</td>
195
+ <td style="padding:15px">Get subscription by id</td>
196
196
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}?{query}</td>
197
197
  <td style="padding:15px">Yes</td>
198
198
  </tr>
199
199
  <tr>
200
200
  <td style="padding:15px">updateSubscription(subscriptionId, body, callback)</td>
201
- <td style="padding:15px">Update an existing subscription by Id</td>
201
+ <td style="padding:15px">Update subscription</td>
202
202
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}?{query}</td>
203
203
  <td style="padding:15px">Yes</td>
204
204
  </tr>
205
205
  <tr>
206
206
  <td style="padding:15px">deleteSubscriptionById(subscriptionId, callback)</td>
207
- <td style="padding:15px">Delete a subscription identified by subscription Id (subscription must be empty, i.e. cannot contain databases)</td>
207
+ <td style="padding:15px">Delete subscription</td>
208
208
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}?{query}</td>
209
209
  <td style="padding:15px">Yes</td>
210
210
  </tr>
211
211
  <tr>
212
212
  <td style="padding:15px">updateActiveActiveVpcPeering(subscriptionId, peeringId, body, callback)</td>
213
- <td style="padding:15px">Update an existing VPC peering in an existing active-active subscription.</td>
213
+ <td style="padding:15px">Update an active-active subscription VPC peering</td>
214
214
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions/peerings/{pathv2}?{query}</td>
215
215
  <td style="padding:15px">Yes</td>
216
216
  </tr>
217
217
  <tr>
218
218
  <td style="padding:15px">deleteActiveActiveVpcPeering(subscriptionId, peeringId, callback)</td>
219
- <td style="padding:15px">Delete a VPC peering from an existing active-active subscription.</td>
219
+ <td style="padding:15px">Delete an active-active subscription VPC peering</td>
220
220
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions/peerings/{pathv2}?{query}</td>
221
221
  <td style="padding:15px">Yes</td>
222
222
  </tr>
223
223
  <tr>
224
224
  <td style="padding:15px">updateVpcPeering(subscriptionId, peeringId, body, callback)</td>
225
- <td style="padding:15px">Update an existing VPC peering in an existing subscription.</td>
225
+ <td style="padding:15px">Update subscription peering</td>
226
226
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/peerings/{pathv2}?{query}</td>
227
227
  <td style="padding:15px">Yes</td>
228
228
  </tr>
229
229
  <tr>
230
230
  <td style="padding:15px">deleteVpcPeering(subscriptionId, peeringId, callback)</td>
231
- <td style="padding:15px">Deletes a VPC peering identified by an id</td>
231
+ <td style="padding:15px">Delete subscription peering</td>
232
232
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/peerings/{pathv2}?{query}</td>
233
233
  <td style="padding:15px">Yes</td>
234
234
  </tr>
235
235
  <tr>
236
236
  <td style="padding:15px">getCidrWhiteList(subscriptionId, callback)</td>
237
- <td style="padding:15px">Get CIDR whitelist</td>
237
+ <td style="padding:15px">Get subscription CIDR</td>
238
238
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/cidr?{query}</td>
239
239
  <td style="padding:15px">Yes</td>
240
240
  </tr>
241
241
  <tr>
242
242
  <td style="padding:15px">updateSubscriptionCidrWhiteList(subscriptionId, body, callback)</td>
243
- <td style="padding:15px">Update subscription CIDR whitelist</td>
243
+ <td style="padding:15px">Update subscription CIDR</td>
244
244
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/cidr?{query}</td>
245
245
  <td style="padding:15px">Yes</td>
246
246
  </tr>
247
247
  <tr>
248
248
  <td style="padding:15px">getAllSubscriptions(callback)</td>
249
- <td style="padding:15px">Information on current account's subscriptions</td>
249
+ <td style="padding:15px">Get subscriptions</td>
250
250
  <td style="padding:15px">{base_path}/{version}/subscriptions?{query}</td>
251
251
  <td style="padding:15px">Yes</td>
252
252
  </tr>
253
253
  <tr>
254
254
  <td style="padding:15px">createSubscription(body, callback)</td>
255
- <td style="padding:15px">Create a new subscription</td>
255
+ <td style="padding:15px">Create subscription</td>
256
256
  <td style="padding:15px">{base_path}/{version}/subscriptions?{query}</td>
257
257
  <td style="padding:15px">Yes</td>
258
258
  </tr>
259
259
  <tr>
260
260
  <td style="padding:15px">getRegionsFromActiveActiveSubscription(subscriptionId, callback)</td>
261
- <td style="padding:15px">Get all regions of an active-active subscription</td>
261
+ <td style="padding:15px">Get active-active subscription regions</td>
262
262
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions?{query}</td>
263
263
  <td style="padding:15px">Yes</td>
264
264
  </tr>
265
265
  <tr>
266
266
  <td style="padding:15px">addNewRegionToActiveActiveSubscription(subscriptionId, body, callback)</td>
267
- <td style="padding:15px">Create a new region in an active-active subscription</td>
267
+ <td style="padding:15px">Create active-active subscription region</td>
268
268
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions?{query}</td>
269
269
  <td style="padding:15px">Yes</td>
270
270
  </tr>
271
271
  <tr>
272
272
  <td style="padding:15px">deleteRegionsFromActiveActiveSubscription(subscriptionId, body, callback)</td>
273
- <td style="padding:15px">Delete one or more regions from an active-active subscription</td>
273
+ <td style="padding:15px">Delete active-active subscription regions</td>
274
274
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions?{query}</td>
275
275
  <td style="padding:15px">Yes</td>
276
276
  </tr>
277
277
  <tr>
278
278
  <td style="padding:15px">getActiveActiveVpcPeerings(subscriptionId, callback)</td>
279
- <td style="padding:15px">Get VPC peering details for an active-active subscription.</td>
279
+ <td style="padding:15px">Get an active-active subscription VPC peering</td>
280
280
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions/peerings?{query}</td>
281
281
  <td style="padding:15px">Yes</td>
282
282
  </tr>
283
283
  <tr>
284
284
  <td style="padding:15px">createActiveActiveVpcPeering(subscriptionId, body, callback)</td>
285
- <td style="padding:15px">Create a new VPC peering in an existing active-active subscription.</td>
285
+ <td style="padding:15px">Create an active-active subscription VPC peering</td>
286
286
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions/peerings?{query}</td>
287
287
  <td style="padding:15px">Yes</td>
288
288
  </tr>
289
289
  <tr>
290
290
  <td style="padding:15px">getVpcPeering(subscriptionId, callback)</td>
291
- <td style="padding:15px">Get VPC peering details. VPC peering for Google Cloud Provider must be enabled using the GCloud command line. For details, see documentation.</td>
291
+ <td style="padding:15px">Get Subscription peering</td>
292
292
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/peerings?{query}</td>
293
293
  <td style="padding:15px">Yes</td>
294
294
  </tr>
295
295
  <tr>
296
296
  <td style="padding:15px">createVpcPeering(subscriptionId, body, callback)</td>
297
- <td style="padding:15px">Create a new VPC peering in an existing subscription. VPC peering for Google Cloud Provider must be enabled using the GCloud command line. For details, see documentation.</td>
297
+ <td style="padding:15px">Create subscription peering</td>
298
298
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/peerings?{query}</td>
299
299
  <td style="padding:15px">Yes</td>
300
300
  </tr>
301
301
  <tr>
302
302
  <td style="padding:15px">getSubscriptionDatabaseByID(subscriptionId, databaseId, callback)</td>
303
- <td style="padding:15px">Information on a specific database identified by subscription Id and database Id</td>
303
+ <td style="padding:15px">Get database by id</td>
304
304
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases/{pathv2}?{query}</td>
305
305
  <td style="padding:15px">Yes</td>
306
306
  </tr>
307
307
  <tr>
308
308
  <td style="padding:15px">updateDatabase(subscriptionId, databaseId, body, callback)</td>
309
- <td style="padding:15px">Update an existing database</td>
309
+ <td style="padding:15px">Update database</td>
310
310
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases/{pathv2}?{query}</td>
311
311
  <td style="padding:15px">Yes</td>
312
312
  </tr>
313
313
  <tr>
314
314
  <td style="padding:15px">deleteDatabaseById(subscriptionId, databaseId, callback)</td>
315
- <td style="padding:15px">Delete a specific database identified by subscription Id and database Id</td>
315
+ <td style="padding:15px">Delete database</td>
316
316
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases/{pathv2}?{query}</td>
317
317
  <td style="padding:15px">Yes</td>
318
318
  </tr>
319
319
  <tr>
320
320
  <td style="padding:15px">updateCrdbLocalProperties(subscriptionId, databaseId, body, callback)</td>
321
- <td style="padding:15px">Update active-active local database properties</td>
321
+ <td style="padding:15px">Update active-active regions</td>
322
322
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases/{pathv2}/regions?{query}</td>
323
323
  <td style="padding:15px">Yes</td>
324
324
  </tr>
325
325
  <tr>
326
326
  <td style="padding:15px">getSubscriptionDatabases(subscriptionId, offset, limit, callback)</td>
327
- <td style="padding:15px">Information on databases belonging to subscription identified by subscription Id</td>
327
+ <td style="padding:15px">Get databases</td>
328
328
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases?{query}</td>
329
329
  <td style="padding:15px">Yes</td>
330
330
  </tr>
331
331
  <tr>
332
332
  <td style="padding:15px">createDatabase(subscriptionId, body, callback)</td>
333
- <td style="padding:15px">Create a new database</td>
333
+ <td style="padding:15px">Create database</td>
334
334
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases?{query}</td>
335
335
  <td style="padding:15px">Yes</td>
336
336
  </tr>
337
337
  <tr>
338
338
  <td style="padding:15px">importDatabase(subscriptionId, databaseId, body, callback)</td>
339
- <td style="padding:15px">Import data from an RDB file or a different Redis database</td>
339
+ <td style="padding:15px">Import database</td>
340
340
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases/{pathv2}/import?{query}</td>
341
341
  <td style="padding:15px">Yes</td>
342
342
  </tr>
343
343
  <tr>
344
344
  <td style="padding:15px">backupDatabase(subscriptionId, databaseId, body, callback)</td>
345
- <td style="padding:15px">Manually backup a database into the destination defined for it</td>
345
+ <td style="padding:15px">Backup database</td>
346
346
  <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases/{pathv2}/backup?{query}</td>
347
347
  <td style="padding:15px">Yes</td>
348
348
  </tr>
349
349
  <tr>
350
350
  <td style="padding:15px">getSubscriptionById1(subscriptionId, callback)</td>
351
- <td style="padding:15px">Information on fixed subscription identified by subscription Id</td>
351
+ <td style="padding:15px">Get fixed subscription by id</td>
352
352
  <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}?{query}</td>
353
353
  <td style="padding:15px">Yes</td>
354
354
  </tr>
355
355
  <tr>
356
356
  <td style="padding:15px">updateSubscription1(subscriptionId, body, callback)</td>
357
- <td style="padding:15px">Update a fixed subscription</td>
357
+ <td style="padding:15px">Update fixed subscription</td>
358
358
  <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}?{query}</td>
359
359
  <td style="padding:15px">Yes</td>
360
360
  </tr>
361
361
  <tr>
362
362
  <td style="padding:15px">deleteSubscriptionById1(subscriptionId, callback)</td>
363
- <td style="padding:15px">Delete a fixed subscription identified by subscription Id (subscription must be empty, i.e. cannot contain databases)</td>
363
+ <td style="padding:15px">Delete fixed subscription</td>
364
364
  <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}?{query}</td>
365
365
  <td style="padding:15px">Yes</td>
366
366
  </tr>
367
367
  <tr>
368
368
  <td style="padding:15px">getAllSubscriptions1(callback)</td>
369
- <td style="padding:15px">Information on current account's fixed subscriptions</td>
369
+ <td style="padding:15px">Get fixed subscriptions</td>
370
370
  <td style="padding:15px">{base_path}/{version}/fixed/subscriptions?{query}</td>
371
371
  <td style="padding:15px">Yes</td>
372
372
  </tr>
373
373
  <tr>
374
374
  <td style="padding:15px">createSubscription1(body, callback)</td>
375
- <td style="padding:15px">Create a new fixed subscription</td>
375
+ <td style="padding:15px">Create fixed subscription</td>
376
376
  <td style="padding:15px">{base_path}/{version}/fixed/subscriptions?{query}</td>
377
377
  <td style="padding:15px">Yes</td>
378
378
  </tr>
379
379
  <tr>
380
380
  <td style="padding:15px">getAllFixedSubscriptionsPlans(provider, callback)</td>
381
- <td style="padding:15px">Lookup list of plans</td>
381
+ <td style="padding:15px">Get Plans</td>
382
382
  <td style="padding:15px">{base_path}/{version}/fixed/plans?{query}</td>
383
383
  <td style="padding:15px">Yes</td>
384
384
  </tr>
385
385
  <tr>
386
386
  <td style="padding:15px">getFixedSubscriptionsPlanById(planId, callback)</td>
387
- <td style="padding:15px">Information on a specific fixed subscription plan identified by plan Id</td>
387
+ <td style="padding:15px">Get fixed subscription plan by id</td>
388
388
  <td style="padding:15px">{base_path}/{version}/fixed/plans/{pathv1}?{query}</td>
389
389
  <td style="padding:15px">Yes</td>
390
390
  </tr>
391
391
  <tr>
392
392
  <td style="padding:15px">getSubscriptionDatabaseByID1(subscriptionId, databaseId, callback)</td>
393
- <td style="padding:15px">Information on a specific database identified by fixed subscription Id and database Id</td>
393
+ <td style="padding:15px">Get fixed database by id</td>
394
394
  <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases/{pathv2}?{query}</td>
395
395
  <td style="padding:15px">Yes</td>
396
396
  </tr>
397
397
  <tr>
398
398
  <td style="padding:15px">deleteFixedDatabaseByID(subscriptionId, databaseId, body, callback)</td>
399
- <td style="padding:15px">Update a specific database identified by a fixed subscription Id and database Id</td>
399
+ <td style="padding:15px">Update fixed database</td>
400
400
  <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases/{pathv2}?{query}</td>
401
401
  <td style="padding:15px">Yes</td>
402
402
  </tr>
403
403
  <tr>
404
404
  <td style="padding:15px">deleteFixedDatabaseByID1(subscriptionId, databaseId, callback)</td>
405
- <td style="padding:15px">Delete a specific database identified by a fixed subscription Id and database Id</td>
405
+ <td style="padding:15px">Delete fixed database</td>
406
406
  <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases/{pathv2}?{query}</td>
407
407
  <td style="padding:15px">Yes</td>
408
408
  </tr>
409
409
  <tr>
410
410
  <td style="padding:15px">getFixedSubscriptionDatabases(subscriptionId, offset, limit, callback)</td>
411
- <td style="padding:15px">Information on databases belonging to a fixed subscription identified by subscription Id</td>
411
+ <td style="padding:15px">Get fixed databases</td>
412
412
  <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases?{query}</td>
413
413
  <td style="padding:15px">Yes</td>
414
414
  </tr>
415
415
  <tr>
416
416
  <td style="padding:15px">createFixedDatabase(subscriptionId, body, callback)</td>
417
- <td style="padding:15px">Create a new fixed database</td>
417
+ <td style="padding:15px">Create fixed database</td>
418
418
  <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases?{query}</td>
419
419
  <td style="padding:15px">Yes</td>
420
420
  </tr>
421
421
  <tr>
422
422
  <td style="padding:15px">importDatabase1(subscriptionId, databaseId, body, callback)</td>
423
- <td style="padding:15px">Import data from an RDB file or a different Redis database</td>
423
+ <td style="padding:15px">Import fixed database</td>
424
424
  <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases/{pathv2}/import?{query}</td>
425
425
  <td style="padding:15px">Yes</td>
426
426
  </tr>
427
427
  <tr>
428
428
  <td style="padding:15px">backupDatabase1(subscriptionId, databaseId, callback)</td>
429
- <td style="padding:15px">Manually backup a fixed database into the destination defined for it</td>
429
+ <td style="padding:15px">Backup fixed database</td>
430
430
  <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases/{pathv2}/backup?{query}</td>
431
431
  <td style="padding:15px">Yes</td>
432
432
  </tr>
433
433
  <tr>
434
434
  <td style="padding:15px">getCloudAccountById(cloudAccountId, callback)</td>
435
- <td style="padding:15px">Information on a specific cloud account</td>
435
+ <td style="padding:15px">Get cloud account by id</td>
436
436
  <td style="padding:15px">{base_path}/{version}/cloud-accounts/{pathv1}?{query}</td>
437
437
  <td style="padding:15px">Yes</td>
438
438
  </tr>
@@ -444,13 +444,13 @@ Specific adapter calls are built based on the API of the Redis_cloud. The Adapte
444
444
  </tr>
445
445
  <tr>
446
446
  <td style="padding:15px">deleteCloudAccount(cloudAccountId, callback)</td>
447
- <td style="padding:15px">Delete specified cloud account</td>
447
+ <td style="padding:15px">Delete cloud account</td>
448
448
  <td style="padding:15px">{base_path}/{version}/cloud-accounts/{pathv1}?{query}</td>
449
449
  <td style="padding:15px">Yes</td>
450
450
  </tr>
451
451
  <tr>
452
452
  <td style="padding:15px">getCloudAccounts(callback)</td>
453
- <td style="padding:15px">List all configured cloud accounts</td>
453
+ <td style="padding:15px">Get cloud accounts</td>
454
454
  <td style="padding:15px">{base_path}/{version}/cloud-accounts?{query}</td>
455
455
  <td style="padding:15px">Yes</td>
456
456
  </tr>
@@ -462,127 +462,127 @@ Specific adapter calls are built based on the API of the Redis_cloud. The Adapte
462
462
  </tr>
463
463
  <tr>
464
464
  <td style="padding:15px">getUserByID(aclUserId, callback)</td>
465
- <td style="padding:15px">Information on an ACL user identified by ACL user Id</td>
465
+ <td style="padding:15px">Get ACL user by id</td>
466
466
  <td style="padding:15px">{base_path}/{version}/acl/users/{pathv1}?{query}</td>
467
467
  <td style="padding:15px">Yes</td>
468
468
  </tr>
469
469
  <tr>
470
470
  <td style="padding:15px">updateUser1(aclUserId, body, callback)</td>
471
- <td style="padding:15px">Update a new ACL user</td>
471
+ <td style="padding:15px">Update ACL user</td>
472
472
  <td style="padding:15px">{base_path}/{version}/acl/users/{pathv1}?{query}</td>
473
473
  <td style="padding:15px">Yes</td>
474
474
  </tr>
475
475
  <tr>
476
476
  <td style="padding:15px">deleteUser(aclUserId, callback)</td>
477
- <td style="padding:15px">Delete an ACL user</td>
477
+ <td style="padding:15px">Delete ACL user</td>
478
478
  <td style="padding:15px">{base_path}/{version}/acl/users/{pathv1}?{query}</td>
479
479
  <td style="padding:15px">Yes</td>
480
480
  </tr>
481
481
  <tr>
482
482
  <td style="padding:15px">updateRole(aclRoleId, body, callback)</td>
483
- <td style="padding:15px">Update an ACL role</td>
483
+ <td style="padding:15px">Update ACL role</td>
484
484
  <td style="padding:15px">{base_path}/{version}/acl/roles/{pathv1}?{query}</td>
485
485
  <td style="padding:15px">Yes</td>
486
486
  </tr>
487
487
  <tr>
488
488
  <td style="padding:15px">deleteAclRole(aclRoleId, callback)</td>
489
- <td style="padding:15px">Delete an ACL role</td>
489
+ <td style="padding:15px">Delete ACL role</td>
490
490
  <td style="padding:15px">{base_path}/{version}/acl/roles/{pathv1}?{query}</td>
491
491
  <td style="padding:15px">Yes</td>
492
492
  </tr>
493
493
  <tr>
494
494
  <td style="padding:15px">updateRedisRule(aclRedisRuleId, body, callback)</td>
495
- <td style="padding:15px">Update an ACL redis rule</td>
495
+ <td style="padding:15px">Update ACL redis rule</td>
496
496
  <td style="padding:15px">{base_path}/{version}/acl/redisRules/{pathv1}?{query}</td>
497
497
  <td style="padding:15px">Yes</td>
498
498
  </tr>
499
499
  <tr>
500
500
  <td style="padding:15px">deleteRedisRule(aclRedisRuleId, callback)</td>
501
- <td style="padding:15px">Delete an ACL redis rule</td>
501
+ <td style="padding:15px">Delete ACL redis rule</td>
502
502
  <td style="padding:15px">{base_path}/{version}/acl/redisRules/{pathv1}?{query}</td>
503
503
  <td style="padding:15px">Yes</td>
504
504
  </tr>
505
505
  <tr>
506
506
  <td style="padding:15px">getAllUsers1(callback)</td>
507
- <td style="padding:15px">Information on current account's ACL users</td>
507
+ <td style="padding:15px">Get ACL users</td>
508
508
  <td style="padding:15px">{base_path}/{version}/acl/users?{query}</td>
509
509
  <td style="padding:15px">Yes</td>
510
510
  </tr>
511
511
  <tr>
512
512
  <td style="padding:15px">createUser(body, callback)</td>
513
- <td style="padding:15px">Create a new ACL user</td>
513
+ <td style="padding:15px">Create ACL user</td>
514
514
  <td style="padding:15px">{base_path}/{version}/acl/users?{query}</td>
515
515
  <td style="padding:15px">Yes</td>
516
516
  </tr>
517
517
  <tr>
518
518
  <td style="padding:15px">getRoles(callback)</td>
519
- <td style="padding:15px">Information on current account's ACL roles</td>
519
+ <td style="padding:15px">Get ACL roles</td>
520
520
  <td style="padding:15px">{base_path}/{version}/acl/roles?{query}</td>
521
521
  <td style="padding:15px">Yes</td>
522
522
  </tr>
523
523
  <tr>
524
524
  <td style="padding:15px">createRole(body, callback)</td>
525
- <td style="padding:15px">Create a new ACL role</td>
525
+ <td style="padding:15px">Create ACL role</td>
526
526
  <td style="padding:15px">{base_path}/{version}/acl/roles?{query}</td>
527
527
  <td style="padding:15px">Yes</td>
528
528
  </tr>
529
529
  <tr>
530
530
  <td style="padding:15px">getAllRedisRules(callback)</td>
531
- <td style="padding:15px">Information on current account's ACL users</td>
531
+ <td style="padding:15px">Get ACL redis rules</td>
532
532
  <td style="padding:15px">{base_path}/{version}/acl/redisRules?{query}</td>
533
533
  <td style="padding:15px">Yes</td>
534
534
  </tr>
535
535
  <tr>
536
536
  <td style="padding:15px">createRedisRule(body, callback)</td>
537
- <td style="padding:15px">Create a new ACL redis rule</td>
537
+ <td style="padding:15px">Create ACL redis rule</td>
538
538
  <td style="padding:15px">{base_path}/{version}/acl/redisRules?{query}</td>
539
539
  <td style="padding:15px">Yes</td>
540
540
  </tr>
541
541
  <tr>
542
542
  <td style="padding:15px">getAllTasks(callback)</td>
543
- <td style="padding:15px">Currently active long running operations</td>
543
+ <td style="padding:15px">Get tasks</td>
544
544
  <td style="padding:15px">{base_path}/{version}/tasks?{query}</td>
545
545
  <td style="padding:15px">Yes</td>
546
546
  </tr>
547
547
  <tr>
548
548
  <td style="padding:15px">getTaskById(taskId, callback)</td>
549
- <td style="padding:15px">Get specific long running operation, identified by Task Id</td>
549
+ <td style="padding:15px">Get task by id</td>
550
550
  <td style="padding:15px">{base_path}/{version}/tasks/{pathv1}?{query}</td>
551
551
  <td style="padding:15px">Yes</td>
552
552
  </tr>
553
553
  <tr>
554
554
  <td style="padding:15px">getSupportedRegions(provider, callback)</td>
555
- <td style="padding:15px">Lookup list of regions for cloud provider</td>
555
+ <td style="padding:15px">Get flexible plans regions</td>
556
556
  <td style="padding:15px">{base_path}/{version}/regions?{query}</td>
557
557
  <td style="padding:15px">Yes</td>
558
558
  </tr>
559
559
  <tr>
560
560
  <td style="padding:15px">getAccountPaymentMethods(callback)</td>
561
- <td style="padding:15px">Lookup list of current Account's payment methods</td>
561
+ <td style="padding:15px">Get payment methods</td>
562
562
  <td style="padding:15px">{base_path}/{version}/payment-methods?{query}</td>
563
563
  <td style="padding:15px">Yes</td>
564
564
  </tr>
565
565
  <tr>
566
566
  <td style="padding:15px">getAccountSystemLogs(offset, limit, callback)</td>
567
- <td style="padding:15px">System log information for current account</td>
567
+ <td style="padding:15px">Get system log</td>
568
568
  <td style="padding:15px">{base_path}/{version}/logs?{query}</td>
569
569
  <td style="padding:15px">Yes</td>
570
570
  </tr>
571
571
  <tr>
572
572
  <td style="padding:15px">getSupportedDatabaseModules(callback)</td>
573
- <td style="padding:15px">Lookup list of database modules supported in current account (support may differ based on subscription and database settings)</td>
573
+ <td style="padding:15px">Get modules</td>
574
574
  <td style="padding:15px">{base_path}/{version}/database-modules?{query}</td>
575
575
  <td style="padding:15px">Yes</td>
576
576
  </tr>
577
577
  <tr>
578
578
  <td style="padding:15px">getDataPersistenceOptions(callback)</td>
579
- <td style="padding:15px">Lookup list of data persistence values</td>
579
+ <td style="padding:15px">Get list of data persistence options</td>
580
580
  <td style="padding:15px">{base_path}/{version}/data-persistence?{query}</td>
581
581
  <td style="padding:15px">Yes</td>
582
582
  </tr>
583
583
  <tr>
584
584
  <td style="padding:15px">get(callback)</td>
585
- <td style="padding:15px">Current account and related information</td>
585
+ <td style="padding:15px">Get current Account</td>
586
586
  <td style="padding:15px">{base_path}/{version}/?{query}</td>
587
587
  <td style="padding:15px">Yes</td>
588
588
  </tr>
package/CHANGELOG.md CHANGED
@@ -1,4 +1,12 @@
1
1
 
2
+ ## 0.2.0 [01-07-2024]
3
+
4
+ * More migration changes
5
+
6
+ See merge request itentialopensource/adapters/persistence/adapter-redis_cloud!1
7
+
8
+ ---
9
+
2
10
  ## 0.1.1 [08-17-2023]
3
11
 
4
12
  * Bug fixes and performance improvements
@@ -6,4 +14,3 @@
6
14
  See commit c2e2675
7
15
 
8
16
  ---
9
-
package/README.md CHANGED
@@ -14,6 +14,7 @@ Some of the page links in this document and links to other GitLab files do not w
14
14
  - [Testing](#testing)
15
15
  - [Configuration](./PROPERTIES.md)
16
16
  - [Using this Adapter](./CALLS.md)
17
+ - [Authentication](./AUTH.md)
17
18
  - [Additional Information](#additional-information)
18
19
  - [Enhancements](./ENHANCE.md)
19
20
  - [Contributing](./CONTRIBUTING.md)
@@ -47,17 +48,20 @@ These instructions will help you get a copy of the project on your local machine
47
48
 
48
49
  ### Helpful Background Information
49
50
 
50
- There is adapter documentation available on the Itential Developer Site <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">HERE</a>. This documentation includes information and examples that are helpful for:
51
+ There is <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter documentation available on the Itential Documentation Site</a>. This documentation includes information and examples that are helpful for:
51
52
 
52
53
  ```text
53
54
  Authentication
54
- Properties
55
+ IAP Service Instance Configuration
55
56
  Code Files
56
- Action Files
57
- Schema Files
58
- Mock Data Files
57
+ Endpoint Configuration (Action & Schema)
58
+ Mock Data
59
+ Adapter Generic Methods
60
+ Headers
61
+ Security
59
62
  Linting and Testing
60
- Troubleshooting
63
+ Build an Adapter
64
+ Troubleshooting an Adapter
61
65
  ```
62
66
 
63
67
  Others will be added over time.