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

Commit 24385ea

Browse files
jsteemannnerpaula
andauthored
remove long-deprecated HTTP options (#1444)
* remove long-deprecated HTTP options * re-trigger netlify * formatting --------- Co-authored-by: Paula <[email protected]>
1 parent 8322de0 commit 24385ea

6 files changed

+29
-33
lines changed

3.10/appendix-deprecated.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,10 @@ detailed information about breaking changes before upgrading.
171171
`x-http-method-override`. This was originally intended for very restricted
172172
callers, which only supported HTTP GET and HTTP POST, but seems very
173173
unnecessary nowadays.
174+
The functionality will be removed in ArangoDB 3.12.
174175
- `--http.hide-product-header`: whether or not to hide the `Server: ArangoDB`
175176
header in all responses served by arangod.
177+
The functionality will be removed in ArangoDB 3.12.
176178
- `--network.protocol`: network protocol to use for cluster-internal
177179
communication. The protocol will be auto-decided from version 3.9 onwards.
178180
- `--query.allow-collections-in-expressions`: allow full collections to be

3.11/appendix-deprecated.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,9 +186,11 @@ detailed information about breaking changes before upgrading.
186186
special HTTP headers `x-http-method`, `x-method-override` or
187187
`x-http-method-override`. This was originally intended for very restricted
188188
callers, which only supported HTTP GET and HTTP POST, but seems very
189-
unnecessary nowadays.
189+
unnecessary nowadays.
190+
The functionality will be removed in ArangoDB 3.12.
190191
- `--http.hide-product-header`: whether or not to hide the `Server: ArangoDB`
191192
header in all responses served by arangod.
193+
The functionality will be removed in ArangoDB 3.12.
192194
- `--network.protocol`: network protocol to use for cluster-internal
193195
communication. The protocol will be auto-decided from version 3.9 onwards.
194196
- `--query.allow-collections-in-expressions`: allow full collections to be

3.12/appendix-deprecated.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -185,14 +185,6 @@ detailed information about breaking changes before upgrading.
185185
- `--arangosearch.consolidation-threads-idle`
186186
- `--rocksdb.exclusive-writes` (was intended only as a stopgap measure to
187187
make porting applications from MMFiles to RocksDB easier)
188-
- `--http.allow-method-override`: this option allows incoming HTTP POST
189-
request to override the actual HTTP method used by setting one of the
190-
special HTTP headers `x-http-method`, `x-method-override` or
191-
`x-http-method-override`. This was originally intended for very restricted
192-
callers, which only supported HTTP GET and HTTP POST, but seems very
193-
unnecessary nowadays.
194-
- `--http.hide-product-header`: whether or not to hide the `Server: ArangoDB`
195-
header in all responses served by arangod.
196188
- `--network.protocol`: network protocol to use for cluster-internal
197189
communication. The protocol will be auto-decided from version 3.9 onwards.
198190
- `--query.allow-collections-in-expressions`: allow full collections to be

3.12/http/general.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -385,30 +385,6 @@ requests unless explicitly told to do so:
385385
});
386386
```
387387

388-
## HTTP method overriding
389-
390-
{% hint 'warning' %}
391-
HTTP method overriding is deprecated from version 3.9.0 on and should no longer
392-
be used.
393-
{% endhint %}
394-
395-
ArangoDB provides a startup option *--http.allow-method-override*.
396-
This option can be set to allow overriding the HTTP request method (e.g. GET, POST,
397-
PUT, DELETE, PATCH) of a request using one of the following custom HTTP headers:
398-
399-
- `x-http-method-override`
400-
- `x-http-method`
401-
- `x-method-override`
402-
403-
This allows using HTTP clients that do not support all "common" HTTP methods such as
404-
PUT, PATCH and DELETE. It also allows bypassing proxies and tools that would otherwise
405-
just let certain types of requests (e.g. GET and POST) pass through.
406-
407-
Enabling this option may impose a security risk, so it should only be used in very
408-
controlled environments. Thus the default value for this option is *false* (no method
409-
overriding allowed). You need to enable it explicitly if you want to use this
410-
feature.
411-
412388
## Load-balancer support
413389

414390
When running in cluster mode, ArangoDB exposes some APIs which store request

3.12/release-notes-upgrading-changes312.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,28 @@ larger amounts of data and was thus very limited.
5353
Users of the `/_api/traversal` REST API should use
5454
[AQL traversal queries](aql/graphs-traversals.html) instead.
5555

56+
### HTTP server behavior
57+
58+
The following long-deprecated features have been removed from ArangoDB's HTTP
59+
server:
60+
61+
- overriding the HTTP method by setting one of the HTTP headers:
62+
- `x-http-method`
63+
- `x-http-method-override`
64+
- `x-method-override`
65+
66+
This functionaltiy posed a potential security risk and was thus removed.
67+
Previously, it was only enabled when explicitly starting the
68+
server with the `--http.allow-method-override` startup option.
69+
The functionality has now been removed and setting the startup option does
70+
nothing.
71+
72+
- optionally hiding ArangoDB's `server` response header. This functionality
73+
could optionally be enabled by starting the server with the startup option
74+
`--http.hide-product-header`.
75+
The functionality has now been removed and setting the startup option does
76+
nothing.
77+
5678
## JavaScript API
5779

5880
### `@arangodb/graph/traversal` module

3.9/appendix-deprecated.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,10 @@ replace the old features with:
157157
`x-http-method-override`. This was originally intended for very restricted
158158
callers, which only supported HTTP GET and HTTP POST, but seems very
159159
unnecessary nowadways.
160+
The functionality will be removed in ArangoDB 3.12.
160161
- `--http.hide-product-header`: whether or not to hide the `Server: ArangoDB`
161162
header in all responses served by arangod.
163+
The functionality will be removed in ArangoDB 3.12.
162164
- `--network.protocol`: network protocol to use for cluster-internal
163165
communication. The protocol will be auto-decided from version 3.9 onwards.
164166
- `--query.allow-collections-in-expressions`: allow full collections to be

0 commit comments

Comments
 (0)