Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Commit 6ef0e6f

Browse files
Simran-BKVS85
andauthored
DOC-382 | Refactor HTTP API (#1289)
* Single out authentication, single file for databases, collections, documents, and edges. Rework start page and introductions. * Fix links, apply to 3.10 * Allow to set a headline level for DocuBlocks The {% docublock %} tag now optionally accepts a second parameter to override the headline level: {% docublock name, h4 %} * Rework structure, set headline levels explicitly where the default of h3 isn't correct * WIP * DOC-428 | Add get_admin_support_info DocuBlock to docs * Rename DocuBlock references, remove merged ones * Fix excludes * Fix DocuBlock references * Re-organize and rewrite * Fix links * Complete Views introduction * Major re-organization and cleanup * DOC-439 | Render basename + metric suffixes for metrics of type histogram and summary * Integrate documentRevision removal * Add text for HTTP Basic auth * Remove glossary and naming convention pages * Remove modification query and memoryLimit examples * Remove leftover naming convention page * Update examples for 3.10,3.11 in http-refactor at 2023-03-28T17:33:36+00:00 * Fix links * Fix headline levels, adjust task lead-in, update Swagger UI screenshot * APM-592 Addendum * Update examples for 3.10,3.11 in http-refactor at 2023-03-30T12:45:08+00:00 * Update examples for 3.10,3.11 in http-refactor at 2023-04-04T13:01:32+00:00 --------- Co-authored-by: Vadim <[email protected]>
1 parent 617f54d commit 6ef0e6f

File tree

1,070 files changed

+82610
-87527
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,070 files changed

+82610
-87527
lines changed

3.10/administration-cluster.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -219,8 +219,8 @@ You can also do any of the following by using the API:
219219
- Execute the given set of move shard operations.
220220
- Compute a set of move shard operations to improve balance and immediately execute them.
221221

222-
For more information, see the [Cluster Administration & Monitoring](http/administration-and-monitoring.html#compute-the-current-cluster-imbalance)
223-
section of the HTTP API reference manual.
222+
For more information, see the [Cluster](http/cluster.html#compute-the-current-cluster-imbalance)
223+
section of the HTTP API documentation.
224224

225225
Replacing/Removing a _Coordinator_
226226
----------------------------------

3.10/administration-configuration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ for small adjustments, you can put local overrides into a file
192192

193193
You can add suffixes to numeric options to let ArangoDB multiply the value by a
194194
certain factor. This allows you to conveniently specify values, for example,
195-
in megabytes or gigabytes.
195+
in kilobytes, megabytes, and gigabytes.
196196

197197
| Suffix | Factor | Example |
198198
|----------------------|----------|---------|

3.10/administration-license.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: License Management of ArangoDB Enterprise Edition
77
The Enterprise Edition of ArangoDB requires a license to activate the
88
Enterprise Edition features. How to set a license key and to retrieve
99
information about the current license via the JavaScript API is described below.
10-
There is also an [HTTP API](http/license.html).
10+
There is also an [HTTP API](http/administration.html#license).
1111
Also check the [ArangoDB Kubernetes Operator](deployment-kubernetes-usage.html)
1212
for more details on how to set a license key.
1313

@@ -77,7 +77,7 @@ applied license for reference and support from ArangoDB.
7777

7878
In order to monitor the remaining validity of the license, the metric
7979
`arangodb_license_expires` is exposed by Coordinators and DB-Servers, see the
80-
[Metrics API](http/administration-and-monitoring-metrics.html).
80+
[Metrics API](http/monitoring.html#metrics).
8181

8282
## Managing Your License
8383

3.10/appendix-deprecated.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ replace the old features with:
4040
- **Skiplist and hash indexes**:
4141
Skiplist and hash indexes have been deprecated in 3.9 and will be removed in a
4242
future version of ArangoDB. Currently, they are an alias for a
43-
[persistent index](http/indexes.html#persistent-index).
43+
[persistent index](indexing-index-basics.html#persistent-index).
4444

4545
- **Bundled NPM modules**:
4646
The bundled NPM modules `aqb`, `chai`, `dedent`, `error-stack-parser`,
@@ -53,12 +53,12 @@ replace the old features with:
5353
- **Batch Requests API**:
5454
The [batch request REST API](http/batch-request.html) is deprecated and will be
5555
removed in a future version. Instead of using this API, please use the
56-
[HTTP Interface for Documents](http/document-working-with-documents.html#bulk-document-operations)
56+
[HTTP interface for documents](http/document.html#multiple-document-operations)
5757
that can insert, update, replace or remove arrays of documents.
5858

5959
- **PUT method in Cursor API**:
6060
The HTTP endpoint `PUT /_api/cursor/<cursor-id>` in the
61-
[Cursor REST API](http/aql-query-cursor.html) is deprecated and will be
61+
[Cursor REST API](http/aql-query.html) is deprecated and will be
6262
removed in a future version. Please use the drop-in replacement
6363
`POST /_api/cursor/<cursor-id>` instead. The POST endpoint is functionally
6464
equivalent to the PUT endpoint, but does not violate idempotency requirements

3.10/appendix-glossary.md

-295
This file was deleted.

3.10/appendix-java-script-modules-queries.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Properties
1515
`queries.properties()` Returns the servers current query tracking configuration; we change the slow query threshold to get better results:
1616

1717
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
18-
@startDocuBlockInline QUERY_01_properyOfQueries
19-
@EXAMPLE_ARANGOSH_OUTPUT{QUERY_01_properyOfQueries}
18+
@startDocuBlockInline QUERY_01_propertyOfQueries
19+
@EXAMPLE_ARANGOSH_OUTPUT{QUERY_01_propertyOfQueries}
2020
var queries = require("@arangodb/aql/queries");
2121
queries.properties();
2222
queries.properties({slowQueryThreshold: 1});
2323
queries.properties({slowStreamingQueryThreshold: 1});
2424
@END_EXAMPLE_ARANGOSH_OUTPUT
25-
@endDocuBlock QUERY_01_properyOfQueries
25+
@endDocuBlock QUERY_01_propertyOfQueries
2626
{% endarangoshexample %}
2727
{% include arangoshexample.html id=examplevar script=script result=result %}
2828

0 commit comments

Comments
 (0)