diff --git a/site/content/3.11/develop/http-api/administration.md b/site/content/3.11/develop/http-api/administration.md index 359c0a2e17..667e06743d 100644 --- a/site/content/3.11/develop/http-api/administration.md +++ b/site/content/3.11/develop/http-api/administration.md @@ -22,8 +22,7 @@ paths: # Technically accepts all of the following methods: HEAD, GET, POST, PATCH, PUT, DELETE operationId: getVersion description: | - Returns the server name and version number. The response is a JSON object - with the following attributes: + Returns the server name and version number. parameters: - name: database-name in: path @@ -246,7 +245,6 @@ paths: operationId: getEngine description: | Returns the storage engine the server is configured to use. - The response is a JSON object with the following attributes: parameters: - name: database-name in: path @@ -329,12 +327,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 time: description: | The current system time as a Unix timestamp with microsecond precision of the server @@ -959,7 +959,7 @@ paths: in: query required: false description: | - Set to `true` to change the license even if it expires sooner than the current one. + Whether to change the license even if it expires sooner than the current one. schema: type: boolean default: false @@ -968,7 +968,7 @@ paths: application/json: schema: description: | - The request body has to contain the Base64-encoded string wrapped in double quotes. + The request body has to contain the Base64-encoded license string wrapped in double quotes. type: string example: eyJncmFudCI6...(Base64-encoded license string)... responses: @@ -995,7 +995,7 @@ paths: example: false code: description: | - The HTTP status code. + The HTTP response status code. type: integer example: 201 '400': @@ -1019,12 +1019,12 @@ paths: example: true code: description: | - The HTTP status code. + The HTTP response status code. type: integer example: 400 errorNum: description: | - The ArangoDB error number. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1050,12 +1050,12 @@ paths: example: true code: description: | - The HTTP status code. + The HTTP response status code. type: integer example: 501 errorNum: description: | - The ArangoDB error number. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.11/develop/http-api/authentication.md b/site/content/3.11/develop/http-api/authentication.md index 4b5fa15c36..99300238be 100644 --- a/site/content/3.11/develop/http-api/authentication.md +++ b/site/content/3.11/develop/http-api/authentication.md @@ -90,7 +90,8 @@ If you use a tool like cURL, you can manually specify this header as follows: curl -H 'Authorization: Basic dXNlcjpwYXNz' ... ``` -However, cURL can also take care of the authentication for you: +However, cURL can also take care of the authentication and specifically the +encoding of the credentials for you: ``` curl -u user:pass ... @@ -114,19 +115,19 @@ For more information on JWT please consult RFC7519 and [jwt.io](https://jwt.io). ### JWT user tokens -To authenticate with a specific user you need to supply a JWT token containing -the `preferred_username` field with the username. +To authenticate with a specific user account, you need to supply a JWT token +containing the `preferred_username` field with the username. You can either let ArangoDB generate this token for you via an API call or you can generate it yourself (only if you know the JWT secret). ArangoDB offers a RESTful API to generate user tokens for you if you know the -username and password. To do so send a POST request to: +username and password. To do so, send a POST request to this endpoint: ``` /_open/auth ``` -… containing `username` and `password` JSON-encoded like so: +The request body needs to contain the `username` and `password` JSON-encoded like so: ```json { @@ -203,7 +204,8 @@ paths: type: string responses: '200': - description: '' + description: | + Successfully created a session token. content: application/json: schema: @@ -304,7 +306,8 @@ paths: type: string responses: '200': - description: '' + description: | + Successfully retrieved the JWT secret information. content: application/json: schema: @@ -318,12 +321,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code - 200 in this case + The HTTP response status code. type: integer + example: 200 result: description: | The result object. @@ -370,7 +375,8 @@ paths: will be _HTTP 403 Forbidden_. responses: '200': - description: '' + description: | + Successfully reloaded the JWT secrets. content: application/json: schema: @@ -384,12 +390,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code - 200 in this case + The HTTP response status code. type: integer + example: 200 result: description: | The result object. diff --git a/site/content/3.11/develop/http-api/cluster.md b/site/content/3.11/develop/http-api/cluster.md index d40ac42208..5e1e3f472f 100644 --- a/site/content/3.11/develop/http-api/cluster.md +++ b/site/content/3.11/develop/http-api/cluster.md @@ -121,12 +121,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code - 200 + The HTTP response status code. type: integer + example: 200 endpoints: description: | A list of active cluster endpoints. @@ -196,15 +198,17 @@ paths: properties: error: description: | - always `false` + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code, always 200 + The HTTP response status code. type: integer + example: 200 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer role: description: | @@ -302,12 +306,14 @@ paths: properties: error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The status code. `200` in this case. + The HTTP response status code. type: integer + example: 200 result: description: | The result object with the status. This attribute is omitted if the DB-Server @@ -395,8 +401,9 @@ paths: properties: error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false code: description: | The status code. `200` in this case. @@ -659,12 +666,14 @@ paths: properties: code: description: | - The status code. - type: number + The HTTP response status code. + type: integer + example: 200 error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false result: description: | The result object. @@ -866,12 +875,14 @@ paths: properties: code: description: | - The status code. - type: number + The HTTP response status code. + type: integer + example: 200 error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false result: description: | The result object. @@ -1283,12 +1294,14 @@ paths: properties: code: description: | - The status code. - type: number + The HTTP response status code. + type: integer + example: 200 error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false result: description: | The result object. diff --git a/site/content/3.11/develop/http-api/collections.md b/site/content/3.11/develop/http-api/collections.md index 2b61e085fa..5cbb954377 100644 --- a/site/content/3.11/develop/http-api/collections.md +++ b/site/content/3.11/develop/http-api/collections.md @@ -631,7 +631,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -662,7 +662,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1560,7 +1560,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1591,7 +1591,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1742,7 +1742,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1773,7 +1773,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1804,7 +1804,7 @@ paths: example: 501 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2233,7 +2233,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2264,7 +2264,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2295,7 +2295,7 @@ paths: example: 501 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2707,7 +2707,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2738,7 +2738,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -3249,7 +3249,7 @@ paths: up-to-date copies succeed at the same time, however. The value of `writeConcern` cannot be greater than `replicationFactor`. - If `distributeShardsLike` is set, the `writeConcern` + Default: If `distributeShardsLike` is set, the default `writeConcern` is that of the prototype collection. For SatelliteCollections, the `writeConcern` is automatically controlled to equal the number of DB-Servers and has a value of `0`. @@ -3670,7 +3670,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -3827,7 +3827,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -3858,7 +3858,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4036,7 +4036,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4071,7 +4071,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4103,7 +4103,7 @@ paths: example: 410 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4630,7 +4630,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4661,7 +4661,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4794,7 +4794,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4825,7 +4825,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5232,7 +5232,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5263,7 +5263,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5377,7 +5377,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5408,7 +5408,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5540,7 +5540,7 @@ paths: example: 401 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5700,7 +5700,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5731,7 +5731,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5887,7 +5887,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5918,7 +5918,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.11/develop/http-api/general-request-handling.md b/site/content/3.11/develop/http-api/general-request-handling.md index cfb4424e95..c2c80dbe89 100644 --- a/site/content/3.11/develop/http-api/general-request-handling.md +++ b/site/content/3.11/develop/http-api/general-request-handling.md @@ -225,7 +225,7 @@ cancel them as well. ##### Async execution and authentication If a request requires authentication, the authentication procedure is run before -queueing. The request is only queued if the authentication is successful. If the +queueing. The request is only queued if the authentication is successful. Otherwise, it is not queued but rejected instantly in the same way as a regular, non-queued request. diff --git a/site/content/3.11/develop/http-api/graphs/edges.md b/site/content/3.11/develop/http-api/graphs/edges.md index 7daeaca862..16d3164081 100644 --- a/site/content/3.11/develop/http-api/graphs/edges.md +++ b/site/content/3.11/develop/http-api/graphs/edges.md @@ -55,7 +55,7 @@ paths: in: query required: true description: | - The id of the start vertex. + The document identifier of the start vertex. schema: type: string - name: direction diff --git a/site/content/3.11/develop/http-api/graphs/named-graphs.md b/site/content/3.11/develop/http-api/graphs/named-graphs.md index 33f206e46a..39a8fc252c 100644 --- a/site/content/3.11/develop/http-api/graphs/named-graphs.md +++ b/site/content/3.11/develop/http-api/graphs/named-graphs.md @@ -321,6 +321,7 @@ paths: The number of shards that is used for every collection within this graph. Cannot be modified later. type: integer + default: 1 replicationFactor: description: | The replication factor used when initially creating collections for this graph. diff --git a/site/content/3.11/develop/http-api/monitoring/statistics.md b/site/content/3.11/develop/http-api/monitoring/statistics.md index 8e61972a09..f74b5d5163 100644 --- a/site/content/3.11/develop/http-api/monitoring/statistics.md +++ b/site/content/3.11/develop/http-api/monitoring/statistics.md @@ -75,19 +75,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code - 200 in this case + The HTTP response status code. type: integer + example: 200 time: description: | the current server timestamp type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string enabled: description: | @@ -660,8 +662,9 @@ paths: type: string code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 error: description: | the error, `false` in this case diff --git a/site/content/3.11/develop/http-api/queries/aql-queries.md b/site/content/3.11/develop/http-api/queries/aql-queries.md index b05eb9f6e1..bfef9df1a0 100644 --- a/site/content/3.11/develop/http-api/queries/aql-queries.md +++ b/site/content/3.11/develop/http-api/queries/aql-queries.md @@ -662,6 +662,7 @@ paths: This feature is only available in the Enterprise Edition. type: boolean + default: false allowDirtyReads: description: | If you set this option to `true` and execute the query against a cluster @@ -697,12 +698,14 @@ paths: properties: error: description: | - A flag to indicate that an error occurred (`false` in this case). + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The HTTP status code. + The HTTP response status code. type: integer + example: 201 result: description: | An array of result documents for the current batch @@ -1039,15 +1042,17 @@ paths: properties: error: description: | - boolean flag to indicate that an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 400 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1428,12 +1433,14 @@ paths: properties: error: description: | - A flag to indicate that an error occurred (`false` in this case). + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The HTTP status code. + The HTTP response status code. type: integer + example: 200 result: description: | An array of result documents for the current batch @@ -2041,12 +2048,14 @@ paths: properties: error: description: | - A flag to indicate that an error occurred (`false` in this case). + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The HTTP status code. + The HTTP response status code. type: integer + example: 200 result: description: | An array of result documents for the current batch @@ -2379,19 +2388,21 @@ paths: properties: error: description: | - A flag to indicate that an error occurred (`false` in this case). + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The HTTP status code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | - A server error number (if `error` is `true`). + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A descriptive error message (if `error` is `true`). + A descriptive error message. type: string '404': description: | diff --git a/site/content/3.11/develop/http-api/queries/user-defined-aql-functions.md b/site/content/3.11/develop/http-api/queries/user-defined-aql-functions.md index 25f9b271c1..4fc911e2d1 100644 --- a/site/content/3.11/develop/http-api/queries/user-defined-aql-functions.md +++ b/site/content/3.11/develop/http-api/queries/user-defined-aql-functions.md @@ -82,12 +82,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 isNewlyCreated: description: | boolean flag to indicate whether the function was newly created (`false` in this case) @@ -107,12 +109,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 201 isNewlyCreated: description: | boolean flag to indicate whether the function was newly created (`true` in this case) @@ -133,19 +137,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 400 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string tags: - Queries @@ -227,12 +233,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 deletedCount: description: | The number of deleted user functions, always `1` when `group` is set to `false`. @@ -253,19 +261,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 400 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string '404': description: | @@ -282,19 +292,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 404 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string tags: - Queries @@ -380,12 +392,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 result: description: | All functions, or the ones matching the `namespace` parameter @@ -430,19 +444,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 400 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string tags: - Queries diff --git a/site/content/3.11/develop/http-api/security.md b/site/content/3.11/develop/http-api/security.md index 4d26d60182..628f38312c 100644 --- a/site/content/3.11/develop/http-api/security.md +++ b/site/content/3.11/develop/http-api/security.md @@ -127,12 +127,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code - 200 in this case + The HTTP response status code. type: integer + example: 200 result: description: | The result object. diff --git a/site/content/3.11/develop/http-api/tasks.md b/site/content/3.11/develop/http-api/tasks.md index 63056e0ea3..251b615bee 100644 --- a/site/content/3.11/develop/http-api/tasks.md +++ b/site/content/3.11/develop/http-api/tasks.md @@ -14,7 +14,7 @@ paths: get: operationId: listTasks description: | - fetches all existing tasks on the server + Fetches all existing tasks on the server. parameters: - name: database-name in: path @@ -29,12 +29,12 @@ paths: responses: '200': description: | - The list of tasks + The list of tasks. content: application/json: schema: description: | - a list of all tasks + A list of all tasks. type: array items: type: object @@ -133,12 +133,12 @@ paths: responses: '200': description: | - The requested task + The requested task. content: application/json: schema: description: | - The function in question + The function in question. type: object required: - name @@ -541,8 +541,9 @@ paths: properties: code: description: | - The status code, 200 in this case. - type: number + The HTTP response status code. + type: integer + example: 200 error: description: | `false` in this case @@ -561,15 +562,17 @@ paths: properties: code: description: | - The status code, 404 in this case. - type: number + The HTTP response status code. + type: integer + example: 404 error: description: | - `true` in this case + A flag indicating that an error occurred. type: boolean + example: true errorMessage: description: | - A plain text message stating what went wrong. + A descriptive error message. type: string tags: - Tasks diff --git a/site/content/3.11/develop/http-api/views/arangosearch-views.md b/site/content/3.11/develop/http-api/views/arangosearch-views.md index 75686d8131..b8958aa29c 100644 --- a/site/content/3.11/develop/http-api/views/arangosearch-views.md +++ b/site/content/3.11/develop/http-api/views/arangosearch-views.md @@ -43,6 +43,7 @@ paths: The type of the View. Must be equal to `"arangosearch"`. This option is immutable. type: string + example: arangosearch links: description: | Expects an object with the attribute keys being names of to be linked collections, @@ -407,7 +408,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -603,7 +604,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -634,7 +635,7 @@ paths: example: 409 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -722,7 +723,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -757,7 +758,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -874,7 +875,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -1070,7 +1071,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1101,7 +1102,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1471,7 +1472,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -1667,7 +1668,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1698,7 +1699,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1974,7 +1975,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -2170,7 +2171,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2201,7 +2202,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2336,7 +2337,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -2532,7 +2533,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2563,7 +2564,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2668,7 +2669,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2699,7 +2700,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.11/develop/http-api/views/search-alias-views.md b/site/content/3.11/develop/http-api/views/search-alias-views.md index 9ac1ae3fdf..57c6ec5b85 100644 --- a/site/content/3.11/develop/http-api/views/search-alias-views.md +++ b/site/content/3.11/develop/http-api/views/search-alias-views.md @@ -43,6 +43,7 @@ paths: The type of the View. Must be equal to `"search-alias"`. This option is immutable. type: string + example: search-alias indexes: description: | A list of inverted indexes to add to the View. @@ -85,6 +86,7 @@ paths: description: | The type of the View (`"search-alias"`). type: string + example: search-alias id: description: | A unique identifier of the View (deprecated). @@ -138,7 +140,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -169,7 +171,7 @@ paths: example: 409 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -264,7 +266,7 @@ paths: type: description: | The type of the View (`"search-alias"`). - type: integer + type: string example: search-alias id: description: | @@ -299,7 +301,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -393,6 +395,7 @@ paths: description: | The type of the View (`"search-alias"`). type: string + example: search-alias id: description: | A unique identifier of the View (deprecated). @@ -444,7 +447,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -475,7 +478,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -745,7 +748,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -776,7 +779,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -940,7 +943,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -971,7 +974,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1121,7 +1124,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1152,7 +1155,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1257,7 +1260,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1288,7 +1291,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.12/develop/http-api/administration.md b/site/content/3.12/develop/http-api/administration.md index d062379748..57effdb398 100644 --- a/site/content/3.12/develop/http-api/administration.md +++ b/site/content/3.12/develop/http-api/administration.md @@ -327,12 +327,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 time: description: | The current system time as a Unix timestamp with microsecond precision of the server @@ -1151,7 +1153,7 @@ paths: example: false code: description: | - The HTTP status code. + The HTTP response status code. type: integer example: 201 '400': @@ -1175,12 +1177,12 @@ paths: example: true code: description: | - The HTTP status code. + The HTTP response status code. type: integer example: 400 errorNum: description: | - The ArangoDB error number. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1206,12 +1208,12 @@ paths: example: true code: description: | - The HTTP status code. + The HTTP response status code. type: integer example: 501 errorNum: description: | - The ArangoDB error number. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.12/develop/http-api/authentication.md b/site/content/3.12/develop/http-api/authentication.md index e8cfc2f67d..dcae69cdcb 100644 --- a/site/content/3.12/develop/http-api/authentication.md +++ b/site/content/3.12/develop/http-api/authentication.md @@ -226,7 +226,8 @@ paths: type: string responses: '200': - description: '' + description: | + Successfully created a session token. content: application/json: schema: @@ -431,7 +432,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -462,7 +463,7 @@ paths: example: 401 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -494,7 +495,7 @@ paths: example: 403 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -525,7 +526,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -556,7 +557,7 @@ paths: example: 409 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -691,7 +692,7 @@ paths: example: 401 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -723,7 +724,7 @@ paths: example: 403 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -754,7 +755,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -843,7 +844,7 @@ paths: example: 401 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -875,7 +876,7 @@ paths: example: 403 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -906,7 +907,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -971,7 +972,8 @@ paths: type: string responses: '200': - description: '' + description: | + Successfully retrieved the JWT secret information. content: application/json: schema: @@ -985,12 +987,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code - 200 in this case + The HTTP response status code. type: integer + example: 200 result: description: | The result object. @@ -1037,7 +1041,8 @@ paths: will be _HTTP 403 Forbidden_. responses: '200': - description: '' + description: | + Successfully reloaded the JWT secrets. content: application/json: schema: @@ -1051,12 +1056,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code - 200 in this case + The HTTP response status code. type: integer + example: 200 result: description: | The result object. diff --git a/site/content/3.12/develop/http-api/cluster.md b/site/content/3.12/develop/http-api/cluster.md index 09d7ec5a05..3bce2b5cc5 100644 --- a/site/content/3.12/develop/http-api/cluster.md +++ b/site/content/3.12/develop/http-api/cluster.md @@ -121,12 +121,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code - 200 + The HTTP response status code. type: integer + example: 200 endpoints: description: | A list of active cluster endpoints. @@ -196,15 +198,17 @@ paths: properties: error: description: | - always `false` + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code, always 200 + The HTTP response status code. type: integer + example: 200 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer role: description: | @@ -302,12 +306,14 @@ paths: properties: error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The status code. `200` in this case. + The HTTP response status code. type: integer + example: 200 result: description: | The result object with the status. This attribute is omitted if the DB-Server @@ -395,8 +401,9 @@ paths: properties: error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false code: description: | The status code. `200` in this case. @@ -659,12 +666,14 @@ paths: properties: code: description: | - The status code. - type: number + The HTTP response status code. + type: integer + example: 200 error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false result: description: | The result object. @@ -866,12 +875,14 @@ paths: properties: code: description: | - The status code. - type: number + The HTTP response status code. + type: integer + example: 200 error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false result: description: | The result object. @@ -1283,12 +1294,14 @@ paths: properties: code: description: | - The status code. - type: number + The HTTP response status code. + type: integer + example: 200 error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false result: description: | The result object. diff --git a/site/content/3.12/develop/http-api/collections.md b/site/content/3.12/develop/http-api/collections.md index 68348bbc07..1f24111624 100644 --- a/site/content/3.12/develop/http-api/collections.md +++ b/site/content/3.12/develop/http-api/collections.md @@ -631,7 +631,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -662,7 +662,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1560,7 +1560,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1591,7 +1591,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1742,7 +1742,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1773,7 +1773,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1804,7 +1804,7 @@ paths: example: 501 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2233,7 +2233,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2264,7 +2264,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2295,7 +2295,7 @@ paths: example: 501 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2707,7 +2707,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2738,7 +2738,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -3724,7 +3724,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -3881,7 +3881,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -3912,7 +3912,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4090,7 +4090,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4125,7 +4125,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4157,7 +4157,7 @@ paths: example: 410 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4683,7 +4683,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4714,7 +4714,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4847,7 +4847,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4878,7 +4878,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5285,7 +5285,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5316,7 +5316,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5430,7 +5430,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5461,7 +5461,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5593,7 +5593,7 @@ paths: example: 401 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5753,7 +5753,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5784,7 +5784,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5940,7 +5940,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5971,7 +5971,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.12/develop/http-api/general-request-handling.md b/site/content/3.12/develop/http-api/general-request-handling.md index 2bd751c2ce..ba2d9d7eb7 100644 --- a/site/content/3.12/develop/http-api/general-request-handling.md +++ b/site/content/3.12/develop/http-api/general-request-handling.md @@ -206,7 +206,7 @@ cancel them as well. ##### Async execution and authentication If a request requires authentication, the authentication procedure is run before -queueing. The request is only queued if the authentication is successful. If the +queueing. The request is only queued if the authentication is successful. Otherwise, it is not queued but rejected instantly in the same way as a regular, non-queued request. diff --git a/site/content/3.12/develop/http-api/monitoring/logs.md b/site/content/3.12/develop/http-api/monitoring/logs.md index 6e3d30c006..d68f1b6eeb 100644 --- a/site/content/3.12/develop/http-api/monitoring/logs.md +++ b/site/content/3.12/develop/http-api/monitoring/logs.md @@ -958,7 +958,7 @@ paths: example: 401 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -989,7 +989,7 @@ paths: example: 403 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1020,7 +1020,7 @@ paths: example: 501 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.12/develop/http-api/monitoring/statistics.md b/site/content/3.12/develop/http-api/monitoring/statistics.md index 8e61972a09..f74b5d5163 100644 --- a/site/content/3.12/develop/http-api/monitoring/statistics.md +++ b/site/content/3.12/develop/http-api/monitoring/statistics.md @@ -75,19 +75,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code - 200 in this case + The HTTP response status code. type: integer + example: 200 time: description: | the current server timestamp type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string enabled: description: | @@ -660,8 +662,9 @@ paths: type: string code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 error: description: | the error, `false` in this case diff --git a/site/content/3.12/develop/http-api/queries/aql-queries.md b/site/content/3.12/develop/http-api/queries/aql-queries.md index 75fae9b88d..8977088370 100644 --- a/site/content/3.12/develop/http-api/queries/aql-queries.md +++ b/site/content/3.12/develop/http-api/queries/aql-queries.md @@ -706,12 +706,14 @@ paths: properties: error: description: | - A flag to indicate that an error occurred (`false` in this case). + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The HTTP status code. + The HTTP response status code. type: integer + example: 201 result: description: | An array of result documents for the current batch @@ -1067,15 +1069,17 @@ paths: properties: error: description: | - boolean flag to indicate that an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 400 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1459,12 +1463,14 @@ paths: properties: error: description: | - A flag to indicate that an error occurred (`false` in this case). + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The HTTP status code. + The HTTP response status code. type: integer + example: 200 result: description: | An array of result documents for the current batch @@ -2096,12 +2102,14 @@ paths: properties: error: description: | - A flag to indicate that an error occurred (`false` in this case). + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The HTTP status code. + The HTTP response status code. type: integer + example: 200 result: description: | An array of result documents for the current batch @@ -2453,19 +2461,21 @@ paths: properties: error: description: | - A flag to indicate that an error occurred (`false` in this case). + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The HTTP status code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | - A server error number (if `error` is `true`). + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A descriptive error message (if `error` is `true`). + A descriptive error message. type: string '404': description: | diff --git a/site/content/3.12/develop/http-api/queries/user-defined-aql-functions.md b/site/content/3.12/develop/http-api/queries/user-defined-aql-functions.md index 25f9b271c1..4fc911e2d1 100644 --- a/site/content/3.12/develop/http-api/queries/user-defined-aql-functions.md +++ b/site/content/3.12/develop/http-api/queries/user-defined-aql-functions.md @@ -82,12 +82,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 isNewlyCreated: description: | boolean flag to indicate whether the function was newly created (`false` in this case) @@ -107,12 +109,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 201 isNewlyCreated: description: | boolean flag to indicate whether the function was newly created (`true` in this case) @@ -133,19 +137,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 400 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string tags: - Queries @@ -227,12 +233,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 deletedCount: description: | The number of deleted user functions, always `1` when `group` is set to `false`. @@ -253,19 +261,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 400 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string '404': description: | @@ -282,19 +292,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 404 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string tags: - Queries @@ -380,12 +392,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 result: description: | All functions, or the ones matching the `namespace` parameter @@ -430,19 +444,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 400 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string tags: - Queries diff --git a/site/content/3.12/develop/http-api/security.md b/site/content/3.12/develop/http-api/security.md index 4d26d60182..628f38312c 100644 --- a/site/content/3.12/develop/http-api/security.md +++ b/site/content/3.12/develop/http-api/security.md @@ -127,12 +127,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code - 200 in this case + The HTTP response status code. type: integer + example: 200 result: description: | The result object. diff --git a/site/content/3.12/develop/http-api/tasks.md b/site/content/3.12/develop/http-api/tasks.md index 63056e0ea3..251b615bee 100644 --- a/site/content/3.12/develop/http-api/tasks.md +++ b/site/content/3.12/develop/http-api/tasks.md @@ -14,7 +14,7 @@ paths: get: operationId: listTasks description: | - fetches all existing tasks on the server + Fetches all existing tasks on the server. parameters: - name: database-name in: path @@ -29,12 +29,12 @@ paths: responses: '200': description: | - The list of tasks + The list of tasks. content: application/json: schema: description: | - a list of all tasks + A list of all tasks. type: array items: type: object @@ -133,12 +133,12 @@ paths: responses: '200': description: | - The requested task + The requested task. content: application/json: schema: description: | - The function in question + The function in question. type: object required: - name @@ -541,8 +541,9 @@ paths: properties: code: description: | - The status code, 200 in this case. - type: number + The HTTP response status code. + type: integer + example: 200 error: description: | `false` in this case @@ -561,15 +562,17 @@ paths: properties: code: description: | - The status code, 404 in this case. - type: number + The HTTP response status code. + type: integer + example: 404 error: description: | - `true` in this case + A flag indicating that an error occurred. type: boolean + example: true errorMessage: description: | - A plain text message stating what went wrong. + A descriptive error message. type: string tags: - Tasks diff --git a/site/content/3.12/develop/http-api/views/arangosearch-views.md b/site/content/3.12/develop/http-api/views/arangosearch-views.md index f585052364..b2a1d58607 100644 --- a/site/content/3.12/develop/http-api/views/arangosearch-views.md +++ b/site/content/3.12/develop/http-api/views/arangosearch-views.md @@ -43,6 +43,7 @@ paths: The type of the View. Must be equal to `"arangosearch"`. This option is immutable. type: string + example: arangosearch links: description: | Expects an object with the attribute keys being names of to be linked collections, @@ -431,7 +432,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -631,7 +632,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -662,7 +663,7 @@ paths: example: 409 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -750,7 +751,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -785,7 +786,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -903,7 +904,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -1103,7 +1104,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1134,7 +1135,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1505,7 +1506,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -1705,7 +1706,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1736,7 +1737,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2013,7 +2014,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -2213,7 +2214,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2244,7 +2245,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2380,7 +2381,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -2580,7 +2581,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2611,7 +2612,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2716,7 +2717,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2747,7 +2748,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.12/develop/http-api/views/search-alias-views.md b/site/content/3.12/develop/http-api/views/search-alias-views.md index 9ac1ae3fdf..57c6ec5b85 100644 --- a/site/content/3.12/develop/http-api/views/search-alias-views.md +++ b/site/content/3.12/develop/http-api/views/search-alias-views.md @@ -43,6 +43,7 @@ paths: The type of the View. Must be equal to `"search-alias"`. This option is immutable. type: string + example: search-alias indexes: description: | A list of inverted indexes to add to the View. @@ -85,6 +86,7 @@ paths: description: | The type of the View (`"search-alias"`). type: string + example: search-alias id: description: | A unique identifier of the View (deprecated). @@ -138,7 +140,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -169,7 +171,7 @@ paths: example: 409 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -264,7 +266,7 @@ paths: type: description: | The type of the View (`"search-alias"`). - type: integer + type: string example: search-alias id: description: | @@ -299,7 +301,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -393,6 +395,7 @@ paths: description: | The type of the View (`"search-alias"`). type: string + example: search-alias id: description: | A unique identifier of the View (deprecated). @@ -444,7 +447,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -475,7 +478,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -745,7 +748,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -776,7 +779,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -940,7 +943,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -971,7 +974,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1121,7 +1124,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1152,7 +1155,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1257,7 +1260,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1288,7 +1291,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.13/develop/http-api/administration.md b/site/content/3.13/develop/http-api/administration.md index d062379748..57effdb398 100644 --- a/site/content/3.13/develop/http-api/administration.md +++ b/site/content/3.13/develop/http-api/administration.md @@ -327,12 +327,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 time: description: | The current system time as a Unix timestamp with microsecond precision of the server @@ -1151,7 +1153,7 @@ paths: example: false code: description: | - The HTTP status code. + The HTTP response status code. type: integer example: 201 '400': @@ -1175,12 +1177,12 @@ paths: example: true code: description: | - The HTTP status code. + The HTTP response status code. type: integer example: 400 errorNum: description: | - The ArangoDB error number. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1206,12 +1208,12 @@ paths: example: true code: description: | - The HTTP status code. + The HTTP response status code. type: integer example: 501 errorNum: description: | - The ArangoDB error number. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.13/develop/http-api/authentication.md b/site/content/3.13/develop/http-api/authentication.md index e8cfc2f67d..dcae69cdcb 100644 --- a/site/content/3.13/develop/http-api/authentication.md +++ b/site/content/3.13/develop/http-api/authentication.md @@ -226,7 +226,8 @@ paths: type: string responses: '200': - description: '' + description: | + Successfully created a session token. content: application/json: schema: @@ -431,7 +432,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -462,7 +463,7 @@ paths: example: 401 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -494,7 +495,7 @@ paths: example: 403 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -525,7 +526,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -556,7 +557,7 @@ paths: example: 409 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -691,7 +692,7 @@ paths: example: 401 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -723,7 +724,7 @@ paths: example: 403 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -754,7 +755,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -843,7 +844,7 @@ paths: example: 401 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -875,7 +876,7 @@ paths: example: 403 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -906,7 +907,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -971,7 +972,8 @@ paths: type: string responses: '200': - description: '' + description: | + Successfully retrieved the JWT secret information. content: application/json: schema: @@ -985,12 +987,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code - 200 in this case + The HTTP response status code. type: integer + example: 200 result: description: | The result object. @@ -1037,7 +1041,8 @@ paths: will be _HTTP 403 Forbidden_. responses: '200': - description: '' + description: | + Successfully reloaded the JWT secrets. content: application/json: schema: @@ -1051,12 +1056,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code - 200 in this case + The HTTP response status code. type: integer + example: 200 result: description: | The result object. diff --git a/site/content/3.13/develop/http-api/cluster.md b/site/content/3.13/develop/http-api/cluster.md index 09d7ec5a05..3bce2b5cc5 100644 --- a/site/content/3.13/develop/http-api/cluster.md +++ b/site/content/3.13/develop/http-api/cluster.md @@ -121,12 +121,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code - 200 + The HTTP response status code. type: integer + example: 200 endpoints: description: | A list of active cluster endpoints. @@ -196,15 +198,17 @@ paths: properties: error: description: | - always `false` + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code, always 200 + The HTTP response status code. type: integer + example: 200 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer role: description: | @@ -302,12 +306,14 @@ paths: properties: error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The status code. `200` in this case. + The HTTP response status code. type: integer + example: 200 result: description: | The result object with the status. This attribute is omitted if the DB-Server @@ -395,8 +401,9 @@ paths: properties: error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false code: description: | The status code. `200` in this case. @@ -659,12 +666,14 @@ paths: properties: code: description: | - The status code. - type: number + The HTTP response status code. + type: integer + example: 200 error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false result: description: | The result object. @@ -866,12 +875,14 @@ paths: properties: code: description: | - The status code. - type: number + The HTTP response status code. + type: integer + example: 200 error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false result: description: | The result object. @@ -1283,12 +1294,14 @@ paths: properties: code: description: | - The status code. - type: number + The HTTP response status code. + type: integer + example: 200 error: description: | - Whether an error occurred. `false` in this case. + A flag indicating that no error occurred. type: boolean + example: false result: description: | The result object. diff --git a/site/content/3.13/develop/http-api/collections.md b/site/content/3.13/develop/http-api/collections.md index 4868e07d79..658b894615 100644 --- a/site/content/3.13/develop/http-api/collections.md +++ b/site/content/3.13/develop/http-api/collections.md @@ -615,7 +615,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -646,7 +646,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1512,7 +1512,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1543,7 +1543,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1694,7 +1694,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1725,7 +1725,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1756,7 +1756,7 @@ paths: example: 501 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2169,7 +2169,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2200,7 +2200,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2231,7 +2231,7 @@ paths: example: 501 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2627,7 +2627,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2658,7 +2658,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -3628,7 +3628,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -3785,7 +3785,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -3816,7 +3816,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -3994,7 +3994,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4029,7 +4029,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4061,7 +4061,7 @@ paths: example: 410 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4571,7 +4571,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4602,7 +4602,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4735,7 +4735,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -4766,7 +4766,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5157,7 +5157,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5188,7 +5188,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5302,7 +5302,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5333,7 +5333,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -5465,7 +5465,7 @@ paths: example: 401 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.13/develop/http-api/general-request-handling.md b/site/content/3.13/develop/http-api/general-request-handling.md index 2bd751c2ce..ba2d9d7eb7 100644 --- a/site/content/3.13/develop/http-api/general-request-handling.md +++ b/site/content/3.13/develop/http-api/general-request-handling.md @@ -206,7 +206,7 @@ cancel them as well. ##### Async execution and authentication If a request requires authentication, the authentication procedure is run before -queueing. The request is only queued if the authentication is successful. If the +queueing. The request is only queued if the authentication is successful. Otherwise, it is not queued but rejected instantly in the same way as a regular, non-queued request. diff --git a/site/content/3.13/develop/http-api/monitoring/logs.md b/site/content/3.13/develop/http-api/monitoring/logs.md index 6e3d30c006..d68f1b6eeb 100644 --- a/site/content/3.13/develop/http-api/monitoring/logs.md +++ b/site/content/3.13/develop/http-api/monitoring/logs.md @@ -958,7 +958,7 @@ paths: example: 401 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -989,7 +989,7 @@ paths: example: 403 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1020,7 +1020,7 @@ paths: example: 501 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.13/develop/http-api/monitoring/statistics.md b/site/content/3.13/develop/http-api/monitoring/statistics.md index 8e61972a09..f74b5d5163 100644 --- a/site/content/3.13/develop/http-api/monitoring/statistics.md +++ b/site/content/3.13/develop/http-api/monitoring/statistics.md @@ -75,19 +75,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code - 200 in this case + The HTTP response status code. type: integer + example: 200 time: description: | the current server timestamp type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string enabled: description: | @@ -660,8 +662,9 @@ paths: type: string code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 error: description: | the error, `false` in this case diff --git a/site/content/3.13/develop/http-api/queries/aql-queries.md b/site/content/3.13/develop/http-api/queries/aql-queries.md index 829fbe2526..2d1e9ea6cc 100644 --- a/site/content/3.13/develop/http-api/queries/aql-queries.md +++ b/site/content/3.13/develop/http-api/queries/aql-queries.md @@ -708,12 +708,14 @@ paths: properties: error: description: | - A flag to indicate that an error occurred (`false` in this case). + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The HTTP status code. + The HTTP response status code. type: integer + example: 201 result: description: | An array of result documents for the current batch @@ -1069,15 +1071,17 @@ paths: properties: error: description: | - boolean flag to indicate that an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 400 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1461,12 +1465,14 @@ paths: properties: error: description: | - A flag to indicate that an error occurred (`false` in this case). + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The HTTP status code. + The HTTP response status code. type: integer + example: 200 result: description: | An array of result documents for the current batch @@ -1961,12 +1967,14 @@ paths: properties: error: description: | - A flag to indicate that an error occurred (`false` in this case). + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The HTTP status code. + The HTTP response status code. type: integer + example: 200 result: description: | An array of result documents for the current batch @@ -2318,19 +2326,21 @@ paths: properties: error: description: | - A flag to indicate that an error occurred (`false` in this case). + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The HTTP status code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | - A server error number (if `error` is `true`). + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A descriptive error message (if `error` is `true`). + A descriptive error message. type: string '404': description: | diff --git a/site/content/3.13/develop/http-api/queries/user-defined-aql-functions.md b/site/content/3.13/develop/http-api/queries/user-defined-aql-functions.md index 25f9b271c1..4fc911e2d1 100644 --- a/site/content/3.13/develop/http-api/queries/user-defined-aql-functions.md +++ b/site/content/3.13/develop/http-api/queries/user-defined-aql-functions.md @@ -82,12 +82,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 isNewlyCreated: description: | boolean flag to indicate whether the function was newly created (`false` in this case) @@ -107,12 +109,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 201 isNewlyCreated: description: | boolean flag to indicate whether the function was newly created (`true` in this case) @@ -133,19 +137,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 400 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string tags: - Queries @@ -227,12 +233,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 deletedCount: description: | The number of deleted user functions, always `1` when `group` is set to `false`. @@ -253,19 +261,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 400 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string '404': description: | @@ -282,19 +292,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 404 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string tags: - Queries @@ -380,12 +392,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 200 result: description: | All functions, or the ones matching the `namespace` parameter @@ -430,19 +444,21 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`true` in this case) + A flag indicating that an error occurred. type: boolean + example: true code: description: | - the HTTP status code + The HTTP response status code. type: integer + example: 400 errorNum: description: | - the server error number + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - a descriptive error message + A descriptive error message. type: string tags: - Queries diff --git a/site/content/3.13/develop/http-api/security.md b/site/content/3.13/develop/http-api/security.md index 4d26d60182..628f38312c 100644 --- a/site/content/3.13/develop/http-api/security.md +++ b/site/content/3.13/develop/http-api/security.md @@ -127,12 +127,14 @@ paths: properties: error: description: | - boolean flag to indicate whether an error occurred (`false` in this case) + A flag indicating that no error occurred. type: boolean + example: false code: description: | - the HTTP status code - 200 in this case + The HTTP response status code. type: integer + example: 200 result: description: | The result object. diff --git a/site/content/3.13/develop/http-api/tasks.md b/site/content/3.13/develop/http-api/tasks.md index 63056e0ea3..251b615bee 100644 --- a/site/content/3.13/develop/http-api/tasks.md +++ b/site/content/3.13/develop/http-api/tasks.md @@ -14,7 +14,7 @@ paths: get: operationId: listTasks description: | - fetches all existing tasks on the server + Fetches all existing tasks on the server. parameters: - name: database-name in: path @@ -29,12 +29,12 @@ paths: responses: '200': description: | - The list of tasks + The list of tasks. content: application/json: schema: description: | - a list of all tasks + A list of all tasks. type: array items: type: object @@ -133,12 +133,12 @@ paths: responses: '200': description: | - The requested task + The requested task. content: application/json: schema: description: | - The function in question + The function in question. type: object required: - name @@ -541,8 +541,9 @@ paths: properties: code: description: | - The status code, 200 in this case. - type: number + The HTTP response status code. + type: integer + example: 200 error: description: | `false` in this case @@ -561,15 +562,17 @@ paths: properties: code: description: | - The status code, 404 in this case. - type: number + The HTTP response status code. + type: integer + example: 404 error: description: | - `true` in this case + A flag indicating that an error occurred. type: boolean + example: true errorMessage: description: | - A plain text message stating what went wrong. + A descriptive error message. type: string tags: - Tasks diff --git a/site/content/3.13/develop/http-api/views/arangosearch-views.md b/site/content/3.13/develop/http-api/views/arangosearch-views.md index f585052364..b2a1d58607 100644 --- a/site/content/3.13/develop/http-api/views/arangosearch-views.md +++ b/site/content/3.13/develop/http-api/views/arangosearch-views.md @@ -43,6 +43,7 @@ paths: The type of the View. Must be equal to `"arangosearch"`. This option is immutable. type: string + example: arangosearch links: description: | Expects an object with the attribute keys being names of to be linked collections, @@ -431,7 +432,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -631,7 +632,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -662,7 +663,7 @@ paths: example: 409 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -750,7 +751,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -785,7 +786,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -903,7 +904,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -1103,7 +1104,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1134,7 +1135,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1505,7 +1506,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -1705,7 +1706,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1736,7 +1737,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2013,7 +2014,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -2213,7 +2214,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2244,7 +2245,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2380,7 +2381,7 @@ paths: type: description: | The type of the View (`"arangosearch"`). - type: integer + type: string example: arangosearch id: description: | @@ -2580,7 +2581,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2611,7 +2612,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2716,7 +2717,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -2747,7 +2748,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | diff --git a/site/content/3.13/develop/http-api/views/search-alias-views.md b/site/content/3.13/develop/http-api/views/search-alias-views.md index 9ac1ae3fdf..57c6ec5b85 100644 --- a/site/content/3.13/develop/http-api/views/search-alias-views.md +++ b/site/content/3.13/develop/http-api/views/search-alias-views.md @@ -43,6 +43,7 @@ paths: The type of the View. Must be equal to `"search-alias"`. This option is immutable. type: string + example: search-alias indexes: description: | A list of inverted indexes to add to the View. @@ -85,6 +86,7 @@ paths: description: | The type of the View (`"search-alias"`). type: string + example: search-alias id: description: | A unique identifier of the View (deprecated). @@ -138,7 +140,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -169,7 +171,7 @@ paths: example: 409 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -264,7 +266,7 @@ paths: type: description: | The type of the View (`"search-alias"`). - type: integer + type: string example: search-alias id: description: | @@ -299,7 +301,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -393,6 +395,7 @@ paths: description: | The type of the View (`"search-alias"`). type: string + example: search-alias id: description: | A unique identifier of the View (deprecated). @@ -444,7 +447,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -475,7 +478,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -745,7 +748,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -776,7 +779,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -940,7 +943,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -971,7 +974,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1121,7 +1124,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1152,7 +1155,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1257,7 +1260,7 @@ paths: example: 400 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: | @@ -1288,7 +1291,7 @@ paths: example: 404 errorNum: description: | - ArangoDB error number for the error that occurred. + The ArangoDB error number for the error that occurred. type: integer errorMessage: description: |