Skip to content

Commit 7133413

Browse files
committed
Add compat boxes to FoxxService docs
1 parent 357bb4e commit 7133413

File tree

2 files changed

+108
-2
lines changed

2 files changed

+108
-2
lines changed

docs/Drivers/JS/Reference/Collection/BulkImport.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,9 @@ Bulk imports the given _data_ into the collection.
6666
["peach", "pink"]
6767
```
6868

69-
- **opts**: `Object` (optional) If _opts_ is set, it must be an object with any
70-
of the following properties:
69+
- **opts**: `Object` (optional)
70+
71+
If _opts_ is set, it must be an object with any of the following properties:
7172

7273
- **type**: `string | null` (Default: `"auto"`)
7374

docs/Drivers/JS/Reference/Database/FoxxServices.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
`async database.listServices([excludeSystem]): Array<Object>`
66

7+
{% hint 'info' %}
8+
This method is only available when targeting ArangoDB 3.2 or later,
9+
see [Compatibility](../../GettingStarted/README.md#compatibility).
10+
{% endhint %}
11+
712
Fetches a list of all installed service.
813

914
**Arguments**
@@ -26,6 +31,11 @@ const services = await db.listServices(false);
2631

2732
`async database.installService(mount, source, [options]): Object`
2833

34+
{% hint 'info' %}
35+
This method is only available when targeting ArangoDB 3.2 or later,
36+
see [Compatibility](../../GettingStarted/README.md#compatibility).
37+
{% endhint %}
38+
2939
Installs a new service.
3040

3141
**Arguments**
@@ -86,6 +96,11 @@ const info = await db.installService("/hello", source);
8696

8797
`async database.replaceService(mount, source, [options]): Object`
8898

99+
{% hint 'info' %}
100+
This method is only available when targeting ArangoDB 3.2 or later,
101+
see [Compatibility](../../GettingStarted/README.md#compatibility).
102+
{% endhint %}
103+
89104
Replaces an existing service with a new service by completely removing the old
90105
service and installing a new service at the same mount point.
91106

@@ -155,6 +170,11 @@ const info = await db.replaceService("/hello", source);
155170

156171
`async database.upgradeService(mount, source, [options]): Object`
157172

173+
{% hint 'info' %}
174+
This method is only available when targeting ArangoDB 3.2 or later,
175+
see [Compatibility](../../GettingStarted/README.md#compatibility).
176+
{% endhint %}
177+
158178
Replaces an existing service with a new service while retaining the old
159179
service's configuration and dependencies.
160180

@@ -224,6 +244,11 @@ const info = await db.upgradeService("/hello", source);
224244

225245
`async database.uninstallService(mount, [options]): void`
226246

247+
{% hint 'info' %}
248+
This method is only available when targeting ArangoDB 3.2 or later,
249+
see [Compatibility](../../GettingStarted/README.md#compatibility).
250+
{% endhint %}
251+
227252
Completely removes a service from the database.
228253

229254
**Arguments**
@@ -251,6 +276,11 @@ await db.uninstallService("/my-service");
251276

252277
`async database.getService(mount): Object`
253278

279+
{% hint 'info' %}
280+
This method is only available when targeting ArangoDB 3.2 or later,
281+
see [Compatibility](../../GettingStarted/README.md#compatibility).
282+
{% endhint %}
283+
254284
Retrieves information about a mounted service.
255285

256286
**Arguments**
@@ -270,6 +300,11 @@ const info = await db.getService("/my-service");
270300

271301
`async database.getServiceConfiguration(mount, [minimal]): Object`
272302

303+
{% hint 'info' %}
304+
This method is only available when targeting ArangoDB 3.2 or later,
305+
see [Compatibility](../../GettingStarted/README.md#compatibility).
306+
{% endhint %}
307+
273308
Retrieves an object with information about the service's configuration options
274309
and their current values.
275310

@@ -294,6 +329,11 @@ const config = await db.getServiceConfiguration("/my-service");
294329

295330
`async database.replaceServiceConfiguration(mount, configuration, [minimal]): Object`
296331

332+
{% hint 'info' %}
333+
This method is only available when targeting ArangoDB 3.2 or later,
334+
see [Compatibility](../../GettingStarted/README.md#compatibility).
335+
{% endhint %}
336+
297337
Replaces the configuration of the given service.
298338

299339
**Arguments**
@@ -326,6 +366,11 @@ const info = await db.replaceServiceConfiguration("/my-service", config);
326366

327367
`async database.updateServiceConfiguration(mount, configuration, [minimal]): Object`
328368

369+
{% hint 'info' %}
370+
This method is only available when targeting ArangoDB 3.2 or later,
371+
see [Compatibility](../../GettingStarted/README.md#compatibility).
372+
{% endhint %}
373+
329374
Updates the configuration of the given service my merging the new values into
330375
the existing ones.
331376

@@ -359,6 +404,11 @@ const info = await db.updateServiceConfiguration("/my-service", config);
359404

360405
`async database.getServiceDependencies(mount, [minimal]): Object`
361406

407+
{% hint 'info' %}
408+
This method is only available when targeting ArangoDB 3.2 or later,
409+
see [Compatibility](../../GettingStarted/README.md#compatibility).
410+
{% endhint %}
411+
362412
Retrieves an object with information about the service's dependencies and their
363413
current mount points.
364414

@@ -383,6 +433,11 @@ const deps = await db.getServiceDependencies("/my-service");
383433

384434
`async database.replaceServiceDependencies(mount, dependencies, [minimal]): Object`
385435

436+
{% hint 'info' %}
437+
This method is only available when targeting ArangoDB 3.2 or later,
438+
see [Compatibility](../../GettingStarted/README.md#compatibility).
439+
{% endhint %}
440+
386441
Replaces the dependencies for the given service.
387442

388443
**Arguments**
@@ -415,6 +470,11 @@ const info = await db.replaceServiceDependencies("/my-service", deps);
415470

416471
`async database.updateServiceDependencies(mount, dependencies, [minimal]): Object`
417472

473+
{% hint 'info' %}
474+
This method is only available when targeting ArangoDB 3.2 or later,
475+
see [Compatibility](../../GettingStarted/README.md#compatibility).
476+
{% endhint %}
477+
418478
Updates the dependencies for the given service by merging the new values into
419479
the existing ones.
420480

@@ -448,6 +508,11 @@ const info = await db.updateServiceDependencies("/my-service", deps);
448508

449509
`async database.enableServiceDevelopmentMode(mount): Object`
450510

511+
{% hint 'info' %}
512+
This method is only available when targeting ArangoDB 3.2 or later,
513+
see [Compatibility](../../GettingStarted/README.md#compatibility).
514+
{% endhint %}
515+
451516
Enables development mode for the given service.
452517

453518
**Arguments**
@@ -468,6 +533,11 @@ const info = await db.enableServiceDevelopmentMode("/my-service");
468533

469534
`async database.disableServiceDevelopmentMode(mount): Object`
470535

536+
{% hint 'info' %}
537+
This method is only available when targeting ArangoDB 3.2 or later,
538+
see [Compatibility](../../GettingStarted/README.md#compatibility).
539+
{% endhint %}
540+
471541
Disabled development mode for the given service and commits the service state to
472542
the database.
473543

@@ -489,6 +559,11 @@ const info = await db.disableServiceDevelopmentMode("/my-service");
489559

490560
`async database.listServiceScripts(mount): Object`
491561

562+
{% hint 'info' %}
563+
This method is only available when targeting ArangoDB 3.2 or later,
564+
see [Compatibility](../../GettingStarted/README.md#compatibility).
565+
{% endhint %}
566+
492567
Retrieves a list of the service's scripts.
493568

494569
Returns an object mapping each name to a more readable representation.
@@ -510,6 +585,11 @@ const scripts = await db.listServiceScripts("/my-service");
510585

511586
`async database.runServiceScript(mount, name, [scriptArg]): any`
512587

588+
{% hint 'info' %}
589+
This method is only available when targeting ArangoDB 3.2 or later,
590+
see [Compatibility](../../GettingStarted/README.md#compatibility).
591+
{% endhint %}
592+
513593
Runs a service script and returns the result.
514594

515595
**Arguments**
@@ -537,6 +617,11 @@ const result = await db.runServiceScript("/my-service", "setup");
537617

538618
`async database.runServiceTests(mount, [reporter]): any`
539619

620+
{% hint 'info' %}
621+
This method is only available when targeting ArangoDB 3.2 or later,
622+
see [Compatibility](../../GettingStarted/README.md#compatibility).
623+
{% endhint %}
624+
540625
Runs the tests of a given service and returns a formatted report.
541626

542627
**Arguments**
@@ -582,6 +667,11 @@ const result = await db.runServiceTests("/my-service", opts);
582667

583668
`async database.downloadService(mount): Buffer | Blob`
584669

670+
{% hint 'info' %}
671+
This method is only available when targeting ArangoDB 3.2 or later,
672+
see [Compatibility](../../GettingStarted/README.md#compatibility).
673+
{% endhint %}
674+
585675
Retrieves a zip bundle containing the service files.
586676

587677
Returns a `Buffer` in Node or `Blob` in the browser version.
@@ -603,6 +693,11 @@ const bundle = await db.downloadService("/my-service");
603693

604694
`async database.getServiceReadme(mount): string?`
605695

696+
{% hint 'info' %}
697+
This method is only available when targeting ArangoDB 3.2 or later,
698+
see [Compatibility](../../GettingStarted/README.md#compatibility).
699+
{% endhint %}
700+
606701
Retrieves the text content of the service's `README` or `README.md` file.
607702

608703
Returns `undefined` if no such file could be found.
@@ -625,6 +720,11 @@ const readme = await db.getServiceReadme("/my-service");
625720

626721
`async database.getServiceDocumentation(mount): Object`
627722

723+
{% hint 'info' %}
724+
This method is only available when targeting ArangoDB 3.2 or later,
725+
see [Compatibility](../../GettingStarted/README.md#compatibility).
726+
{% endhint %}
727+
628728
Retrieves a Swagger API description object for the service installed at the
629729
given mount point.
630730

@@ -645,6 +745,11 @@ const spec = await db.getServiceDocumentation("/my-service");
645745

646746
`async database.commitLocalServiceState([replace]): void`
647747

748+
{% hint 'info' %}
749+
This method is only available when targeting ArangoDB 3.2 or later,
750+
see [Compatibility](../../GettingStarted/README.md#compatibility).
751+
{% endhint %}
752+
648753
Writes all locally available services to the database and updates any service
649754
bundles missing in the database.
650755

0 commit comments

Comments
 (0)