Skip to content

HTTP API: Add missing defaults/enums, fix mistakes #718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Aug 7, 2025
Merged

HTTP API: Add missing defaults/enums, fix mistakes #718

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
2b62569
HTTP API: Add some missing defaults/enums
Simran-B Jun 24, 2025
bc56f4a
More defaults, formatting, rev parameter in Gharial vertex/edge ops, …
Simran-B Jun 24, 2025
4effde0
Merge branch 'main' of https://github.com/arangodb/docs-hugo into htt…
Simran-B Jun 24, 2025
7d44cef
Named graphs: Remove docs for superfluous rev query param, some rewor…
Simran-B Jun 25, 2025
8269355
Rewording, missing defaults
Simran-B Jun 25, 2025
6209ca5
Index API: Backport changes to 3.11
Simran-B Jun 25, 2025
ba8466b
Apply rewording to JS API docs
Simran-B Jun 25, 2025
0994f5d
Rework concept page about key generators, add padded and uuid
Simran-B Jul 15, 2025
5c2979c
Users: passwd is not mandatory, PUT resets access levels
Simran-B Jul 15, 2025
4d82664
Fix shard IDs example and missing response description
Simran-B Jul 15, 2025
3486d75
maxTransactionSize not available in 3.11
Simran-B Aug 4, 2025
74ccea8
CSS: Make the version selector gray instead of green
Simran-B Aug 4, 2025
474dbbf
Unify release notes
Simran-B Aug 4, 2025
db40dd9
Finish up improvements to OpenAPI descriptions
Simran-B Aug 4, 2025
3264abb
Merge branch 'main' of https://github.com/arangodb/docs-hugo into htt…
Simran-B Aug 4, 2025
884d699
Review feedback
Simran-B Aug 7, 2025
344c51f
Apply to 3.11
Simran-B Aug 7, 2025
e0666de
Merge branch 'main' of https://github.com/arangodb/docs-hugo into htt…
Simran-B Aug 7, 2025
5a9b0e1
[skip ci] Automatic commit of generated files from CircleCI
Simran-B Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions site/content/3.11/develop/http-api/databases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,9 +241,15 @@ paths:
properties:
sharding:
description: |
The sharding method to use for new collections in this database. Valid values
are: "", "flexible", or "single". The first two are equivalent. _(cluster only)_
The sharding method to use for new collections in this database. _(cluster only)_
Valid values are:
- `""` or `"flexible"`: Create a database where collections can have any
number of shards and the shards can reside on different DB-Servers.
- `"single"`: Create a OneShard database where all collections have a
single shard and the shards are placed on the same DB-Server.
type: string
enum: ["", flexible, single]
default: ""
replicationFactor:
description: |
Default replication factor for new collections created in this database.
Expand Down
6 changes: 6 additions & 0 deletions site/content/3.11/develop/http-api/documents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,7 @@ paths:
therefore they can only be performed on collections sharded by `_key`.
schema:
type: boolean
default: false
- name: overwriteMode
in: query
required: false
Expand All @@ -499,6 +500,8 @@ paths:
not set, and the `overwrite` flag is `false` or not set either.
schema:
type: string
enum: [ignore, replace, update, conflict]
default: conflict
- name: keepNull
in: query
required: false
Expand Down Expand Up @@ -1946,6 +1949,7 @@ paths:
therefore they can only be performed on collections sharded by `_key`.
schema:
type: boolean
default: false
- name: overwriteMode
in: query
required: false
Expand All @@ -1970,6 +1974,8 @@ paths:
not set, and the `overwrite` flag is `false` or not set either.
schema:
type: string
enum: [ignore, replace, update, conflict]
default: conflict
- name: keepNull
in: query
required: false
Expand Down
10 changes: 8 additions & 2 deletions site/content/3.12/develop/http-api/databases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,9 +241,15 @@ paths:
properties:
sharding:
description: |
The sharding method to use for new collections in this database. Valid values
are: "", "flexible", or "single". The first two are equivalent. _(cluster only)_
The sharding method to use for new collections in this database. _(cluster only)_
Valid values are:
- `""` or `"flexible"`: Create a database where collections can have any
number of shards and the shards can reside on different DB-Servers.
- `"single"`: Create a OneShard database where all collections have a
single shard and the shards are placed on the same DB-Server.
type: string
enum: ["", flexible, single]
default: ""
replicationFactor:
description: |
Default replication factor for new collections created in this database.
Expand Down
6 changes: 6 additions & 0 deletions site/content/3.12/develop/http-api/documents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,7 @@ paths:
therefore they can only be performed on collections sharded by `_key`.
schema:
type: boolean
default: false
- name: overwriteMode
in: query
required: false
Expand All @@ -489,6 +490,8 @@ paths:
not set, and the `overwrite` flag is `false` or not set either.
schema:
type: string
enum: [ignore, replace, update, conflict]
default: conflict
- name: keepNull
in: query
required: false
Expand Down Expand Up @@ -2004,6 +2007,7 @@ paths:
therefore they can only be performed on collections sharded by `_key`.
schema:
type: boolean
default: false
- name: overwriteMode
in: query
required: false
Expand All @@ -2028,6 +2032,8 @@ paths:
not set, and the `overwrite` flag is `false` or not set either.
schema:
type: string
enum: [ignore, replace, update, conflict]
default: conflict
- name: keepNull
in: query
required: false
Expand Down
10 changes: 8 additions & 2 deletions site/content/3.13/develop/http-api/databases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,9 +241,15 @@ paths:
properties:
sharding:
description: |
The sharding method to use for new collections in this database. Valid values
are: "", "flexible", or "single". The first two are equivalent. _(cluster only)_
The sharding method to use for new collections in this database. _(cluster only)_
Valid values are:
- `""` or `"flexible"`: Create a database where collections can have any
number of shards and the shards can reside on different DB-Servers.
- `"single"`: Create a OneShard database where all collections have a
single shard and the shards are placed on the same DB-Server.
type: string
enum: ["", flexible, single]
default: ""
replicationFactor:
description: |
Default replication factor for new collections created in this database.
Expand Down
6 changes: 6 additions & 0 deletions site/content/3.13/develop/http-api/documents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,7 @@ paths:
therefore they can only be performed on collections sharded by `_key`.
schema:
type: boolean
default: false
- name: overwriteMode
in: query
required: false
Expand All @@ -489,6 +490,8 @@ paths:
not set, and the `overwrite` flag is `false` or not set either.
schema:
type: string
enum: [ignore, replace, update, conflict]
default: conflict
- name: keepNull
in: query
required: false
Expand Down Expand Up @@ -2004,6 +2007,7 @@ paths:
therefore they can only be performed on collections sharded by `_key`.
schema:
type: boolean
default: false
- name: overwriteMode
in: query
required: false
Expand All @@ -2028,6 +2032,8 @@ paths:
not set, and the `overwrite` flag is `false` or not set either.
schema:
type: string
enum: [ignore, replace, update, conflict]
default: conflict
- name: keepNull
in: query
required: false
Expand Down