8000 added HTTP API documentation for Pregel jobs overview (#992) · arangodb/docs@a7d3424 · GitHub
[go: up one dir, main page]

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

Commit a7d3424

Browse files
added HTTP API documentation for Pregel jobs overview (#992)
* added HTTP API documentation * Update examples for 3.9,3.10 in documentation/add-pregel-api at 2022-05-16T19:35:49+00:00 Co-authored-by: arangodb-release-bot <anastasia.soboleva@arangodb.com>
1 parent fe7991c commit a7d3424

File tree

659 files changed

+36647
-35565
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

659 files changed

+36647
-35565
lines changed
Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,63 @@
11
arangosh&gt; db.five.insert({ <span class="hljs-attr">name</span> : <span class="hljs-string">&quot;one&quot;</span> });
22
{
3-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/110&quot;</span>,
4-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;110&quot;</span>,
5-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6WG--_&quot;</span>
3+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/114&quot;</span>,
4+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;114&quot;</span>,
5+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJPq--_&quot;</span>
66
}
77
arangosh&gt; db.five.insert({ <span class="hljs-attr">name</span> : <span class="hljs-string">&quot;two&quot;</span> });
88
{
9-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/112&quot;</span>,
10-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;112&quot;</span>,
11-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6WK---&quot;</span>
9+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/116&quot;</span>,
10+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;116&quot;</span>,
11+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJPq--A&quot;</span>
1212
}
1313
arangosh&gt; db.five.insert({ <span class="hljs-attr">name</span> : <span class="hljs-string">&quot;three&quot;</span> });
1414
{
15-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/114&quot;</span>,
16-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;114&quot;</span>,
17-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6WK--_&quot;</span>
15+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/118&quot;</span>,
16+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;118&quot;</span>,
17+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJPu---&quot;</span>
1818
}
1919
arangosh&gt; db.five.insert({ <span class="hljs-attr">name</span> : <span class="hljs-string">&quot;four&quot;</span> });
2020
{
21-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/116&quot;</span>,
22-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;116&quot;</span>,
23-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6WK--A&quot;</span>
21+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/120&quot;</span>,
22+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;120&quot;</span>,
23+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJPu--_&quot;</span>
2424
}
2525
arangosh&gt; db.five.insert({ <span class="hljs-attr">name</span> : <span class="hljs-string">&quot;five&quot;</span> });
2626
{
27-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/118&quot;</span>,
28-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;118&quot;</span>,
29-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6WK--B&quot;</span>
27+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/122&quot;</span>,
28+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;122&quot;</span>,
29+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJPu--A&quot;</span>
3030
}
3131
arangosh&gt; db.five.all().toArray();
3232
[
3333
{
34-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;110&quot;</span>,
35-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/110&quot;</span>,
36-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6WG--_&quot;</span>,
34+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;114&quot;</span>,
35+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/114&quot;</span>,
36+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJPq--_&quot;</span>,
3737
<span class="hljs-string">&quot;name&quot;</span> : <span class="hljs-string">&quot;one&quot;</span>
3838
},
3939
{
40-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;112&quot;</span>,
41-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/112&quot;</span>,
42-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6WK---&quot;</span>,
40+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;116&quot;</span>,
41+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/116&quot;</span>,
42+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJPq--A&quot;</span>,
4343
<span class="hljs-string">&quot;name&quot;</span> : <span class="hljs-string">&quot;two&quot;</span>
4444
},
4545
{
46-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;114&quot;</span>,
47-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/114&quot;</span>,
48-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6WK--_&quot;</span>,
46+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;118&quot;</span>,
47+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/118&quot;</span>,
48+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJPu---&quot;</span>,
4949
<span class="hljs-string">&quot;name&quot;</span> : <span class="hljs-string">&quot;three&quot;</span>
5050
},
5151
{
52-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;116&quot;</span>,
53-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/116&quot;</span>,
54-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6WK--A&quot;</span>,
52+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;120&quot;</span>,
53+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/120&quot;</span>,
54+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJPu--_&quot;</span>,
5555
<span class="hljs-string">&quot;name&quot;</span> : <span class="hljs-string">&quot;four&quot;</span>
5656
},
5757
{
58-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;118&quot;</span>,
59-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/118&quot;</span>,
60-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6WK--B&quot;</span>,
58+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;122&quot;</span>,
59+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/122&quot;</span>,
60+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJPu--A&quot;</span>,
6161
<span class="hljs-string">&quot;name&quot;</span> : <span class="hljs-string">&quot;five&quot;</span>
6262
}
6363
]
Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,45 @@
11
arangosh&gt; db.five.insert({ <span class="hljs-attr">name</span> : <span class="hljs-string">&quot;one&quot;</span> });
22
{
3-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/130&quot;</span>,
4-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;130&quot;</span>,
5-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6X----&quot;</span>
3+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/134&quot;</span>,
4+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;134&quot;</span>,
5+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQe--_&quot;</span>
66
}
77
arangosh&gt; db.five.insert({ <span class="hljs-attr">name</span> : <span class="hljs-string">&quot;two&quot;</span> });
88
{
9-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/132&quot;</span>,
10-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;132&quot;</span>,
11-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6X---_&quot;</span>
9+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/136&quot;</span>,
10+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;136&quot;</span>,
11+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQi---&quot;</span>
1212
}
1313
arangosh&gt; db.five.insert({ <span class="hljs-attr">name</span> : <span class="hljs-string">&quot;three&quot;</span> });
1414
{
15-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/134&quot;</span>,
16-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;134&quot;</span>,
17-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6X---A&quot;</span>
15+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/138&quot;</span>,
16+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;138&quot;</span>,
17+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQi--_&quot;</span>
1818
}
1919
arangosh&gt; db.five.insert({ <span class="hljs-attr">name</span> : <span class="hljs-string">&quot;four&quot;</span> });
2020
{
21-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/136&quot;</span>,
22-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;136&quot;</span>,
23-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6X---B&quot;</span>
21+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/140&quot;</span>,
22+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;140&quot;</span>,
23+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQi--A&quot;</span>
2424
}
2525
arangosh&gt; db.five.insert({ <span class="hljs-attr">name</span> : <span class="hljs-string">&quot;five&quot;</span> });
2626
{
27-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/138&quot;</span>,
28-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;138&quot;</span>,
29-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6X---C&quot;</span>
27+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/142&quot;</span>,
28+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;142&quot;</span>,
29+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQi--B&quot;</span>
3030
}
3131
arangosh&gt; db.five.all().limit(<span class="hljs-number">2</span>).toArray();
3232
[
3333
{
34-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;130&quot;</span>,
35-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/130&quot;</span>,
36-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6X----&quot;</span>,
34+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;134&quot;</span>,
35+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/134&quot;</span>,
36+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQe--_&quot;</span>,
3737
<span class="hljs-string">&quot;name&quot;</span> : <span class="hljs-string">&quot;one&quot;</span>
3838
},
3939
{
40-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;132&quot;</span>,
41-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/132&quot;</span>,
42-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6X---_&quot;</span>,
40+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;136&quot;</span>,
41+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;five/136&quot;</span>,
42+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQi---&quot;</span>,
4343
<span class="hljs-string">&quot;name&quot;</span> : <span class="hljs-string">&quot;two&quot;</span>
4444
}
4545
]

3.10/generated/Examples/003_collectionByExample.generated

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
arangosh&gt; db.users.insert({ <span class="hljs-attr">name</span>: <span class="hljs-string">&quot;Gerhard&quot;</span> });
22
{
3-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/150&quot;</span>,
4-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;150&quot;</span>,
5-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6XO---&quot;</span>
3+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/154&quot;</span>,
4+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;154&quot;</span>,
5+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQu--_&quot;</span>
66
}
77
arangosh&gt; db.users.insert({ <span class="hljs-attr">name</span>: <span class="hljs-string">&quot;Helmut&quot;</span> });
88
{
9-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/152&quot;</span>,
10-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;152&quot;</span>,
11-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6XO--_&quot;</span>
9+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/156&quot;</span>,
10+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;156&quot;</span>,
11+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQu--A&quot;</span>
1212
}
1313
arangosh&gt; db.users.insert({ <span class="hljs-attr">name</span>: <span class="hljs-string">&quot;Angela&quot;</span> });
1414
{
15-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/154&quot;</span>,
16-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;154&quot;</span>,
17-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6XO--A&quot;</span>
15+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/158&quot;</span>,
16+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;158&quot;</span>,
17+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQy---&quot;</span>
1818
}
1919
arangosh&gt; db.users.all().toArray();
2020
[
2121
{
22-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;150&quot;</span>,
23-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/150&quot;</span>,
24-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6XO---&quot;</span>,
22+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;154&quot;</span>,
23+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/154&quot;</span>,
24+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQu--_&quot;</span>,
2525
<span class="hljs-string">&quot;name&quot;</span> : <span class="hljs-string">&quot;Gerhard&quot;</span>
2626
},
2727
{
28-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;152&quot;</span>,
29-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/152&quot;</span>,
30-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6XO--_&quot;</span>,
28+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;156&quot;</span>,
29+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/156&quot;</span>,
30+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQu--A&quot;</span>,
3131
<span class="hljs-string">&quot;name&quot;</span> : <span class="hljs-string">&quot;Helmut&quot;</span>
3232
},
3333
{
34-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;154&quot;</span>,
35-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/154&quot;</span>,
36-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6XO--A&quot;</span>,
34+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;158&quot;</span>,
35+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/158&quot;</span>,
36+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQy---&quot;</span>,
3737
<span class="hljs-string">&quot;name&quot;</span> : <span class="hljs-string">&quot;Angela&quot;</span>
3838
}
3939
]
@@ -42,9 +42,9 @@ arangosh&gt; db.users.byExample({ <span class="hljs-string">&quot;_id&quot;</spa
4242
arangosh&gt; db.users.byExample({ <span class="hljs-string">&quot;name&quot;</span> : <span class="hljs-string">&quot;Gerhard&quot;</span> }).toArray();
4343
[
4444
{
45-
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;150&quot;</span>,
46-
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/150&quot;</span>,
47-
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK0g6XO---&quot;</span>,
45+
<span class="hljs-string">&quot;_key&quot;</span> : <span class="hljs-string">&quot;154&quot;</span>,
46+
<span class="hljs-string">&quot;_id&quot;</span> : <span class="hljs-string">&quot;users/154&quot;</span>,
47+
<span class="hljs-string">&quot;_rev&quot;</span> : <span class="hljs-string">&quot;_eK3bJQu--_&quot;</span>,
4848
<span class="hljs-string">&quot;name&quot;</span> : <span class="hljs-string">&quot;Gerhard&quot;</span>
4949
}
5050
]

0 commit comments

Comments
 (0)
0