From ae5bebba590d3e4ac8bbab17becdd46ddd78af19 Mon Sep 17 00:00:00 2001 From: Simran Spiller Date: Thu, 7 Dec 2023 15:21:51 +0100 Subject: [PATCH 1/5] Add missing collection property --- site/content/3.12/develop/http-api/graphs/named-graphs.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/site/content/3.12/develop/http-api/graphs/named-graphs.md b/site/content/3.12/develop/http-api/graphs/named-graphs.md index 487e6fef20..377741574d 100644 --- a/site/content/3.12/develop/http-api/graphs/named-graphs.md +++ b/site/content/3.12/develop/http-api/graphs/named-graphs.md @@ -1346,7 +1346,13 @@ paths: application/json: schema: type: object + required: + - collection properties: + collection: + description: | + The name of the vertex collection to add to the graph definition. + type: string options: description: | A JSON object to set options for creating vertex collections. From 58e9596301f5e26bd5a7c1b4cc8b0b1a322ae765 Mon Sep 17 00:00:00 2001 From: Simran Spiller Date: Mon, 11 Dec 2023 15:25:37 +0100 Subject: [PATCH 2/5] Fix and improve descriptions and responses --- .../develop/http-api/graphs/named-graphs.md | 1058 +++++++++------- .../develop/http-api/graphs/named-graphs.md | 1058 +++++++++------- .../develop/http-api/graphs/named-graphs.md | 1114 ++++++++++------- 3 files changed, 1829 insertions(+), 1401 deletions(-) diff --git a/site/content/3.10/develop/http-api/graphs/named-graphs.md b/site/content/3.10/develop/http-api/graphs/named-graphs.md index 487e6fef20..2e26161f2d 100644 --- a/site/content/3.10/develop/http-api/graphs/named-graphs.md +++ b/site/content/3.10/develop/http-api/graphs/named-graphs.md @@ -39,7 +39,7 @@ paths: responses: '200': description: | - Is returned if the module is available and the graphs could be listed. + Is returned if the module is available and the graphs can be listed. content: application/json: schema: @@ -51,13 +51,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 graphs: description: | A list of all named graphs. @@ -119,7 +120,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -208,8 +209,8 @@ paths: in: query required: false description: | - define if the request should wait until everything is synced to disc. - Will change the success response code. + Define if the request should wait until everything is synced to disk. + Changes the success HTTP response status code. schema: type: boolean requestBody: @@ -258,7 +259,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -322,7 +323,7 @@ paths: responses: '201': description: | - Is returned if the graph could be created and waitForSync is enabled + Is returned if the graph can be created and `waitForSync` is enabled for the `_graphs` collection, or given in the request. The response body contains the graph configuration that has been stored. content: @@ -336,13 +337,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the newly created graph. @@ -397,7 +399,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -448,7 +450,7 @@ paths: type: boolean '202': description: | - Is returned if the graph could be created and waitForSync is disabled + Is returned if the graph can be created and `waitForSync` is disabled for the `_graphs` collection and not given in the request. The response body contains the graph configuration that has been stored. content: @@ -462,13 +464,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the newly created graph. @@ -523,7 +526,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -587,25 +590,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to create a graph you at least need to have the following privileges + In order to create a graph, you at least need to have the following privileges: content: application/json: schema: @@ -618,20 +622,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '409': description: | @@ -651,20 +656,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 409 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -906,8 +912,8 @@ paths: operationId: getGraph description: | Selects information for a given graph. - Will return the edge definitions as well as the orphan collections. - Or returns a 404 if the graph does not exist. + Returns the edge definitions as well as the orphan collections, + or returns an error if the graph does not exist. parameters: - name: graph in: path @@ -919,8 +925,8 @@ paths: responses: '200': description: | - Returns the graph if it could be found. - The result will have the following format + Returns the graph if it can be found. + The result has the following format: content: application/json: schema: @@ -932,13 +938,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 graph: description: | The information about the newly created graph @@ -993,7 +1000,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -1044,7 +1051,7 @@ paths: type: boolean '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -1057,20 +1064,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -1126,24 +1134,43 @@ paths: in: query required: false description: | - Drop collections of this graph as well. Collections will only be + Drop the collections of this graph as well. Collections are only dropped if they are not used in other graphs. schema: type: boolean responses: - '201': - description: | - Is returned if the graph could be dropped and waitForSync is enabled - for the `_graphs` collection, or given in the request. '202': description: | - Is returned if the graph could be dropped and waitForSync is disabled - for the `_graphs` collection and not given in the request. + Is returned if the graph can be dropped. + content: + application/json: + schema: + type: object + required: + - error + - code + - removed + properties: + error: + description: | + A flag indicating that no error occurred. + type: boolean + example: false + code: + description: | + The HTTP response status code. + type: integer + example: 202 + removed: + description: | + Always `true`. + type: boolean + example: true '403': description: | Returned if your user has insufficient rights. - In order to drop a graph you at least need to have the following privileges - 1. `Administrate` access on the Database. + In order to drop a graph, you at least need to have the following privileges: + - `Administrate` access on the database. content: application/json: schema: @@ -1156,24 +1183,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -1186,20 +1214,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -1232,7 +1261,7 @@ paths: get: operationId: listVertexCollections description: | - Lists all vertex collections within this graph. + Lists all vertex collections within this graph, including orphan collections. parameters: - name: graph in: path @@ -1244,7 +1273,7 @@ paths: responses: '200': description: | - Is returned if the collections could be listed. + Is returned if the collections can be listed. content: application/json: schema: @@ -1256,23 +1285,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 collections: description: | The list of all vertex collections within this graph. - Includes collections in edgeDefinitions as well as orphans. + Includes the vertex collections used in edge definitions + as well as orphan collections. type: array items: type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -1285,20 +1316,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -1325,6 +1357,11 @@ examples.dropGraph("social"); ### Add a vertex collection +Adding a vertex collection on its own to a graph adds it as an orphan collection. +If you want to use an additional vertex collection for graph relations, add it +by [adding a new edge definition](#add-an-edge-definition) or +[modifying an existing edge definition](#replace-an-edge-definition) instead. + ```openapi paths: /_api/gharial/{graph}/vertex: @@ -1332,7 +1369,7 @@ paths: operationId: addVertexCollection description: | Adds a vertex collection to the set of orphan collections of the graph. - If the collection does not exist, it will be created. + If the collection does not exist, it is created. parameters: - name: graph in: path @@ -1346,7 +1383,13 @@ paths: application/json: schema: type: object + required: + - collection properties: + collection: + description: | + The name of the vertex collection to add to the graph definition. + type: string options: description: | A JSON object to set options for creating vertex collections. @@ -1364,7 +1407,7 @@ paths: responses: '201': description: | - Is returned if the collection could be created and waitForSync is enabled + Is returned if the collection can be created and `waitForSync` is enabled for the `_graphs` collection, or given in the request. The response body contains the graph configuration that has been stored. content: @@ -1378,13 +1421,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the modified graph. @@ -1439,7 +1483,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -1490,7 +1534,7 @@ paths: type: boolean '202': description: | - Is returned if the collection could be created and waitForSync is disabled + Is returned if the collection can be created and `waitForSync` is disabled for the `_graphs` collection, or given in the request. The response body contains the graph configuration that has been stored. content: @@ -1504,13 +1548,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the newly created graph @@ -1565,7 +1610,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -1629,25 +1674,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to modify a graph you at least need to have the following privileges + In order to modify a graph, you at least need to have the following privileges: content: application/json: schema: @@ -1660,24 +1706,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -1690,20 +1737,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -1739,10 +1787,14 @@ paths: delete: operationId: deleteVertexCollection description: | - Removes a vertex collection from the graph and optionally deletes the collection, - if it is not used in any other graph. - It can only remove vertex collections that are no longer part of edge definitions, - if they are used in edge definitions you are required to modify those first. + Removes a vertex collection from the list of the graph's + orphan collections. It can optionally delete the collection if it is + not used in any other graph. + + You cannot remove vertex collections that are used in one of the + edge definitions of the graph. You need to modify or remove the + edge definition first in order to fully remove a vertex collection from + the graph. parameters: - name: graph in: path @@ -1763,14 +1815,14 @@ paths: required: false description: | Drop the collection as well. - Collection will only be dropped if it is not used in other graphs. + The collection is only dropped if it is not used in other graphs. schema: type: boolean responses: '200': description: | Returned if the vertex collection was removed from the graph successfully - and waitForSync is true. + and `waitForSync` is `true`. content: application/json: schema: @@ -1782,13 +1834,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 graph: description: | The information about the newly created graph @@ -1843,7 +1896,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -1894,7 +1947,7 @@ paths: type: boolean '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -1906,13 +1959,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the newly created graph @@ -1967,7 +2021,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -2033,26 +2087,27 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to drop a vertex you at least need to have the following privileges - 1. `Administrate` access on the Database. + In order to drop a vertex, you at least need to have the following privileges: + - `Administrate` access on the database. content: application/json: schema: @@ -2065,24 +2120,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -2095,20 +2151,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -2157,13 +2214,13 @@ db._drop("relation"); examples.dropGraph("social"); ``` -### List edge definitions +### List edge collections ```openapi paths: /_api/gharial/{graph}/edge: get: - operationId: listEdgeDefinitions + operationId: listEdgeCollections description: | Lists all edge collections within this graph. parameters: @@ -2177,7 +2234,7 @@ paths: responses: '200': description: | - Is returned if the edge definitions could be listed. + Is returned if the edge definitions can be listed. content: application/json: schema: @@ -2189,23 +2246,24 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 collections: description: | - The list of all vertex collections within this graph. - Includes collections in edgeDefinitions as well as orphans. + A list of all edge collections used in the edge definitions + of this graph. type: array items: type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -2218,20 +2276,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -2267,11 +2326,12 @@ paths: Adds an additional edge definition to the graph. This edge definition has to contain a `collection` and an array of - each `from` and `to` vertex collections. An edge definition can only + each `from` and `to` vertex collections. An edge definition can only be added if this definition is either not used in any other graph, or - it is used with exactly the same definition. It is not possible to - store a definition "e" from "v1" to "v2" in the one graph, and "e" - from "v2" to "v1" in the other graph. + it is used with exactly the same definition. For example, it is not + possible to store a definition "e" from "v1" to "v2" in one graph, and + "e" from "v2" to "v1" in another graph, but both can have "e" from + "v1" to "v2". Additionally, collection creation options can be set. parameters: @@ -2326,8 +2386,8 @@ paths: responses: '201': description: | - Returned if the definition could be added successfully and - waitForSync is enabled for the `_graphs` collection. + Returned if the definition can be added successfully and + `waitForSync` is enabled for the `_graphs` collection. The response body contains the graph configuration that has been stored. content: application/json: @@ -2340,13 +2400,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the modified graph. @@ -2401,7 +2462,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -2452,8 +2513,8 @@ paths: type: boolean '202': description: | - Returned if the definition could be added successfully and - waitForSync is disabled for the `_graphs` collection. + Returned if the definition can be added successfully and + `waitForSync` is disabled for the `_graphs` collection. The response body contains the graph configuration that has been stored. content: application/json: @@ -2466,13 +2527,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the modified graph. @@ -2527,7 +2589,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -2578,8 +2640,8 @@ paths: type: boolean '400': description: | - Returned if the definition could not be added. - This could be because it is ill-formed, or + Returned if the definition can not be added. + This can be because it is ill-formed, or if the definition is used in another graph with a different signature. content: application/json: @@ -2593,25 +2655,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to modify a graph you at least need to have the following privileges + In order to modify a graph, you at least need to have the following privileges: content: application/json: schema: @@ -2624,24 +2687,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -2654,20 +2718,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -2706,7 +2771,7 @@ paths: operationId: replaceEdgeDefinition description: | Change one specific edge definition. - This will modify all occurrences of this definition in all graphs known to your database. + This modifies all occurrences of this definition in all graphs known to your database. parameters: - name: graph in: path @@ -2734,7 +2799,7 @@ paths: required: false description: | Drop the collection as well. - Collection will only be dropped if it is not used in other graphs. + The collection is only dropped if it is not used in other graphs. schema: type: boolean requestBody: @@ -2781,7 +2846,7 @@ paths: responses: '201': description: | - Returned if the request was successful and waitForSync is true. + Returned if the request was successful and `waitForSync` is `true`. content: application/json: schema: @@ -2793,13 +2858,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the modified graph. @@ -2854,7 +2920,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -2905,7 +2971,7 @@ paths: type: boolean '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -2917,13 +2983,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the modified graph. @@ -2978,7 +3045,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -3042,26 +3109,27 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to drop a vertex you at least need to have the following privileges - 1. `Administrate` access on the Database. + In order to drop a vertex, you at least need to have the following privileges: + - `Administrate` access on the database. content: application/json: schema: @@ -3074,24 +3142,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found, or if no edge definition + Returned if no graph with this name can be found, or if no edge definition with this name is found in the graph. content: application/json: @@ -3105,20 +3174,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -3156,9 +3226,10 @@ paths: delete: operationId: deleteEdgeDefinition description: | - Remove one edge definition from the graph. This will only remove the - edge collection, the vertex collections remain untouched and can still - be used in your queries. + Remove one edge definition from the graph. This only removes the + edge collection from the graph definition. The vertex collections of the + edge definition become orphan collections but otherwise remain untouched + and can still be used in your queries. parameters: - name: graph in: path @@ -3186,14 +3257,14 @@ paths: required: false description: | Drop the collection as well. - Collection will only be dropped if it is not used in other graphs. + The collection is only dropped if it is not used in other graphs. schema: type: boolean responses: '201': description: | - Returned if the edge definition could be removed from the graph - and waitForSync is true. + Returned if the edge definition can be removed from the graph + and `waitForSync` is `true`. content: application/json: schema: @@ -3205,13 +3276,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the modified graph. @@ -3266,7 +3338,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -3317,8 +3389,8 @@ paths: type: boolean '202': description: | - Returned if the edge definition could be removed from the graph and - waitForSync is false. + Returned if the edge definition can be removed from the graph and + `waitForSync` is `false`. content: application/json: schema: @@ -3330,13 +3402,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the modified graph. @@ -3391,7 +3464,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -3443,8 +3516,8 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to drop a vertex you at least need to have the following privileges - 1. `Administrate` access on the Database. + In order to drop a vertex, you at least need to have the following privileges: + - `Administrate` access on the database. content: application/json: schema: @@ -3457,24 +3530,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found, + Returned if no graph with this name can be found, or if no edge definition with this name is found in the graph. content: application/json: @@ -3488,20 +3562,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -3583,7 +3658,7 @@ paths: responses: '201': description: | - Returned if the vertex could be added and waitForSync is true. + Returned if the vertex can be added and `waitForSync` is `true`. content: application/json: schema: @@ -3595,13 +3670,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 vertex: description: | The internal attributes for the vertex. @@ -3628,7 +3704,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -3649,7 +3725,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -3661,13 +3737,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 vertex: description: | The internal attributes generated while storing the vertex. @@ -3695,7 +3772,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -3717,7 +3794,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to insert vertices into the graph you at least need to have the following privileges + In order to insert vertices into the graph, you at least need to have the following privileges: content: application/json: schema: @@ -3730,24 +3807,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. Or if a graph is found but this collection is not part of the graph. content: application/json: @@ -3761,20 +3839,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -3863,7 +3942,7 @@ paths: responses: '200': description: | - Returned if the vertex could be found. + Returned if the vertex can be found. content: application/json: schema: @@ -3875,13 +3954,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 vertex: description: | The complete vertex. @@ -3921,25 +4001,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 304 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to update vertices in the graph you at least need to have the following privileges + In order to update vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -3952,25 +4033,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The vertex does not exist. content: @@ -3985,20 +4067,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -4015,20 +4098,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -4142,7 +4226,7 @@ paths: responses: '200': description: | - Returned if the vertex could be updated, and waitForSync is true. + Returned if the vertex can be updated, and `waitForSync` is `true`. content: application/json: schema: @@ -4154,13 +4238,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 vertex: description: | The internal attributes for the vertex. @@ -4187,7 +4272,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -4210,7 +4295,7 @@ paths: description: | The complete overwritten vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4231,7 +4316,7 @@ paths: type: string '202': description: | - Returned if the request was successful, and waitForSync is false. + Returned if the request was successful, and `waitForSync` is `false`. content: application/json: schema: @@ -4243,13 +4328,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 vertex: description: | The internal attributes for the vertex. @@ -4276,7 +4362,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -4299,7 +4385,7 @@ paths: description: | The complete overwritten vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4321,7 +4407,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to update vertices in the graph you at least need to have the following privileges + In order to update vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -4334,25 +4420,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The vertex to update does not exist. content: @@ -4367,20 +4454,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -4397,20 +4485,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -4527,7 +4616,7 @@ paths: responses: '200': description: | - Returned if the vertex could be replaced, and waitForSync is true. + Returned if the vertex can be replaced, and `waitForSync` is `true`. content: application/json: schema: @@ -4539,13 +4628,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 vertex: description: | The internal attributes for the vertex. @@ -4572,7 +4662,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -4595,7 +4685,7 @@ paths: description: | The complete overwritten vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4616,7 +4706,7 @@ paths: type: string '202': description: | - Returned if the vertex could be replaced, and waitForSync is false. + Returned if the vertex can be replaced, and `waitForSync` is `false`. content: application/json: schema: @@ -4628,13 +4718,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 vertex: description: | The internal attributes for the vertex. @@ -4661,7 +4752,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -4684,7 +4775,7 @@ paths: description: | The complete overwritten vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4706,7 +4797,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to replace vertices in the graph you at least need to have the following privileges + In order to replace vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -4719,25 +4810,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The vertex to replace does not exist. content: @@ -4752,20 +4844,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -4782,20 +4875,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -4882,7 +4976,7 @@ paths: responses: '200': description: | - Returned if the vertex could be removed. + Returned if the vertex can be removed. content: application/json: schema: @@ -4894,13 +4988,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 removed: description: | Is set to true if the remove was successful. @@ -4909,7 +5004,7 @@ paths: description: | The complete deleted vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4930,7 +5025,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -4942,13 +5037,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 removed: description: | Is set to true if the remove was successful. @@ -4957,7 +5053,7 @@ paths: description: | The complete deleted vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4979,7 +5075,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to delete vertices in the graph you at least need to have the following privileges + In order to delete vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -4992,25 +5088,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The vertex to remove does not exist. content: @@ -5025,20 +5122,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -5055,20 +5153,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -5158,7 +5257,7 @@ paths: responses: '201': description: | - Returned if the edge could be created and waitForSync is true. + Returned if the edge can be created and `waitForSync` is `true`. content: application/json: schema: @@ -5170,13 +5269,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 edge: description: | The internal attributes for the edge. @@ -5213,7 +5313,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -5244,7 +5344,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -5256,13 +5356,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 edge: description: | The internal attributes for the edge. @@ -5299,7 +5400,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -5345,25 +5446,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to insert edges into the graph you at least need to have the following privileges + In order to insert edges into the graph, you at least need to have the following privileges: content: application/json: schema: @@ -5376,25 +5478,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in any of the following cases - - no graph with this name could be found. + - no graph with this name can be found. - the edge collection is not part of the graph. - the vertex collection referenced in the `_from` or `_to` attribute is not part of the graph. - the vertex collection is part of the graph, but does not exist. @@ -5411,20 +5514,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -5518,7 +5622,7 @@ paths: responses: '200': description: | - Returned if the edge could be found. + Returned if the edge can be found. content: application/json: schema: @@ -5530,13 +5634,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 edge: description: | The complete edge. @@ -5586,25 +5691,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 304 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to update vertices in the graph you at least need to have the following privileges + In order to update vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -5617,25 +5723,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The edge does not exist. content: @@ -5650,20 +5757,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -5680,20 +5788,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -5808,7 +5917,7 @@ paths: responses: '200': description: | - Returned if the edge could be updated, and waitForSync is false. + Returned if the edge can be updated, and `waitForSync` is `false`. content: application/json: schema: @@ -5820,13 +5929,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 edge: description: | The internal attributes for the edge. @@ -5863,7 +5973,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -5896,7 +6006,7 @@ paths: description: | The complete overwritten edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -5927,7 +6037,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -5939,13 +6049,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 edge: description: | The internal attributes for the edge. @@ -5982,7 +6093,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -6015,7 +6126,7 @@ paths: description: | The complete overwritten edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6047,7 +6158,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to update edges in the graph you at least need to have the following privileges + In order to update edges in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -6060,25 +6171,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The edge to update does not exist. - either `_from` or `_to` vertex does not exist (if updated). @@ -6094,20 +6206,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -6124,20 +6237,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -6261,7 +6375,7 @@ paths: responses: '201': description: | - Returned if the request was successful but waitForSync is true. + Returned if the request was successful but `waitForSync` is `true`. content: application/json: schema: @@ -6273,13 +6387,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 edge: description: | The internal attributes for the edge @@ -6316,7 +6431,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -6349,7 +6464,7 @@ paths: description: | The complete overwritten edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6380,7 +6495,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -6392,13 +6507,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 edge: description: | The internal attributes for the edge @@ -6435,7 +6551,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -6468,7 +6584,7 @@ paths: description: | The complete overwritten edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6500,7 +6616,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to replace edges in the graph you at least need to have the following privileges + In order to replace edges in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -6513,25 +6629,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The edge to replace does not exist. - either `_from` or `_to` vertex does not exist. @@ -6547,20 +6664,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -6577,20 +6695,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -6679,7 +6798,7 @@ paths: responses: '200': description: | - Returned if the edge could be removed. + Returned if the edge can be removed. content: application/json: schema: @@ -6691,13 +6810,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 removed: description: | Is set to true if the remove was successful. @@ -6706,7 +6826,7 @@ paths: description: | The complete deleted edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6737,7 +6857,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -6749,13 +6869,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 removed: description: | Is set to true if the remove was successful. @@ -6764,7 +6885,7 @@ paths: description: | The complete deleted edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6796,7 +6917,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to delete vertices in the graph you at least need to have the following privileges + In order to delete vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -6809,25 +6930,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The edge to remove does not exist. content: @@ -6842,20 +6964,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -6872,20 +6995,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs 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 487e6fef20..2e26161f2d 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 @@ -39,7 +39,7 @@ paths: responses: '200': description: | - Is returned if the module is available and the graphs could be listed. + Is returned if the module is available and the graphs can be listed. content: application/json: schema: @@ -51,13 +51,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 graphs: description: | A list of all named graphs. @@ -119,7 +120,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -208,8 +209,8 @@ paths: in: query required: false description: | - define if the request should wait until everything is synced to disc. - Will change the success response code. + Define if the request should wait until everything is synced to disk. + Changes the success HTTP response status code. schema: type: boolean requestBody: @@ -258,7 +259,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -322,7 +323,7 @@ paths: responses: '201': description: | - Is returned if the graph could be created and waitForSync is enabled + Is returned if the graph can be created and `waitForSync` is enabled for the `_graphs` collection, or given in the request. The response body contains the graph configuration that has been stored. content: @@ -336,13 +337,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the newly created graph. @@ -397,7 +399,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -448,7 +450,7 @@ paths: type: boolean '202': description: | - Is returned if the graph could be created and waitForSync is disabled + Is returned if the graph can be created and `waitForSync` is disabled for the `_graphs` collection and not given in the request. The response body contains the graph configuration that has been stored. content: @@ -462,13 +464,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the newly created graph. @@ -523,7 +526,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -587,25 +590,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to create a graph you at least need to have the following privileges + In order to create a graph, you at least need to have the following privileges: content: application/json: schema: @@ -618,20 +622,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '409': description: | @@ -651,20 +656,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 409 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -906,8 +912,8 @@ paths: operationId: getGraph description: | Selects information for a given graph. - Will return the edge definitions as well as the orphan collections. - Or returns a 404 if the graph does not exist. + Returns the edge definitions as well as the orphan collections, + or returns an error if the graph does not exist. parameters: - name: graph in: path @@ -919,8 +925,8 @@ paths: responses: '200': description: | - Returns the graph if it could be found. - The result will have the following format + Returns the graph if it can be found. + The result has the following format: content: application/json: schema: @@ -932,13 +938,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 graph: description: | The information about the newly created graph @@ -993,7 +1000,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -1044,7 +1051,7 @@ paths: type: boolean '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -1057,20 +1064,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -1126,24 +1134,43 @@ paths: in: query required: false description: | - Drop collections of this graph as well. Collections will only be + Drop the collections of this graph as well. Collections are only dropped if they are not used in other graphs. schema: type: boolean responses: - '201': - description: | - Is returned if the graph could be dropped and waitForSync is enabled - for the `_graphs` collection, or given in the request. '202': description: | - Is returned if the graph could be dropped and waitForSync is disabled - for the `_graphs` collection and not given in the request. + Is returned if the graph can be dropped. + content: + application/json: + schema: + type: object + required: + - error + - code + - removed + properties: + error: + description: | + A flag indicating that no error occurred. + type: boolean + example: false + code: + description: | + The HTTP response status code. + type: integer + example: 202 + removed: + description: | + Always `true`. + type: boolean + example: true '403': description: | Returned if your user has insufficient rights. - In order to drop a graph you at least need to have the following privileges - 1. `Administrate` access on the Database. + In order to drop a graph, you at least need to have the following privileges: + - `Administrate` access on the database. content: application/json: schema: @@ -1156,24 +1183,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -1186,20 +1214,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -1232,7 +1261,7 @@ paths: get: operationId: listVertexCollections description: | - Lists all vertex collections within this graph. + Lists all vertex collections within this graph, including orphan collections. parameters: - name: graph in: path @@ -1244,7 +1273,7 @@ paths: responses: '200': description: | - Is returned if the collections could be listed. + Is returned if the collections can be listed. content: application/json: schema: @@ -1256,23 +1285,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 collections: description: | The list of all vertex collections within this graph. - Includes collections in edgeDefinitions as well as orphans. + Includes the vertex collections used in edge definitions + as well as orphan collections. type: array items: type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -1285,20 +1316,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -1325,6 +1357,11 @@ examples.dropGraph("social"); ### Add a vertex collection +Adding a vertex collection on its own to a graph adds it as an orphan collection. +If you want to use an additional vertex collection for graph relations, add it +by [adding a new edge definition](#add-an-edge-definition) or +[modifying an existing edge definition](#replace-an-edge-definition) instead. + ```openapi paths: /_api/gharial/{graph}/vertex: @@ -1332,7 +1369,7 @@ paths: operationId: addVertexCollection description: | Adds a vertex collection to the set of orphan collections of the graph. - If the collection does not exist, it will be created. + If the collection does not exist, it is created. parameters: - name: graph in: path @@ -1346,7 +1383,13 @@ paths: application/json: schema: type: object + required: + - collection properties: + collection: + description: | + The name of the vertex collection to add to the graph definition. + type: string options: description: | A JSON object to set options for creating vertex collections. @@ -1364,7 +1407,7 @@ paths: responses: '201': description: | - Is returned if the collection could be created and waitForSync is enabled + Is returned if the collection can be created and `waitForSync` is enabled for the `_graphs` collection, or given in the request. The response body contains the graph configuration that has been stored. content: @@ -1378,13 +1421,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the modified graph. @@ -1439,7 +1483,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -1490,7 +1534,7 @@ paths: type: boolean '202': description: | - Is returned if the collection could be created and waitForSync is disabled + Is returned if the collection can be created and `waitForSync` is disabled for the `_graphs` collection, or given in the request. The response body contains the graph configuration that has been stored. content: @@ -1504,13 +1548,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the newly created graph @@ -1565,7 +1610,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -1629,25 +1674,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to modify a graph you at least need to have the following privileges + In order to modify a graph, you at least need to have the following privileges: content: application/json: schema: @@ -1660,24 +1706,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -1690,20 +1737,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -1739,10 +1787,14 @@ paths: delete: operationId: deleteVertexCollection description: | - Removes a vertex collection from the graph and optionally deletes the collection, - if it is not used in any other graph. - It can only remove vertex collections that are no longer part of edge definitions, - if they are used in edge definitions you are required to modify those first. + Removes a vertex collection from the list of the graph's + orphan collections. It can optionally delete the collection if it is + not used in any other graph. + + You cannot remove vertex collections that are used in one of the + edge definitions of the graph. You need to modify or remove the + edge definition first in order to fully remove a vertex collection from + the graph. parameters: - name: graph in: path @@ -1763,14 +1815,14 @@ paths: required: false description: | Drop the collection as well. - Collection will only be dropped if it is not used in other graphs. + The collection is only dropped if it is not used in other graphs. schema: type: boolean responses: '200': description: | Returned if the vertex collection was removed from the graph successfully - and waitForSync is true. + and `waitForSync` is `true`. content: application/json: schema: @@ -1782,13 +1834,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 graph: description: | The information about the newly created graph @@ -1843,7 +1896,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -1894,7 +1947,7 @@ paths: type: boolean '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -1906,13 +1959,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the newly created graph @@ -1967,7 +2021,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -2033,26 +2087,27 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to drop a vertex you at least need to have the following privileges - 1. `Administrate` access on the Database. + In order to drop a vertex, you at least need to have the following privileges: + - `Administrate` access on the database. content: application/json: schema: @@ -2065,24 +2120,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -2095,20 +2151,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -2157,13 +2214,13 @@ db._drop("relation"); examples.dropGraph("social"); ``` -### List edge definitions +### List edge collections ```openapi paths: /_api/gharial/{graph}/edge: get: - operationId: listEdgeDefinitions + operationId: listEdgeCollections description: | Lists all edge collections within this graph. parameters: @@ -2177,7 +2234,7 @@ paths: responses: '200': description: | - Is returned if the edge definitions could be listed. + Is returned if the edge definitions can be listed. content: application/json: schema: @@ -2189,23 +2246,24 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 collections: description: | - The list of all vertex collections within this graph. - Includes collections in edgeDefinitions as well as orphans. + A list of all edge collections used in the edge definitions + of this graph. type: array items: type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -2218,20 +2276,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -2267,11 +2326,12 @@ paths: Adds an additional edge definition to the graph. This edge definition has to contain a `collection` and an array of - each `from` and `to` vertex collections. An edge definition can only + each `from` and `to` vertex collections. An edge definition can only be added if this definition is either not used in any other graph, or - it is used with exactly the same definition. It is not possible to - store a definition "e" from "v1" to "v2" in the one graph, and "e" - from "v2" to "v1" in the other graph. + it is used with exactly the same definition. For example, it is not + possible to store a definition "e" from "v1" to "v2" in one graph, and + "e" from "v2" to "v1" in another graph, but both can have "e" from + "v1" to "v2". Additionally, collection creation options can be set. parameters: @@ -2326,8 +2386,8 @@ paths: responses: '201': description: | - Returned if the definition could be added successfully and - waitForSync is enabled for the `_graphs` collection. + Returned if the definition can be added successfully and + `waitForSync` is enabled for the `_graphs` collection. The response body contains the graph configuration that has been stored. content: application/json: @@ -2340,13 +2400,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the modified graph. @@ -2401,7 +2462,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -2452,8 +2513,8 @@ paths: type: boolean '202': description: | - Returned if the definition could be added successfully and - waitForSync is disabled for the `_graphs` collection. + Returned if the definition can be added successfully and + `waitForSync` is disabled for the `_graphs` collection. The response body contains the graph configuration that has been stored. content: application/json: @@ -2466,13 +2527,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the modified graph. @@ -2527,7 +2589,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -2578,8 +2640,8 @@ paths: type: boolean '400': description: | - Returned if the definition could not be added. - This could be because it is ill-formed, or + Returned if the definition can not be added. + This can be because it is ill-formed, or if the definition is used in another graph with a different signature. content: application/json: @@ -2593,25 +2655,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to modify a graph you at least need to have the following privileges + In order to modify a graph, you at least need to have the following privileges: content: application/json: schema: @@ -2624,24 +2687,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -2654,20 +2718,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -2706,7 +2771,7 @@ paths: operationId: replaceEdgeDefinition description: | Change one specific edge definition. - This will modify all occurrences of this definition in all graphs known to your database. + This modifies all occurrences of this definition in all graphs known to your database. parameters: - name: graph in: path @@ -2734,7 +2799,7 @@ paths: required: false description: | Drop the collection as well. - Collection will only be dropped if it is not used in other graphs. + The collection is only dropped if it is not used in other graphs. schema: type: boolean requestBody: @@ -2781,7 +2846,7 @@ paths: responses: '201': description: | - Returned if the request was successful and waitForSync is true. + Returned if the request was successful and `waitForSync` is `true`. content: application/json: schema: @@ -2793,13 +2858,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the modified graph. @@ -2854,7 +2920,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -2905,7 +2971,7 @@ paths: type: boolean '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -2917,13 +2983,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the modified graph. @@ -2978,7 +3045,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -3042,26 +3109,27 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to drop a vertex you at least need to have the following privileges - 1. `Administrate` access on the Database. + In order to drop a vertex, you at least need to have the following privileges: + - `Administrate` access on the database. content: application/json: schema: @@ -3074,24 +3142,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found, or if no edge definition + Returned if no graph with this name can be found, or if no edge definition with this name is found in the graph. content: application/json: @@ -3105,20 +3174,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -3156,9 +3226,10 @@ paths: delete: operationId: deleteEdgeDefinition description: | - Remove one edge definition from the graph. This will only remove the - edge collection, the vertex collections remain untouched and can still - be used in your queries. + Remove one edge definition from the graph. This only removes the + edge collection from the graph definition. The vertex collections of the + edge definition become orphan collections but otherwise remain untouched + and can still be used in your queries. parameters: - name: graph in: path @@ -3186,14 +3257,14 @@ paths: required: false description: | Drop the collection as well. - Collection will only be dropped if it is not used in other graphs. + The collection is only dropped if it is not used in other graphs. schema: type: boolean responses: '201': description: | - Returned if the edge definition could be removed from the graph - and waitForSync is true. + Returned if the edge definition can be removed from the graph + and `waitForSync` is `true`. content: application/json: schema: @@ -3205,13 +3276,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the modified graph. @@ -3266,7 +3338,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -3317,8 +3389,8 @@ paths: type: boolean '202': description: | - Returned if the edge definition could be removed from the graph and - waitForSync is false. + Returned if the edge definition can be removed from the graph and + `waitForSync` is `false`. content: application/json: schema: @@ -3330,13 +3402,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the modified graph. @@ -3391,7 +3464,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -3443,8 +3516,8 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to drop a vertex you at least need to have the following privileges - 1. `Administrate` access on the Database. + In order to drop a vertex, you at least need to have the following privileges: + - `Administrate` access on the database. content: application/json: schema: @@ -3457,24 +3530,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found, + Returned if no graph with this name can be found, or if no edge definition with this name is found in the graph. content: application/json: @@ -3488,20 +3562,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -3583,7 +3658,7 @@ paths: responses: '201': description: | - Returned if the vertex could be added and waitForSync is true. + Returned if the vertex can be added and `waitForSync` is `true`. content: application/json: schema: @@ -3595,13 +3670,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 vertex: description: | The internal attributes for the vertex. @@ -3628,7 +3704,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -3649,7 +3725,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -3661,13 +3737,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 vertex: description: | The internal attributes generated while storing the vertex. @@ -3695,7 +3772,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -3717,7 +3794,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to insert vertices into the graph you at least need to have the following privileges + In order to insert vertices into the graph, you at least need to have the following privileges: content: application/json: schema: @@ -3730,24 +3807,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. Or if a graph is found but this collection is not part of the graph. content: application/json: @@ -3761,20 +3839,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -3863,7 +3942,7 @@ paths: responses: '200': description: | - Returned if the vertex could be found. + Returned if the vertex can be found. content: application/json: schema: @@ -3875,13 +3954,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 vertex: description: | The complete vertex. @@ -3921,25 +4001,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 304 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to update vertices in the graph you at least need to have the following privileges + In order to update vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -3952,25 +4033,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The vertex does not exist. content: @@ -3985,20 +4067,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -4015,20 +4098,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -4142,7 +4226,7 @@ paths: responses: '200': description: | - Returned if the vertex could be updated, and waitForSync is true. + Returned if the vertex can be updated, and `waitForSync` is `true`. content: application/json: schema: @@ -4154,13 +4238,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 vertex: description: | The internal attributes for the vertex. @@ -4187,7 +4272,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -4210,7 +4295,7 @@ paths: description: | The complete overwritten vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4231,7 +4316,7 @@ paths: type: string '202': description: | - Returned if the request was successful, and waitForSync is false. + Returned if the request was successful, and `waitForSync` is `false`. content: application/json: schema: @@ -4243,13 +4328,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 vertex: description: | The internal attributes for the vertex. @@ -4276,7 +4362,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -4299,7 +4385,7 @@ paths: description: | The complete overwritten vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4321,7 +4407,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to update vertices in the graph you at least need to have the following privileges + In order to update vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -4334,25 +4420,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The vertex to update does not exist. content: @@ -4367,20 +4454,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -4397,20 +4485,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -4527,7 +4616,7 @@ paths: responses: '200': description: | - Returned if the vertex could be replaced, and waitForSync is true. + Returned if the vertex can be replaced, and `waitForSync` is `true`. content: application/json: schema: @@ -4539,13 +4628,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 vertex: description: | The internal attributes for the vertex. @@ -4572,7 +4662,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -4595,7 +4685,7 @@ paths: description: | The complete overwritten vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4616,7 +4706,7 @@ paths: type: string '202': description: | - Returned if the vertex could be replaced, and waitForSync is false. + Returned if the vertex can be replaced, and `waitForSync` is `false`. content: application/json: schema: @@ -4628,13 +4718,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 vertex: description: | The internal attributes for the vertex. @@ -4661,7 +4752,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -4684,7 +4775,7 @@ paths: description: | The complete overwritten vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4706,7 +4797,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to replace vertices in the graph you at least need to have the following privileges + In order to replace vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -4719,25 +4810,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The vertex to replace does not exist. content: @@ -4752,20 +4844,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -4782,20 +4875,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -4882,7 +4976,7 @@ paths: responses: '200': description: | - Returned if the vertex could be removed. + Returned if the vertex can be removed. content: application/json: schema: @@ -4894,13 +4988,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 removed: description: | Is set to true if the remove was successful. @@ -4909,7 +5004,7 @@ paths: description: | The complete deleted vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4930,7 +5025,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -4942,13 +5037,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 removed: description: | Is set to true if the remove was successful. @@ -4957,7 +5053,7 @@ paths: description: | The complete deleted vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4979,7 +5075,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to delete vertices in the graph you at least need to have the following privileges + In order to delete vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -4992,25 +5088,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The vertex to remove does not exist. content: @@ -5025,20 +5122,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -5055,20 +5153,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -5158,7 +5257,7 @@ paths: responses: '201': description: | - Returned if the edge could be created and waitForSync is true. + Returned if the edge can be created and `waitForSync` is `true`. content: application/json: schema: @@ -5170,13 +5269,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 edge: description: | The internal attributes for the edge. @@ -5213,7 +5313,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -5244,7 +5344,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -5256,13 +5356,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 edge: description: | The internal attributes for the edge. @@ -5299,7 +5400,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -5345,25 +5446,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to insert edges into the graph you at least need to have the following privileges + In order to insert edges into the graph, you at least need to have the following privileges: content: application/json: schema: @@ -5376,25 +5478,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in any of the following cases - - no graph with this name could be found. + - no graph with this name can be found. - the edge collection is not part of the graph. - the vertex collection referenced in the `_from` or `_to` attribute is not part of the graph. - the vertex collection is part of the graph, but does not exist. @@ -5411,20 +5514,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -5518,7 +5622,7 @@ paths: responses: '200': description: | - Returned if the edge could be found. + Returned if the edge can be found. content: application/json: schema: @@ -5530,13 +5634,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 edge: description: | The complete edge. @@ -5586,25 +5691,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 304 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to update vertices in the graph you at least need to have the following privileges + In order to update vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -5617,25 +5723,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The edge does not exist. content: @@ -5650,20 +5757,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -5680,20 +5788,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -5808,7 +5917,7 @@ paths: responses: '200': description: | - Returned if the edge could be updated, and waitForSync is false. + Returned if the edge can be updated, and `waitForSync` is `false`. content: application/json: schema: @@ -5820,13 +5929,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 edge: description: | The internal attributes for the edge. @@ -5863,7 +5973,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -5896,7 +6006,7 @@ paths: description: | The complete overwritten edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -5927,7 +6037,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -5939,13 +6049,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 edge: description: | The internal attributes for the edge. @@ -5982,7 +6093,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -6015,7 +6126,7 @@ paths: description: | The complete overwritten edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6047,7 +6158,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to update edges in the graph you at least need to have the following privileges + In order to update edges in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -6060,25 +6171,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The edge to update does not exist. - either `_from` or `_to` vertex does not exist (if updated). @@ -6094,20 +6206,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -6124,20 +6237,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -6261,7 +6375,7 @@ paths: responses: '201': description: | - Returned if the request was successful but waitForSync is true. + Returned if the request was successful but `waitForSync` is `true`. content: application/json: schema: @@ -6273,13 +6387,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 edge: description: | The internal attributes for the edge @@ -6316,7 +6431,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -6349,7 +6464,7 @@ paths: description: | The complete overwritten edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6380,7 +6495,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -6392,13 +6507,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 edge: description: | The internal attributes for the edge @@ -6435,7 +6551,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -6468,7 +6584,7 @@ paths: description: | The complete overwritten edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6500,7 +6616,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to replace edges in the graph you at least need to have the following privileges + In order to replace edges in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -6513,25 +6629,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The edge to replace does not exist. - either `_from` or `_to` vertex does not exist. @@ -6547,20 +6664,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -6577,20 +6695,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -6679,7 +6798,7 @@ paths: responses: '200': description: | - Returned if the edge could be removed. + Returned if the edge can be removed. content: application/json: schema: @@ -6691,13 +6810,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 removed: description: | Is set to true if the remove was successful. @@ -6706,7 +6826,7 @@ paths: description: | The complete deleted edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6737,7 +6857,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -6749,13 +6869,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 removed: description: | Is set to true if the remove was successful. @@ -6764,7 +6885,7 @@ paths: description: | The complete deleted edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6796,7 +6917,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to delete vertices in the graph you at least need to have the following privileges + In order to delete vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -6809,25 +6930,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The edge to remove does not exist. content: @@ -6842,20 +6964,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -6872,20 +6995,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs diff --git a/site/content/3.12/develop/http-api/graphs/named-graphs.md b/site/content/3.12/develop/http-api/graphs/named-graphs.md index 377741574d..07428135ad 100644 --- a/site/content/3.12/develop/http-api/graphs/named-graphs.md +++ b/site/content/3.12/develop/http-api/graphs/named-graphs.md @@ -39,7 +39,7 @@ paths: responses: '200': description: | - Is returned if the module is available and the graphs could be listed. + Is returned if the module is available and the graphs can be listed. content: application/json: schema: @@ -51,13 +51,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 graphs: description: | A list of all named graphs. @@ -119,7 +120,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -208,8 +209,8 @@ paths: in: query required: false description: | - define if the request should wait until everything is synced to disc. - Will change the success response code. + Define if the request should wait until everything is synced to disk. + Changes the success HTTP response status code. schema: type: boolean requestBody: @@ -258,7 +259,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -322,7 +323,7 @@ paths: responses: '201': description: | - Is returned if the graph could be created and waitForSync is enabled + Is returned if the graph can be created and `waitForSync` is enabled for the `_graphs` collection, or given in the request. The response body contains the graph configuration that has been stored. content: @@ -336,13 +337,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the newly created graph. @@ -397,7 +399,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -448,7 +450,7 @@ paths: type: boolean '202': description: | - Is returned if the graph could be created and waitForSync is disabled + Is returned if the graph can be created and `waitForSync` is disabled for the `_graphs` collection and not given in the request. The response body contains the graph configuration that has been stored. content: @@ -462,13 +464,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the newly created graph. @@ -523,7 +526,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -587,25 +590,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to create a graph you at least need to have the following privileges + In order to create a graph, you at least need to have the following privileges: content: application/json: schema: @@ -618,20 +622,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '409': description: | @@ -651,20 +656,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 409 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -906,8 +912,8 @@ paths: operationId: getGraph description: | Selects information for a given graph. - Will return the edge definitions as well as the orphan collections. - Or returns a 404 if the graph does not exist. + Returns the edge definitions as well as the orphan collections, + or returns an error if the graph does not exist. parameters: - name: graph in: path @@ -919,8 +925,8 @@ paths: responses: '200': description: | - Returns the graph if it could be found. - The result will have the following format + Returns the graph if it can be found. + The result has the following format: content: application/json: schema: @@ -932,13 +938,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 graph: description: | The information about the newly created graph @@ -993,7 +1000,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -1044,7 +1051,7 @@ paths: type: boolean '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -1057,20 +1064,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -1105,6 +1113,68 @@ graph._drop("myGraph", true); ### Drop a graph +{{< comment >}} +The API is supposed to return 201 if waitForSync is used and 202 otherwise, +but it actually returns 202 in all cases. Possibly to be adjusted in 3.12/4.0. + + '201': + description: | + Is returned if the graph can be dropped and `waitForSync` is enabled + for the `_graphs` collection, or given in the request. + content: + application/json: + schema: + type: object + required: + - error + - code + - removed + properties: + error: + description: | + A flag indicating that no error occurred. + type: boolean + example: false + code: + description: | + The HTTP response status code. + type: integer + example: 201 + removed: + description: | + Always `true`. + type: boolean + example: true + '202': + description: | + Is returned if the graph can be dropped and `waitForSync` is disabled + for the `_graphs` collection and not given in the request. + content: + application/json: + schema: + type: object + required: + - error + - code + - removed + properties: + error: + description: | + A flag indicating that no error occurred. + type: boolean + example: false + code: + description: | + The HTTP response status code. + type: integer + example: 202 + removed: + description: | + Always `true`. + type: boolean + example: true +{{< /comment >}} + ```openapi paths: /_api/gharial/{graph}: @@ -1126,24 +1196,43 @@ paths: in: query required: false description: | - Drop collections of this graph as well. Collections will only be + Drop the collections of this graph as well. Collections are only dropped if they are not used in other graphs. schema: type: boolean responses: - '201': - description: | - Is returned if the graph could be dropped and waitForSync is enabled - for the `_graphs` collection, or given in the request. '202': description: | - Is returned if the graph could be dropped and waitForSync is disabled - for the `_graphs` collection and not given in the request. + Is returned if the graph can be dropped. + content: + application/json: + schema: + type: object + required: + - error + - code + - removed + properties: + error: + description: | + A flag indicating that no error occurred. + type: boolean + example: false + code: + description: | + The HTTP response status code. + type: integer + example: 202 + removed: + description: | + Always `true`. + type: boolean + example: true '403': description: | Returned if your user has insufficient rights. - In order to drop a graph you at least need to have the following privileges - 1. `Administrate` access on the Database. + In order to drop a graph, you at least need to have the following privileges: + - `Administrate` access on the database. content: application/json: schema: @@ -1156,24 +1245,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -1186,20 +1276,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -1232,7 +1323,7 @@ paths: get: operationId: listVertexCollections description: | - Lists all vertex collections within this graph. + Lists all vertex collections within this graph, including orphan collections. parameters: - name: graph in: path @@ -1244,7 +1335,7 @@ paths: responses: '200': description: | - Is returned if the collections could be listed. + Is returned if the collections can be listed. content: application/json: schema: @@ -1256,23 +1347,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 collections: description: | The list of all vertex collections within this graph. - Includes collections in edgeDefinitions as well as orphans. + Includes the vertex collections used in edge definitions + as well as orphan collections. type: array items: type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -1285,20 +1378,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -1325,6 +1419,11 @@ examples.dropGraph("social"); ### Add a vertex collection +Adding a vertex collection on its own to a graph adds it as an orphan collection. +If you want to use an additional vertex collection for graph relations, add it +by [adding a new edge definition](#add-an-edge-definition) or +[modifying an existing edge definition](#replace-an-edge-definition) instead. + ```openapi paths: /_api/gharial/{graph}/vertex: @@ -1332,7 +1431,7 @@ paths: operationId: addVertexCollection description: | Adds a vertex collection to the set of orphan collections of the graph. - If the collection does not exist, it will be created. + If the collection does not exist, it is created. parameters: - name: graph in: path @@ -1370,7 +1469,7 @@ paths: responses: '201': description: | - Is returned if the collection could be created and waitForSync is enabled + Is returned if the collection can be created and `waitForSync` is enabled for the `_graphs` collection, or given in the request. The response body contains the graph configuration that has been stored. content: @@ -1384,13 +1483,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the modified graph. @@ -1445,7 +1545,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -1496,7 +1596,7 @@ paths: type: boolean '202': description: | - Is returned if the collection could be created and waitForSync is disabled + Is returned if the collection can be created and `waitForSync` is disabled for the `_graphs` collection, or given in the request. The response body contains the graph configuration that has been stored. content: @@ -1510,13 +1610,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the newly created graph @@ -1571,7 +1672,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -1635,25 +1736,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to modify a graph you at least need to have the following privileges + In order to modify a graph, you at least need to have the following privileges: content: application/json: schema: @@ -1666,24 +1768,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -1696,20 +1799,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -1745,10 +1849,14 @@ paths: delete: operationId: deleteVertexCollection description: | - Removes a vertex collection from the graph and optionally deletes the collection, - if it is not used in any other graph. - It can only remove vertex collections that are no longer part of edge definitions, - if they are used in edge definitions you are required to modify those first. + Removes a vertex collection from the list of the graph's + orphan collections. It can optionally delete the collection if it is + not used in any other graph. + + You cannot remove vertex collections that are used in one of the + edge definitions of the graph. You need to modify or remove the + edge definition first in order to fully remove a vertex collection from + the graph. parameters: - name: graph in: path @@ -1769,14 +1877,14 @@ paths: required: false description: | Drop the collection as well. - Collection will only be dropped if it is not used in other graphs. + The collection is only dropped if it is not used in other graphs. schema: type: boolean responses: '200': description: | Returned if the vertex collection was removed from the graph successfully - and waitForSync is true. + and `waitForSync` is `true`. content: application/json: schema: @@ -1788,13 +1896,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 graph: description: | The information about the newly created graph @@ -1849,7 +1958,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -1900,7 +2009,7 @@ paths: type: boolean '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -1912,13 +2021,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the newly created graph @@ -1973,7 +2083,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -2039,26 +2149,27 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to drop a vertex you at least need to have the following privileges - 1. `Administrate` access on the Database. + In order to drop a vertex, you at least need to have the following privileges: + - `Administrate` access on the database. content: application/json: schema: @@ -2071,24 +2182,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -2101,20 +2213,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -2163,13 +2276,13 @@ db._drop("relation"); examples.dropGraph("social"); ``` -### List edge definitions +### List edge collections ```openapi paths: /_api/gharial/{graph}/edge: get: - operationId: listEdgeDefinitions + operationId: listEdgeCollections description: | Lists all edge collections within this graph. parameters: @@ -2183,7 +2296,7 @@ paths: responses: '200': description: | - Is returned if the edge definitions could be listed. + Is returned if the edge definitions can be listed. content: application/json: schema: @@ -2195,23 +2308,24 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 collections: description: | - The list of all vertex collections within this graph. - Includes collections in edgeDefinitions as well as orphans. + A list of all edge collections used in the edge definitions + of this graph. type: array items: type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -2224,20 +2338,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -2273,11 +2388,12 @@ paths: Adds an additional edge definition to the graph. This edge definition has to contain a `collection` and an array of - each `from` and `to` vertex collections. An edge definition can only + each `from` and `to` vertex collections. An edge definition can only be added if this definition is either not used in any other graph, or - it is used with exactly the same definition. It is not possible to - store a definition "e" from "v1" to "v2" in the one graph, and "e" - from "v2" to "v1" in the other graph. + it is used with exactly the same definition. For example, it is not + possible to store a definition "e" from "v1" to "v2" in one graph, and + "e" from "v2" to "v1" in another graph, but both can have "e" from + "v1" to "v2". Additionally, collection creation options can be set. parameters: @@ -2332,8 +2448,8 @@ paths: responses: '201': description: | - Returned if the definition could be added successfully and - waitForSync is enabled for the `_graphs` collection. + Returned if the definition can be added successfully and + `waitForSync` is enabled for the `_graphs` collection. The response body contains the graph configuration that has been stored. content: application/json: @@ -2346,13 +2462,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the modified graph. @@ -2407,7 +2524,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -2458,8 +2575,8 @@ paths: type: boolean '202': description: | - Returned if the definition could be added successfully and - waitForSync is disabled for the `_graphs` collection. + Returned if the definition can be added successfully and + `waitForSync` is disabled for the `_graphs` collection. The response body contains the graph configuration that has been stored. content: application/json: @@ -2472,13 +2589,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the modified graph. @@ -2533,7 +2651,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -2584,8 +2702,8 @@ paths: type: boolean '400': description: | - Returned if the definition could not be added. - This could be because it is ill-formed, or + Returned if the definition can not be added. + This can be because it is ill-formed, or if the definition is used in another graph with a different signature. content: application/json: @@ -2599,25 +2717,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to modify a graph you at least need to have the following privileges + In order to modify a graph, you at least need to have the following privileges: content: application/json: schema: @@ -2630,24 +2749,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. content: application/json: schema: @@ -2660,20 +2780,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -2712,7 +2833,7 @@ paths: operationId: replaceEdgeDefinition description: | Change one specific edge definition. - This will modify all occurrences of this definition in all graphs known to your database. + This modifies all occurrences of this definition in all graphs known to your database. parameters: - name: graph in: path @@ -2740,7 +2861,7 @@ paths: required: false description: | Drop the collection as well. - Collection will only be dropped if it is not used in other graphs. + The collection is only dropped if it is not used in other graphs. schema: type: boolean requestBody: @@ -2787,7 +2908,7 @@ paths: responses: '201': description: | - Returned if the request was successful and waitForSync is true. + Returned if the request was successful and `waitForSync` is `true`. content: application/json: schema: @@ -2799,13 +2920,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the modified graph. @@ -2860,7 +2982,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -2911,7 +3033,7 @@ paths: type: boolean '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -2923,13 +3045,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the modified graph. @@ -2984,7 +3107,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -3048,26 +3171,27 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to drop a vertex you at least need to have the following privileges - 1. `Administrate` access on the Database. + In order to drop a vertex, you at least need to have the following privileges: + - `Administrate` access on the database. content: application/json: schema: @@ -3080,24 +3204,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found, or if no edge definition + Returned if no graph with this name can be found, or if no edge definition with this name is found in the graph. content: application/json: @@ -3111,20 +3236,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -3162,9 +3288,10 @@ paths: delete: operationId: deleteEdgeDefinition description: | - Remove one edge definition from the graph. This will only remove the - edge collection, the vertex collections remain untouched and can still - be used in your queries. + Remove one edge definition from the graph. This only removes the + edge collection from the graph definition. The vertex collections of the + edge definition become orphan collections but otherwise remain untouched + and can still be used in your queries. parameters: - name: graph in: path @@ -3192,14 +3319,14 @@ paths: required: false description: | Drop the collection as well. - Collection will only be dropped if it is not used in other graphs. + The collection is only dropped if it is not used in other graphs. schema: type: boolean responses: '201': description: | - Returned if the edge definition could be removed from the graph - and waitForSync is true. + Returned if the edge definition can be removed from the graph + and `waitForSync` is `true`. content: application/json: schema: @@ -3211,13 +3338,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 graph: description: | The information about the modified graph. @@ -3272,7 +3400,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -3323,8 +3451,8 @@ paths: type: boolean '202': description: | - Returned if the edge definition could be removed from the graph and - waitForSync is false. + Returned if the edge definition can be removed from the graph and + `waitForSync` is `false`. content: application/json: schema: @@ -3336,13 +3464,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 graph: description: | The information about the modified graph. @@ -3397,7 +3526,7 @@ paths: orphanCollections: description: | An array of additional vertex collections. - Documents within these collections do not have edges within this graph. + Documents in these collections do not have edges within this graph. type: array items: type: string @@ -3449,8 +3578,8 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to drop a vertex you at least need to have the following privileges - 1. `Administrate` access on the Database. + In order to drop a vertex, you at least need to have the following privileges: + - `Administrate` access on the database. content: application/json: schema: @@ -3463,24 +3592,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found, + Returned if no graph with this name can be found, or if no edge definition with this name is found in the graph. content: application/json: @@ -3494,20 +3624,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -3589,7 +3720,7 @@ paths: responses: '201': description: | - Returned if the vertex could be added and waitForSync is true. + Returned if the vertex can be added and `waitForSync` is `true`. content: application/json: schema: @@ -3601,13 +3732,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 vertex: description: | The internal attributes for the vertex. @@ -3634,7 +3766,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -3655,7 +3787,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -3667,13 +3799,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 vertex: description: | The internal attributes generated while storing the vertex. @@ -3701,7 +3834,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -3723,7 +3856,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to insert vertices into the graph you at least need to have the following privileges + In order to insert vertices into the graph, you at least need to have the following privileges: content: application/json: schema: @@ -3736,24 +3869,25 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | - Returned if no graph with this name could be found. + Returned if no graph with this name can be found. Or if a graph is found but this collection is not part of the graph. content: application/json: @@ -3767,20 +3901,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -3869,7 +4004,7 @@ paths: responses: '200': description: | - Returned if the vertex could be found. + Returned if the vertex can be found. content: application/json: schema: @@ -3881,13 +4016,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 vertex: description: | The complete vertex. @@ -3927,25 +4063,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 304 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to update vertices in the graph you at least need to have the following privileges + In order to update vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -3958,25 +4095,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The vertex does not exist. content: @@ -3991,20 +4129,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -4021,20 +4160,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -4148,7 +4288,7 @@ paths: responses: '200': description: | - Returned if the vertex could be updated, and waitForSync is true. + Returned if the vertex can be updated, and `waitForSync` is `true`. content: application/json: schema: @@ -4160,13 +4300,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 vertex: description: | The internal attributes for the vertex. @@ -4193,7 +4334,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -4216,7 +4357,7 @@ paths: description: | The complete overwritten vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4237,7 +4378,7 @@ paths: type: string '202': description: | - Returned if the request was successful, and waitForSync is false. + Returned if the request was successful, and `waitForSync` is `false`. content: application/json: schema: @@ -4249,13 +4390,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 vertex: description: | The internal attributes for the vertex. @@ -4282,7 +4424,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -4305,7 +4447,7 @@ paths: description: | The complete overwritten vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4327,7 +4469,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to update vertices in the graph you at least need to have the following privileges + In order to update vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -4340,25 +4482,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The vertex to update does not exist. content: @@ -4373,20 +4516,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -4403,20 +4547,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -4533,7 +4678,7 @@ paths: responses: '200': description: | - Returned if the vertex could be replaced, and waitForSync is true. + Returned if the vertex can be replaced, and `waitForSync` is `true`. content: application/json: schema: @@ -4545,13 +4690,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 vertex: description: | The internal attributes for the vertex. @@ -4578,7 +4724,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -4601,7 +4747,7 @@ paths: description: | The complete overwritten vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4622,7 +4768,7 @@ paths: type: string '202': description: | - Returned if the vertex could be replaced, and waitForSync is false. + Returned if the vertex can be replaced, and `waitForSync` is `false`. content: application/json: schema: @@ -4634,13 +4780,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 vertex: description: | The internal attributes for the vertex. @@ -4667,7 +4814,7 @@ paths: The complete newly written vertex document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -4690,7 +4837,7 @@ paths: description: | The complete overwritten vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4712,7 +4859,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to replace vertices in the graph you at least need to have the following privileges + In order to replace vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -4725,25 +4872,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The vertex to replace does not exist. content: @@ -4758,20 +4906,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -4788,20 +4937,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -4888,7 +5038,7 @@ paths: responses: '200': description: | - Returned if the vertex could be removed. + Returned if the vertex can be removed. content: application/json: schema: @@ -4900,13 +5050,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 removed: description: | Is set to true if the remove was successful. @@ -4915,7 +5066,7 @@ paths: description: | The complete deleted vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4936,7 +5087,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -4948,13 +5099,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 removed: description: | Is set to true if the remove was successful. @@ -4963,7 +5115,7 @@ paths: description: | The complete deleted vertex document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -4985,7 +5137,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to delete vertices in the graph you at least need to have the following privileges + In order to delete vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -4998,25 +5150,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The vertex to remove does not exist. content: @@ -5031,20 +5184,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -5061,20 +5215,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -5164,7 +5319,7 @@ paths: responses: '201': description: | - Returned if the edge could be created and waitForSync is true. + Returned if the edge can be created and `waitForSync` is `true`. content: application/json: schema: @@ -5176,13 +5331,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 edge: description: | The internal attributes for the edge. @@ -5219,7 +5375,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -5250,7 +5406,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -5262,13 +5418,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 edge: description: | The internal attributes for the edge. @@ -5305,7 +5462,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -5351,25 +5508,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 400 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to insert edges into the graph you at least need to have the following privileges + In order to insert edges into the graph, you at least need to have the following privileges: content: application/json: schema: @@ -5382,25 +5540,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in any of the following cases - - no graph with this name could be found. + - no graph with this name can be found. - the edge collection is not part of the graph. - the vertex collection referenced in the `_from` or `_to` attribute is not part of the graph. - the vertex collection is part of the graph, but does not exist. @@ -5417,20 +5576,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -5524,7 +5684,7 @@ paths: responses: '200': description: | - Returned if the edge could be found. + Returned if the edge can be found. content: application/json: schema: @@ -5536,13 +5696,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 edge: description: | The complete edge. @@ -5592,25 +5753,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 304 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '403': description: | Returned if your user has insufficient rights. - In order to update vertices in the graph you at least need to have the following privileges + In order to update vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -5623,25 +5785,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The edge does not exist. content: @@ -5656,20 +5819,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -5686,20 +5850,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -5814,7 +5979,7 @@ paths: responses: '200': description: | - Returned if the edge could be updated, and waitForSync is false. + Returned if the edge can be updated, and `waitForSync` is `false`. content: application/json: schema: @@ -5826,13 +5991,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 edge: description: | The internal attributes for the edge. @@ -5869,7 +6035,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -5902,7 +6068,7 @@ paths: description: | The complete overwritten edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -5933,7 +6099,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -5945,13 +6111,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 edge: description: | The internal attributes for the edge. @@ -5988,7 +6155,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -6021,7 +6188,7 @@ paths: description: | The complete overwritten edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6053,7 +6220,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to update edges in the graph you at least need to have the following privileges + In order to update edges in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -6066,25 +6233,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The edge to update does not exist. - either `_from` or `_to` vertex does not exist (if updated). @@ -6100,20 +6268,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -6130,20 +6299,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -6267,7 +6437,7 @@ paths: responses: '201': description: | - Returned if the request was successful but waitForSync is true. + Returned if the request was successful but `waitForSync` is `true`. content: application/json: schema: @@ -6279,13 +6449,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 201 edge: description: | The internal attributes for the edge @@ -6322,7 +6493,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -6355,7 +6526,7 @@ paths: description: | The complete overwritten edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6386,7 +6557,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -6398,13 +6569,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 edge: description: | The internal attributes for the edge @@ -6441,7 +6613,7 @@ paths: The complete newly written edge document. Includes all written attributes in the request body and all internal attributes generated by ArangoDB. - Will only be present if returnNew is true. + Only present if `returnNew` is `true`. type: object required: - _id @@ -6474,7 +6646,7 @@ paths: description: | The complete overwritten edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6506,7 +6678,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to replace edges in the graph you at least need to have the following privileges + In order to replace edges in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -6519,25 +6691,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The edge to replace does not exist. - either `_from` or `_to` vertex does not exist. @@ -6553,20 +6726,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -6583,20 +6757,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs @@ -6685,7 +6860,7 @@ paths: responses: '200': description: | - Returned if the edge could be removed. + Returned if the edge can be removed. content: application/json: schema: @@ -6697,13 +6872,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 200 removed: description: | Is set to true if the remove was successful. @@ -6712,7 +6888,7 @@ paths: description: | The complete deleted edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6743,7 +6919,7 @@ paths: type: string '202': description: | - Returned if the request was successful but waitForSync is false. + Returned if the request was successful but `waitForSync` is `false`. content: application/json: schema: @@ -6755,13 +6931,14 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is false in this response. + A flag indicating that no error occurred. type: boolean + example: false code: description: | - The response code. + The HTTP response status code. type: integer + example: 202 removed: description: | Is set to true if the remove was successful. @@ -6770,7 +6947,7 @@ paths: description: | The complete deleted edge document. Includes all attributes stored before this operation. - Will only be present if returnOld is true. + Only present if `returnOld` is `true`. type: object required: - _id @@ -6802,7 +6979,7 @@ paths: '403': description: | Returned if your user has insufficient rights. - In order to delete vertices in the graph you at least need to have the following privileges + In order to delete vertices in the graph, you at least need to have the following privileges: content: application/json: schema: @@ -6815,25 +6992,26 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 403 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '404': description: | Returned in the following cases - - No graph with this name could be found. + - No graph with this name can be found. - This collection is not part of the graph. - The edge to remove does not exist. content: @@ -6848,20 +7026,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 404 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string '412': description: | @@ -6878,20 +7057,21 @@ paths: properties: error: description: | - Flag if there was an error (true) or not (false). - It is true in this response. + A flag indicating that an error occurred. type: boolean + example: true code: description: | - The response code. + The HTTP response status code. type: integer + example: 412 errorNum: description: | ArangoDB error number for the error that occurred. type: integer errorMessage: description: | - A message created for this error. + A descriptive error message. type: string tags: - Graphs From 3d6f886e92eaa8438010e2a6a21445414f738e5c Mon Sep 17 00:00:00 2001 From: Simran Spiller Date: Mon, 11 Dec 2023 15:30:55 +0100 Subject: [PATCH 3/5] No intent to fix server side --- .../develop/http-api/graphs/named-graphs.md | 62 ------------------- 1 file changed, 62 deletions(-) diff --git a/site/content/3.12/develop/http-api/graphs/named-graphs.md b/site/content/3.12/develop/http-api/graphs/named-graphs.md index 07428135ad..2e26161f2d 100644 --- a/site/content/3.12/develop/http-api/graphs/named-graphs.md +++ b/site/content/3.12/develop/http-api/graphs/named-graphs.md @@ -1113,68 +1113,6 @@ graph._drop("myGraph", true); ### Drop a graph -{{< comment >}} -The API is supposed to return 201 if waitForSync is used and 202 otherwise, -but it actually returns 202 in all cases. Possibly to be adjusted in 3.12/4.0. - - '201': - description: | - Is returned if the graph can be dropped and `waitForSync` is enabled - for the `_graphs` collection, or given in the request. - content: - application/json: - schema: - type: object - required: - - error - - code - - removed - properties: - error: - description: | - A flag indicating that no error occurred. - type: boolean - example: false - code: - description: | - The HTTP response status code. - type: integer - example: 201 - removed: - description: | - Always `true`. - type: boolean - example: true - '202': - description: | - Is returned if the graph can be dropped and `waitForSync` is disabled - for the `_graphs` collection and not given in the request. - content: - application/json: - schema: - type: object - required: - - error - - code - - removed - properties: - error: - description: | - A flag indicating that no error occurred. - type: boolean - example: false - code: - description: | - The HTTP response status code. - type: integer - example: 202 - removed: - description: | - Always `true`. - type: boolean - example: true -{{< /comment >}} - ```openapi paths: /_api/gharial/{graph}: From 272e45a1236e99ee64629b1a380f581d129ce4b2 Mon Sep 17 00:00:00 2001 From: Simran Spiller Date: Mon, 11 Dec 2023 16:11:29 +0100 Subject: [PATCH 4/5] Typos --- .../develop/http-api/graphs/named-graphs.md | 49 ++++++++++--------- .../develop/http-api/graphs/named-graphs.md | 49 ++++++++++--------- .../develop/http-api/graphs/named-graphs.md | 49 ++++++++++--------- 3 files changed, 75 insertions(+), 72 deletions(-) diff --git a/site/content/3.10/develop/http-api/graphs/named-graphs.md b/site/content/3.10/develop/http-api/graphs/named-graphs.md index b331f35b24..b17a4cc266 100644 --- a/site/content/3.10/develop/http-api/graphs/named-graphs.md +++ b/site/content/3.10/develop/http-api/graphs/named-graphs.md @@ -100,7 +100,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -239,7 +239,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -379,7 +379,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -506,7 +506,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -643,9 +643,9 @@ paths: '409': description: | Returned if there is a conflict storing the graph. This can occur - either if a graph with this name is already stored, or if there is one - edge definition with the same edge collection but a different signature - used in any other graph. + either if a graph with this name already exists, or if there is an + edge definition with the same edge collection but different `from` + and `to` vertex collections in any other graph. content: application/json: schema: @@ -982,7 +982,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -1465,7 +1465,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -1592,7 +1592,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -1880,7 +1880,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -2005,7 +2005,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -2180,7 +2180,7 @@ paths: ```curl --- description: |- - You can remove vertex collections that are not used in any edge collection: + You can remove vertex collections that are not used in any edge definition: name: HttpGharialRemoveVertexCollection --- var examples = require("@arangodb/graph-examples/example-graph.js"); @@ -2200,7 +2200,7 @@ db._drop("otherVertices"); ```curl --- description: |- - You cannot remove vertex collections that are used in edge collections: + You cannot remove vertex collections that are used in edge definitions: name: HttpGharialRemoveVertexCollectionFailed --- var examples = require("@arangodb/graph-examples/example-graph.js"); @@ -2446,7 +2446,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -2573,7 +2573,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -2644,9 +2644,10 @@ paths: type: boolean '400': description: | - Returned if the definition can not be added. - This can be because it is ill-formed, or - if the definition is used in another graph with a different signature. + Returned if the edge definition can not be added. + This can be because it is ill-formed, or if there is an + edge definition with the same edge collection but different `from` + and `to` vertex collections in any other graph. content: application/json: schema: @@ -2905,7 +2906,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -3030,7 +3031,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -3323,7 +3324,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -3449,7 +3450,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -5219,7 +5220,7 @@ paths: description: | Creates a new edge in the specified collection. Within the body the edge has to contain a `_from` and `_to` value referencing to valid vertices in the graph. - Furthermore the edge has to be valid in the definition of the used edge collection. + Furthermore, the edge has to be valid according to the edge definitions. parameters: - name: graph in: path 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 b331f35b24..b17a4cc266 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 @@ -100,7 +100,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -239,7 +239,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -379,7 +379,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -506,7 +506,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -643,9 +643,9 @@ paths: '409': description: | Returned if there is a conflict storing the graph. This can occur - either if a graph with this name is already stored, or if there is one - edge definition with the same edge collection but a different signature - used in any other graph. + either if a graph with this name already exists, or if there is an + edge definition with the same edge collection but different `from` + and `to` vertex collections in any other graph. content: application/json: schema: @@ -982,7 +982,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -1465,7 +1465,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -1592,7 +1592,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -1880,7 +1880,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -2005,7 +2005,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -2180,7 +2180,7 @@ paths: ```curl --- description: |- - You can remove vertex collections that are not used in any edge collection: + You can remove vertex collections that are not used in any edge definition: name: HttpGharialRemoveVertexCollection --- var examples = require("@arangodb/graph-examples/example-graph.js"); @@ -2200,7 +2200,7 @@ db._drop("otherVertices"); ```curl --- description: |- - You cannot remove vertex collections that are used in edge collections: + You cannot remove vertex collections that are used in edge definitions: name: HttpGharialRemoveVertexCollectionFailed --- var examples = require("@arangodb/graph-examples/example-graph.js"); @@ -2446,7 +2446,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -2573,7 +2573,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -2644,9 +2644,10 @@ paths: type: boolean '400': description: | - Returned if the definition can not be added. - This can be because it is ill-formed, or - if the definition is used in another graph with a different signature. + Returned if the edge definition can not be added. + This can be because it is ill-formed, or if there is an + edge definition with the same edge collection but different `from` + and `to` vertex collections in any other graph. content: application/json: schema: @@ -2905,7 +2906,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -3030,7 +3031,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -3323,7 +3324,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -3449,7 +3450,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -5219,7 +5220,7 @@ paths: description: | Creates a new edge in the specified collection. Within the body the edge has to contain a `_from` and `_to` value referencing to valid vertices in the graph. - Furthermore the edge has to be valid in the definition of the used edge collection. + Furthermore, the edge has to be valid according to the edge definitions. parameters: - name: graph in: path diff --git a/site/content/3.12/develop/http-api/graphs/named-graphs.md b/site/content/3.12/develop/http-api/graphs/named-graphs.md index b331f35b24..b17a4cc266 100644 --- a/site/content/3.12/develop/http-api/graphs/named-graphs.md +++ b/site/content/3.12/develop/http-api/graphs/named-graphs.md @@ -100,7 +100,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -239,7 +239,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -379,7 +379,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -506,7 +506,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -643,9 +643,9 @@ paths: '409': description: | Returned if there is a conflict storing the graph. This can occur - either if a graph with this name is already stored, or if there is one - edge definition with the same edge collection but a different signature - used in any other graph. + either if a graph with this name already exists, or if there is an + edge definition with the same edge collection but different `from` + and `to` vertex collections in any other graph. content: application/json: schema: @@ -982,7 +982,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -1465,7 +1465,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -1592,7 +1592,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -1880,7 +1880,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -2005,7 +2005,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -2180,7 +2180,7 @@ paths: ```curl --- description: |- - You can remove vertex collections that are not used in any edge collection: + You can remove vertex collections that are not used in any edge definition: name: HttpGharialRemoveVertexCollection --- var examples = require("@arangodb/graph-examples/example-graph.js"); @@ -2200,7 +2200,7 @@ db._drop("otherVertices"); ```curl --- description: |- - You cannot remove vertex collections that are used in edge collections: + You cannot remove vertex collections that are used in edge definitions: name: HttpGharialRemoveVertexCollectionFailed --- var examples = require("@arangodb/graph-examples/example-graph.js"); @@ -2446,7 +2446,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -2573,7 +2573,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -2644,9 +2644,10 @@ paths: type: boolean '400': description: | - Returned if the definition can not be added. - This can be because it is ill-formed, or - if the definition is used in another graph with a different signature. + Returned if the edge definition can not be added. + This can be because it is ill-formed, or if there is an + edge definition with the same edge collection but different `from` + and `to` vertex collections in any other graph. content: application/json: schema: @@ -2905,7 +2906,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -3030,7 +3031,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -3323,7 +3324,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -3449,7 +3450,7 @@ paths: properties: collection: description: | - Name of the edge collection, where the edge are stored in. + Name of the edge collection, where the edges are stored in. type: string from: description: | @@ -5219,7 +5220,7 @@ paths: description: | Creates a new edge in the specified collection. Within the body the edge has to contain a `_from` and `_to` value referencing to valid vertices in the graph. - Furthermore the edge has to be valid in the definition of the used edge collection. + Furthermore, the edge has to be valid according to the edge definitions. parameters: - name: graph in: path From e70521168c148c86599588468015751f664508ae Mon Sep 17 00:00:00 2001 From: Simran Spiller Date: Mon, 11 Dec 2023 16:18:32 +0100 Subject: [PATCH 5/5] Fix indentation and JS API headline --- site/content/3.10/develop/http-api/graphs/named-graphs.md | 2 +- site/content/3.11/develop/http-api/graphs/named-graphs.md | 2 +- site/content/3.12/develop/http-api/graphs/named-graphs.md | 2 +- site/content/3.12/graphs/enterprisegraphs/management.md | 2 +- site/content/3.12/graphs/satellitegraphs/management.md | 2 +- site/content/3.12/graphs/smartgraphs/management.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/site/content/3.10/develop/http-api/graphs/named-graphs.md b/site/content/3.10/develop/http-api/graphs/named-graphs.md index b17a4cc266..8edd09bb45 100644 --- a/site/content/3.10/develop/http-api/graphs/named-graphs.md +++ b/site/content/3.10/develop/http-api/graphs/named-graphs.md @@ -1153,7 +1153,7 @@ paths: - code - removed properties: - error: + error: description: | A flag indicating that no error occurred. type: boolean 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 b17a4cc266..8edd09bb45 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 @@ -1153,7 +1153,7 @@ paths: - code - removed properties: - error: + error: description: | A flag indicating that no error occurred. type: boolean diff --git a/site/content/3.12/develop/http-api/graphs/named-graphs.md b/site/content/3.12/develop/http-api/graphs/named-graphs.md index b17a4cc266..8edd09bb45 100644 --- a/site/content/3.12/develop/http-api/graphs/named-graphs.md +++ b/site/content/3.12/develop/http-api/graphs/named-graphs.md @@ -1153,7 +1153,7 @@ paths: - code - removed properties: - error: + error: description: | A flag indicating that no error occurred. type: boolean diff --git a/site/content/3.12/graphs/enterprisegraphs/management.md b/site/content/3.12/graphs/enterprisegraphs/management.md index a1bfcbfe20..c07a5c3ef3 100644 --- a/site/content/3.12/graphs/enterprisegraphs/management.md +++ b/site/content/3.12/graphs/enterprisegraphs/management.md @@ -235,7 +235,7 @@ db._drop("vertices"); Alternatively, you can `truncate()` all collections of the graph if you just want to get rid of the data but keep the collections and graph definition. -## Remove an edge collection +## Remove an edge definition Delete an edge definition from the graph: diff --git a/site/content/3.12/graphs/satellitegraphs/management.md b/site/content/3.12/graphs/satellitegraphs/management.md index 9d8c7c9689..5daa3b4673 100644 --- a/site/content/3.12/graphs/satellitegraphs/management.md +++ b/site/content/3.12/graphs/satellitegraphs/management.md @@ -219,7 +219,7 @@ db._drop("vertices"); Alternatively, you can `truncate()` all collections of the graph if you just want to get rid of the data but keep the collections and graph definition. -### Remove an edge collection +### Remove an edge definition Delete an edge definition from the graph: diff --git a/site/content/3.12/graphs/smartgraphs/management.md b/site/content/3.12/graphs/smartgraphs/management.md index 732ea78c24..72e7be2204 100644 --- a/site/content/3.12/graphs/smartgraphs/management.md +++ b/site/content/3.12/graphs/smartgraphs/management.md @@ -253,7 +253,7 @@ db._drop("vertices"); Alternatively, you can `truncate()` all collections of the graph if you just want to get rid of the data but keep the collections and graph definition. -### Remove an edge collection +### Remove an edge definition Delete an edge definition from the graph: