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

DOC-382 | Refactor HTTP API #1289

Merged
merged 31 commits into from
Apr 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
f3ae96e
Single out authentication, single file for databases, collections, d…
Simran-B Feb 27, 2023
893fb65
Fix links, apply to 3.10
Simran-B Feb 27, 2023
897910b
Allow to set a headline level for DocuBlocks
Simran-B Feb 28, 2023
66def84
Rework structure, set headline levels explicitly where the default of…
Simran-B Feb 28, 2023
9858d0d
WIP
Simran-B Mar 3, 2023
594e252
Merge branch 'main' of https://github.com/arangodb/docs into http-ref…
Simran-B Mar 7, 2023
30863d6
DOC-428 | Add get_admin_support_info DocuBlock to docs
Simran-B Mar 23, 2023
21e55cf
Merge branch 'main' of https://github.com/arangodb/docs into http-ref…
Simran-B Mar 23, 2023
bbc8115
Rename DocuBlock references, remove merged ones
Simran-B Mar 23, 2023
1fd7c31
Fix excludes
Simran-B Mar 23, 2023
863a61c
Fix DocuBlock references
Simran-B Mar 23, 2023
2108f01
Re-organize and rewrite
Simran-B Mar 24, 2023
cd76181
Fix links
Simran-B Mar 24, 2023
7e0c36b
Complete Views introduction
Simran-B Mar 27, 2023
6997a88
Major re-organization and cleanup
Simran-B Mar 27, 2023
bfe86d7
DOC-439 | Render basename + metric suffixes for metrics of type histo…
Simran-B Mar 27, 2023
1fc5675
Merge branch 'main' of https://github.com/arangodb/docs into http-ref…
Simran-B Mar 28, 2023
85b719b
Integrate documentRevision removal
Simran-B Mar 28, 2023
87500cf
Add text for HTTP Basic auth
Simran-B Mar 28, 2023
df72079
Remove glossary and naming convention pages
Simran-B Mar 28, 2023
b91e3c7
Remove modification query and memoryLimit examples
Simran-B Mar 28, 2023
13d1e98
Remove leftover naming convention page
Simran-B Mar 28, 2023
be50b61
Update examples for 3.10,3.11 in http-refactor at 2023-03-28T17:33:36…
Simran-B Mar 28, 2023
1736957
Fix links
Simran-B Mar 28, 2023
94ee98e
Fix headline levels, adjust task lead-in, update Swagger UI screenshot
Simran-B Mar 28, 2023
512602e
Merge branch 'main' of https://github.com/arangodb/docs into http-ref…
Simran-B Mar 29, 2023
21884cb
APM-592 Addendum
Simran-B Mar 30, 2023
489631d
Merge branch 'main' of https://github.com/arangodb/docs into http-ref…
Simran-B Mar 30, 2023
d0f0d70
Update examples for 3.10,3.11 in http-refactor at 2023-03-30T12:45:08…
Simran-B Mar 30, 2023
08540a2
Merge branch 'main' into http-refactor
KVS85 Apr 4, 2023
0f89949
Update examples for 3.10,3.11 in http-refactor at 2023-04-04T13:01:32…
KVS85 Apr 4, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions 3.10/administration-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,8 @@ You can also do any of the following by using the API:
- Execute the given set of move shard operations.
- Compute a set of move shard operations to improve balance and immediately execute them.

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

Replacing/Removing a _Coordinator_
----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion 3.10/administration-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ for small adjustments, you can put local overrides into a file

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

| Suffix | Factor | Example |
|----------------------|----------|---------|
Expand Down
4 changes: 2 additions & 2 deletions 3.10/administration-license.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: License Management of ArangoDB Enterprise Edition
The Enterprise Edition of ArangoDB requires a license to activate the
Enterprise Edition features. How to set a license key and to retrieve
information about the current license via the JavaScript API is described below.
There is also an [HTTP API](http/license.html).
There is also an [HTTP API](http/administration.html#license).
Also check the [ArangoDB Kubernetes Operator](deployment-kubernetes-usage.html)
for more details on how to set a license key.

Expand Down Expand Up @@ -77,7 +77,7 @@ applied license for reference and support from ArangoDB.

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

## Managing Your License

Expand Down
6 changes: 3 additions & 3 deletions 3.10/appendix-deprecated.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ replace the old features with:
- **Skiplist and hash indexes**:
Skiplist and hash indexes have been deprecated in 3.9 and will be removed in a
future version of ArangoDB. Currently, they are an alias for a
[persistent index](http/indexes.html#persistent-index).
[persistent index](indexing-index-basics.html#persistent-index).

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

- **PUT method in Cursor API**:
The HTTP endpoint `PUT /_api/cursor/<cursor-id>` in the
[Cursor REST API](http/aql-query-cursor.html) is deprecated and will be
[Cursor REST API](http/aql-query.html) is deprecated and will be
removed in a future version. Please use the drop-in replacement
`POST /_api/cursor/<cursor-id>` instead. The POST endpoint is functionally
equivalent to the PUT endpoint, but does not violate idempotency requirements
Expand Down
295 changes: 0 additions & 295 deletions 3.10/appendix-glossary.md

This file was deleted.

6 changes: 3 additions & 3 deletions 3.10/appendix-java-script-modules-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Properties
`queries.properties()` Returns the servers current query tracking configuration; we change the slow query threshold to get better results:

{% arangoshexample examplevar="examplevar" script="script" result="result" %}
@startDocuBlockInline QUERY_01_properyOfQueries
@EXAMPLE_ARANGOSH_OUTPUT{QUERY_01_properyOfQueries}
@startDocuBlockInline QUERY_01_propertyOfQueries
@EXAMPLE_ARANGOSH_OUTPUT{QUERY_01_propertyOfQueries}
var queries = require("@arangodb/aql/queries");
queries.properties();
queries.properties({slowQueryThreshold: 1});
queries.properties({slowStreamingQueryThreshold: 1});
@END_EXAMPLE_ARANGOSH_OUTPUT
@endDocuBlock QUERY_01_properyOfQueries
@endDocuBlock QUERY_01_propertyOfQueries
{% endarangoshexample %}
{% include arangoshexample.html id=examplevar script=script result=result %}

Expand Down
Loading