Skip to content

Commit 2fb01d7

Browse files
enhancement: hugo update and shortcode improvements (#15)
* fix: shortcode path reference * enhancement: update hugo version to v0.100.1 * fix: number of routes for the definition of headings
1 parent a1c1080 commit 2fb01d7

File tree

8 files changed

+29
-29
lines changed

8 files changed

+29
-29
lines changed

content/technical/api/db/_index.en.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ menu:
99

1010
{{< toc-en >}}
1111

12-
# Retrieve objects
12+
## Retrieve objects
1313
GET /api/v1/db/<objecttype>/<mask>/<id>?token=<token>[&version=<version>[&schemaversion=<schemaversion>]][&format=<format>][&skip_reverse_nested=<skip_reverse_nested>]
1414
Object by object ID (`<objecttype>._id` field). One object in the resulting array.
1515

@@ -22,7 +22,7 @@ Object by system object ID (`_system_object_id` field). One object in the result
2222
GET /api/v1/db/<objecttype>/<mask>/list?token=<token>[&limit=<limit>][&offset=<offset>][&version=<version>[&schemaversion=<schemaversion>]][&format=<format>][&skip_reverse_nested=<skip_reverse_nested>]
2323
List of objects, sorted ascending by object IDs (length of array controlled by parameters `limit` and `offset`). Multiple objects in the resulting array.
2424

25-
## Path parameters
25+
### Path parameters
2626

2727
| | |
2828
|---|---|
@@ -40,24 +40,24 @@ If the given `mask` does not exist in the schema for the given object version, a
4040

4141
If no schema for the given object `version` is found, an [Old Schema Missing](/en/technical/errors) error is returned.
4242

43-
## Query String
43+
### Query String
4444

4545
| | |
4646
|---|---|
4747
| `token` | Session token acquired with [/api/v1/session](/en/technical/api/session) |
4848

49-
## Output
49+
### Output
5050

5151
Array of [objects](/en/technical/types/object) in the requested format.
5252

53-
## Permissions
53+
### Permissions
5454

5555
The user needs the "read" right for the requested object and the "mask" right for the given mask
5656
(see [rights management](/en/technical/rightsmanagement)).
5757

5858
In order to use the "\_all\_fields" mask, the user needs any of the following system rights: "system.root", "system.datamodel.development", "system.datamodel.commit".
5959

60-
## HTTP status codes
60+
### HTTP status codes
6161

6262
| | |
6363
|---|---|
@@ -73,19 +73,19 @@ In order to use the "\_all\_fields" mask, the user needs any of the following sy
7373
| 400 | [Old Mask Missing](/en/technical/errors): the given `mask` does not exist in the given `schemaversion` |
7474
| 500 | [Server error](/en/technical/errors): internal server error |
7575

76-
# Retrieve all versions of objects
76+
## Retrieve all versions of objects
7777

7878
GET /api/v1/db/<objecttype>/_all_fields?token=<token>&all_versions=true[&limit=<limit>][&offset=<offset>]
7979

8080
Returns all versions of all objects of this type, not filtered by any mask.
8181

82-
## Path parameters
82+
### Path parameters
8383

8484
| | |
8585
|---|---|
8686
| `objecttype` | Object type (string) |
8787

88-
## Query String
88+
### Query String
8989

9090
| | |
9191
|---|---|
@@ -94,7 +94,7 @@ Returns all versions of all objects of this type, not filtered by any mask.
9494
| `limit` | limit of objects (not versions) returned, defaults to `1000` |
9595
| `offset` | offset of first object to retrieve, defaults to `0` |
9696

97-
## Output
97+
### Output
9898

9999
Array of [objects](/en/technical/types/object) as above, ordered by object ID and version number. These differences to the single-version output exist:
100100

@@ -105,15 +105,15 @@ Array of [objects](/en/technical/types/object) as above, ordered by object ID an
105105
* the `_owner` field is simplified, no names but only ID of user or group is included (format and `_basetype` marker are kept compatible)
106106
* there is no changelog
107107

108-
## Permissions
108+
### Permissions
109109

110110
The system right `system.root` is required to use this request.
111111

112-
## HTTP status codes
112+
### HTTP status codes
113113

114114
See single-version object retrieval for possible HTTP status codes.
115115

116-
# Create or update objects
116+
## Create or update objects
117117
POST/PUT /api/v1/db/<objecttype>?token=<token>[&confirm=<confirm>][&collection=<collection_id>][&priority=<priority>][&format=<format>][&base_fields_only=1][&progress_uuid=<progress_uuid>]
118118

119119
Creates or updates objects for the given `objecttype`.
@@ -137,13 +137,13 @@ The objects will be created and inserted in the collection. The owner of the obj
137137

138138
Notice: POST for masks with mask filters is not allowed.
139139

140-
## Path parameters
140+
### Path parameters
141141

142142
| | |
143143
|---|---|
144144
| `objecttype` | Object type (string) |
145145

146-
## Query String
146+
### Query String
147147

148148
| | |
149149
|---|---|
@@ -160,7 +160,7 @@ Notice: POST for masks with mask filters is not allowed.
160160
| `base_fields_only` | If set to "1", use "base fields only" mode |
161161
| `progress_uuid` | If this variable is set, API_PROGRESS events will be generated during the operation, the `progress_uuid` can then be used to match the events to the operation |
162162

163-
## Input
163+
### Input
164164

165165
Array of [objects](/en/technical/types/object). The following restrictions apply:
166166

@@ -173,7 +173,7 @@ Array of [objects](/en/technical/types/object). The following restrictions apply
173173

174174
> `_id` and `_id_parent` can be set using a lookup feature, which selects the object using a reference column. More information about this feature can be found in the [Lookups for IDs](/en/technical/datamanagement/lookups/) documentation.
175175
176-
### Creation or regular update
176+
#### Creation or regular update
177177

178178
The object is updated as a whole. That means that if the user only wants to change the value of a certain field,
179179
all other fields must be sent with their current values. Exceptions to this rule are:
@@ -184,7 +184,7 @@ all other fields must be sent with their current values. Exceptions to this rule
184184
When creating an object, the owner must be the user that creates it. If `_owner` is left out, Easydb will fill this value.
185185
When using the `collection` parameter, the owner is automatically set to the owner of the collection.
186186

187-
### Group edit
187+
#### Group edit
188188

189189
In group edit mode, only the given fields will be updated. Special instructions can be specified for lists:
190190

@@ -234,11 +234,11 @@ have the following values:
234234

235235
The mode **acl_remove_all** can be specified without `_acl` (if specified, it will be ignored).
236236

237-
## Output
237+
### Output
238238

239239
If the request is a group edit or "base fields only", the response body will be empty. Otherwise, it is an array of [objects](/en/technical/types/object) in the requested format.
240240

241-
## Permissions
241+
### Permissions
242242

243243
The user needs the following rights at the beginning of the operation (see [rights management](/en/technical/rightsmanagement)):
244244

@@ -273,13 +273,13 @@ before they are inserted. Furthermore, they must be grantable. Otherwise, an err
273273

274274
The root pool is never allowed.
275275

276-
## Example
276+
### Example
277277

278278

279279
{{< include_json "./post.json" >}}
280280

281281

282-
## HTTP status codes
282+
### HTTP status codes
283283

284284
| | |
285285
|---|---|
@@ -317,7 +317,7 @@ The root pool is never allowed.
317317

318318

319319

320-
# Delete objects
320+
## Delete objects
321321

322322
DELETE /api/v1/db/<objecttype>?token=<token>[&confirm=<confirm>][&priority=<priority>]
323323

@@ -329,21 +329,21 @@ Deleting a hierarchical object automatically results in the deletion of all depe
329329
*Linked objects:*
330330
Attempting to delete an object which is referenced from another object results in an error (HTTP code 409).
331331

332-
## Path parameters
332+
### Path parameters
333333

334334
| | |
335335
|---|---|
336336
| `objecttype` | Object type (string) |
337337

338-
## Query String
338+
### Query String
339339

340340
| | |
341341
|---|---|
342342
| `token` | Session token acquired with [/api/v1/session](/en/technical/api/session) |
343343
| `confirm` | Confirmation code (see below "Transitions") |
344344
| `priority` | Priority for the indexer (integer): see "POST" above |
345345

346-
## Input
346+
### Input
347347

348348
An array of tuples `(ID, version[, comment])`. `comment` is optional and may be omitted.
349349

@@ -355,14 +355,14 @@ An array of tuples `(ID, version[, comment])`. `comment` is optional and may be
355355
]
356356

357357

358-
## Permissions
358+
### Permissions
359359

360360
The user needs the "delete" right for the requested objects (see [rights management](/en/technical/rightsmanagement)).
361361

362362
Transitions are also checked (see [transitions](/en/technical/transitions)). If
363363
transitions need confirmation, the `confirm` parameter should be provided.
364364

365-
## HTTP status codes
365+
### HTTP status codes
366366

367367
| | |
368368
|---|---|

0 commit comments

Comments
 (0)