8000 [DE-728] Updated documentation links (#549) · rashtao/arangodb-java-driver@56ebe64 · GitHub
[go: up one dir, main page]
Skip to content

Commit 56ebe64

Browse files
rashtaorashtao
committed
[DE-728] Updated documentation links (arangodb#549)
* upd cookbook links * upd links in examples * upd homepage links * upd ArangoCollection links * upd ArangoDatabase links * upd ArangoDB links * upd graph API links * upd search API links * upd entity and model links * upd links to devel * added missing API links
1 parent 436bb8e commit 56ebe64

File tree

115 files changed

+296
-399
lines changed

Some content is hidden

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

115 files changed

+296
-399
lines changed

‎ChangeLog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ Any usage of the current Java driver API related to it is therefore discouraged.
516516

517517
### Added
518518

519-
- added dirty read support ([reading from followers](https://www.arangodb.com/docs/stable/administration-active-failover.html#reading-from-follower))
519+
- added dirty read support ([reading from followers](https://docs.arangodb.com/stable/deploy/active-failover/administration/#reading-from-follower))
520520

521521
- added option `AqlQueryOptions#allowDirtyRead` for `ArangoDatabase#query`.
522522
- added option `DocumentReadOptions#allowDirtyRead` for `ArangoCollection#getDocument`

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![ArangoDB-Logo](https://www.arangodb.com/docs/assets/arangodb_logo_2016_inverted.png)
1+
![ArangoDB-Logo](https://user-images.githubusercontent.com/3998723/207981337-79d49127-48fc-4c7c-9411-8a688edca1dd.png)
22

33
# ArangoDB Java Driver
44

@@ -11,6 +11,6 @@ The official [ArangoDB](https://www.arangodb.com/) Java Driver.
1111

1212
- [ChangeLog](ChangeLog.md)
1313
- [Examples](driver/src/test/java/com/arangodb/example)
14-
- [Tutorial](https://www.arangodb.com/docs/stable/drivers/java-tutorial.html)
15-
- [Documentation](https://www.arangodb.com/docs/stable/drivers/java.html)
14+
- [Tutorial](https://university.arangodb.com/courses/java-driver-tutorial-v7/)
15+
- [Documentation](https://docs.arangodb.com/stable/develop/drivers/java/)
1616
- [JavaDoc](https://www.javadoc.io/doc/com.arangodb/arangodb-java-driver/latest/index.html)

‎core/src/main/java/com/arangodb/ArangoCollection.java

Lines changed: 83 additions & 71 deletions
Large diffs are not rendered by default.

‎core/src/main/java/com/arangodb/ArangoDB.java

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ public interface ArangoDB extends ArangoSerdeAccessor {
100100
*
101101
* @param name Name of the database to create
102102
* @return true if the database was created successfully.
103-
* @see <a href="https://www.arangodb.com/docs/stable/http/database-database-management.html#create-database">API
103+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/databases/#create-a-database">API
104104
* Documentation</a>
105105
*/
106106
Boolean createDatabase(String name);
@@ -110,7 +110,7 @@ public interface ArangoDB extends ArangoSerdeAccessor {
110110
*
111111
* @param options Creation options
112112
* @return true if the database was created successfully.
113-
* @see <a href="https://www.arangodb.com/docs/stable/http/database-database-management.html#create-database">API
113+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/databases/#create-a-database">API
114114
* Documentation</a>
115115
* @since ArangoDB 3.6.0
116116
*/
@@ -120,7 +120,7 @@ public interface ArangoDB extends ArangoSerdeAccessor {
120120
* Retrieves a list of all existing databases
121121
*
122122
* @return a list of all existing databases
123-
* @see <a href="https://www.arangodb.com/docs/stable/http/database-database-management.html#list-of-databases">API
123+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/databases/#list-all-databases">API
124124
* Documentation</a>
125125
*/
126126
Collection<String> getDatabases();
@@ -130,7 +130,7 @@ public interface ArangoDB extends Aran F438 goSerdeAccessor {
130130
*
131131
* @return a list of all databases the current user can access
132132
* @see <a href=
133-
* "https://www.arangodb.com/docs/stable/http/database-database-management.html#list-of-accessible-databases">API
133+
* "https://docs.arangodb.com/stable/develop/http-api/databases/#list-the-accessible-databases">API
134134
* Documentation</a>
135135
*/
136136
Collection<String> getAccessibleDatabases();
@@ -141,7 +141,7 @@ public interface ArangoDB extends ArangoSerdeAccessor {
141141
* @param user The name of the user for which you want to query the databases
142142
* @return list of database names which are available for the specified user
143143
* @see <a href=
144-
* "https://www.arangodb.com/docs/stable/http/user-management.html#list-the-accessible-databases-for-a-user">API
144+
* "https://docs.arangodb.com/stable/develop/http-api/users/#list-a-users-accessible-databases">API
145145
* Documentation</a>
146146
*/
147147
Collection<String> getAccessibleDatabasesFor(String user);
@@ -150,7 +150,7 @@ public interface ArangoDB extends ArangoSerdeAccessor {
150150
* Returns the server name and version number.
151151
*
152152
* @return the server version, number
153-
* @see <a href="https://www.arangodb.com/docs/stable/http/miscellaneous-functions.html#return-server-version">API
153+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/administration/#get-the-server-version">API
154154
* Documentation</a>
155155
*/
156156
ArangoDBVersion getVersion();
@@ -160,7 +160,7 @@ public interface ArangoDB extends ArangoSerdeAccessor {
160160
*
161161
* @return the storage engine name
162162
* @see <a
163-
* href="https://www.arangodb.com/docs/stable/http/miscellaneous-functions.html#return-server-database-engine-type">API
163+
* href="https://docs.arangodb.com/stable/develop/http-api/administration/#get-the-storage-engine-type">API
164164
* Documentation</a>
165165
*/
166166
ArangoDBEngine getEngine();
@@ -169,6 +169,9 @@ public interface ArangoDB extends ArangoSerdeAccessor {
169169
* Returns the server role.
170170
*
171171
* @return the server role
172+
* @see <a
173+
* href="https://docs.arangodb.com/stable/develop/http-api/cluster/#get-the-server-role">API
174+
* Documentation</a>
172175
*/
173176
ServerRole getRole();
174177

@@ -177,7 +180,7 @@ public interface ArangoDB extends ArangoSerdeAccessor {
177180
*
178181
* @return the server id
179182
* @see <a
180-
* href="https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#return-id-of-a-server-in-a-cluster">API
183+
* href="https://docs.arangodb.com/stable/develop/http-api/cluster/#get-the-server-id">API
181184
* Documentation</a>
182185
*/
183186
String getServerId();
@@ -189,7 +192,7 @@ public interface ArangoDB extends ArangoSerdeAccessor {
189192
* @param user The name of the user
190193
* @param passwd The user password
191194
* @return information about the user
192-
* @see <a href="https://www.arangodb.com/docs/stable/http/user-management.html#create-user">API Documentation</a>
195+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/users/#create-a-user">API Documentation</a>
193196
*/
194197
UserEntity createUser(String user, String passwd);
195198

@@ -201,15 +204,15 @@ public interface ArangoDB extends ArangoSerdeAccessor {
201204
* @param passwd The user password
202205
* @param options Additional options, can be null
203206
* @return information about the user
204-
* @see <a href="https://www.arangodb.com/docs/stable/http/user-management.html#create-user">API Documentation</a>
207+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/users/#create-a-user">API Documentation</a>
205208
*/
206209
UserEntity createUser(String user, String passwd, UserCreateOptions options);
207210

208211
/**
209212
* Removes an existing user, identified by user. You need access to the _system database.
210213
*
211214
* @param user The name of the user
212-
* @see <a href="https://www.arangodb.com/docs/stable/http/user-management.html#remove-user">API Documentation</a>
215+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/users/#remove-a-user">API Documentation</a>
213216
*/
214217
void deleteUser(String user);
215218

@@ -219,15 +222,15 @@ public interface ArangoDB extends ArangoSerdeAccessor {
219222
*
220223
* @param user The name of the user
221224
* @return information about the user
222-
* @see <a href="https://www.arangodb.com/docs/stable/http/user-management.html#fetch-user">API Documentation</a>
225+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/users/#get-a-user">API Documentation</a>
223226
*/
224227
UserEntity getUser(String user);
225228

226229
/**
227230
* Fetches data about all users. You can only execute this call if you have access to the _system database.
228231
*
229232
* @return informations about all users
230-
* @see <a href="https://www.arangodb.com/docs/stable/http/user-management.html#list-available-users">API
233+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/users/#list-available-users">API
231234
* Documentation</a>
232235
*/
233236
Collection<UserEntity> getUsers();
@@ -239,7 +242,7 @@ public interface ArangoDB extends ArangoSerdeAccessor {
239242
* @param user The name of the user
240243
* @param options Properties of the user to be changed
241244
* @return information about the user
242-
* @see <a href="https://www.arangodb.com/docs/stable/http/user-management.html#modify-user">API Documentation</a>
245+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/users/#update-a-user">API Documentation</a>
243246
*/
244247
UserEntity updateUser(String user, UserUpdateOptions options);
245248

@@ -250,7 +253,7 @@ public interface ArangoDB extends ArangoSerdeAccessor {
250253
* @param user The name of the user
251254
* @param options Additional properties of the user, can be null
252255
* @return information about the user
253-
* @see <a href="https://www.arangodb.com/docs/stable/http/user-management.html#replace-user">API
256+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/users/#replace-a-user">API
254257
* Documentation</a>
255258
*/
256259
UserEntity replaceUser(String user, UserUpdateOptions options);
@@ -262,6 +265,8 @@ public interface ArangoDB extends ArangoSerdeAccessor {
262265
* @param user The name of the user
263266
* @param permissions The permissions the user grant
264267
* @since ArangoDB 3.2.0
268+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/users/#set-a-users-database-access-level">API
269+
* Documentation</a>
265270
*/
266271
void grantDefaultDatabaseAccess(String user, Permissions permissions);
267272

@@ -272,6 +277,8 @@ public interface ArangoDB extends ArangoSerdeAccessor {
272277
* @param user The name of the user
273278
* @param permissions The permissions the user grant
274279
* @since ArangoDB 3.2.0
280+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/users/#set-a-users-collection-access-level">API
281+
* Documentation</a>
275282
*/
276283
void grantDefaultCollectionAccess(String user, Permissions permissions);
277284

@@ -280,9 +287,9 @@ public interface ArangoDB extends ArangoSerdeAccessor {
280287
* query parameters, headers and body payload.
281288
* This method can be used to call FOXX services, API endpoints not (yet) implemented in this driver or trigger
282289
* async jobs, see
283-
* <a href="https://www.arangodb.com/docs/stable/http/async-results-management.html#fire-and-forget">Fire and Forget</a>
290+
* <a href="https://docs.arangodb.com/stable/develop/http-api/general-request-handling/#fire-and-forget">Fire and Forget</a>
284291
* and
285-
* <a href="https://www.arangodb.com/docs/stable/http/async-results-management.html#async-execution-and-later-result-retrieval">Async Execution and later Result Retrieval</a>
292+
* <a href="https://docs.arangodb.com/stable/develop/http-api/general-request-handling/#async-execution-and-later-result-retrieval">Async Execution and later Result Retrieval</a>
286293
*
287294
* @param request request
288295
* @param type Deserialization target type for the response body (POJO or {@link com.arangodb.util.RawData})
@@ -296,7 +303,7 @@ public interface ArangoDB extends ArangoSerdeAccessor {
296303
* @param options Additional options, can be null
297304
* @return the log messages
298305
* @see <a href=
299-
* "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#read-global-logs-from-the-server">API
306+
* "https://docs.arangodb.com/stable/develop/http-api/monitoring/logs/#get-the-global-server-logs">API
300307
* Documentation</a>
301308
* @since ArangoDB 3.8
302309
*/
@@ -307,6 +314,8 @@ public interface ArangoDB extends ArangoSerdeAccessor {
307314
*
308315
* @return the server's current loglevel settings
309316
* @since ArangoDB 3.1.0
317+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/monitoring/logs/#get-the-server-log-levels">API
318+
* Documentation</a>
310319
*/
311320
LogLevelEntity getLogLevel();
312321

@@ -315,6 +324,8 @@ public interface ArangoDB extends ArangoSerdeAccessor {
315324
*
316325
* @return the server's current loglevel settings
317326
* @since ArangoDB 3.10
327+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/monitoring/logs/#get-the-server-log-levels">API
328+
* Documentation</a>
318329
*/
319330
LogLevelEntity getLogLevel(LogLevelOptions options);
320331

@@ -324,6 +335,8 @@ public interface ArangoDB extends ArangoSerdeAccessor {
324335
* @param entity loglevel settings
325336
* @return the server's current loglevel settings
326337
* @since ArangoDB 3.1.0
338+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/monitoring/logs/#set-the-server-log-levels">API
339+
* Documentation</a>
327340
*/
328341
LogLevelEntity setLogLevel(LogLevelEntity entity);
329342

@@ -333,12 +346,16 @@ public interface ArangoDB extends ArangoSerdeAccessor {
333346
* @param entity loglevel settings
334347
* @return the server's current loglevel settings
335348
* @since ArangoDB 3.10
349+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/monitoring/logs/#set-the-server-log-levels">API
350+
* Documentation</a>
336351
*/
337352
LogLevelEntity setLogLevel(LogLevelEntity entity, LogLevelOptions options);
338353

339354
/**
340355
* @return the list of available rules and their respective flags
341356
* @since ArangoDB 3.10
357+
* @see <a href="https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#list-all-aql-optimizer-rules">API
358+
* Documentation</a>
342359
*/
343360
Collection<QueryOptimizerRule> getQueryOptimizerRules();
344361

0 commit comments

Comments
 (0)
0