Skip to content

Changing docs URL #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
apetenchea merged 1 commit into from
Dec 20, 2025
Merged

Changing docs URL #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ async def main():
student_names.append(doc["name"])
```

Another example with [graphs](https://docs.arangodb.com/stable/graphs/):
Another example with [graphs](https://docs.arango.ai/stable/graphs/):

```python
async def main():
Expand Down
38 changes: 19 additions & 19 deletions arangoasync/aql.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ async def entries(self) -> Result[Jsons]:
AQLCacheEntriesError: If retrieval fails.

References:
- `list-the-entries-of-the-aql-query-results-cache <https://docs.arangodb.com/stable/develop/http-api/queries/aql-query-results-cache/#list-the-entries-of-the-aql-query-results-cache>`__
- `list-the-entries-of-the-aql-query-results-cache <https://docs.arango.ai/stable/develop/http-api/queries/aql-query-results-cache/#list-the-entries-of-the-aql-query-results-cache>`__
""" # noqa: E501
request = Request(method=Method.GET, endpoint="/_api/query-cache/entries")

Expand All @@ -99,7 +99,7 @@ async def plan_entries(self) -> Result[Jsons]:
AQLCacheEntriesError: If retrieval fails.

References:
- `list-the-entries-of-the-aql-query-plan-cache <https://docs.arangodb.com/stable/develop/http-api/queries/aql-query-plan-cache/#list-the-entries-of-the-aql-query-plan-cache>`__
- `list-the-entries-of-the-aql-query-plan-cache <https://docs.arango.ai/stable/develop/http-api/queries/aql-query-plan-cache/#list-the-entries-of-the-aql-query-plan-cache>`__
""" # noqa: E501
request = Request(method=Method.GET, endpoint="/_api/query-plan-cache")

Expand All @@ -117,7 +117,7 @@ async def clear(self) -> Result[None]:
AQLCacheClearError: If clearing the cache fails.

References:
- `clear-the-aql-query-results-cache <https://docs.arangodb.com/stable/develop/http-api/queries/aql-query-results-cache/#clear-the-aql-query-results-cache>`__
- `clear-the-aql-query-results-cache <https://docs.arango.ai/stable/develop/http-api/queries/aql-query-results-cache/#clear-the-aql-query-results-cache>`__
""" # noqa: E501
request = Request(method=Method.DELETE, endpoint="/_api/query-cache")

Expand All @@ -134,7 +134,7 @@ async def clear_plan(self) -> Result[None]:
AQLCacheClearError: If clearing the cache fails.

References:
- `clear-the-aql-query-plan-cache <https://docs.arangodb.com/stable/develop/http-api/queries/aql-query-plan-cache/#clear-the-aql-query-plan-cache>`__
- `clear-the-aql-query-plan-cache <https://docs.arango.ai/stable/develop/http-api/queries/aql-query-plan-cache/#clear-the-aql-query-plan-cache>`__
""" # noqa: E501
request = Request(method=Method.DELETE, endpoint="/_api/query-plan-cache")

Expand All @@ -154,7 +154,7 @@ async def properties(self) -> Result[QueryCacheProperties]:
AQLCachePropertiesError: If retrieval fails.

References:
- `get-the-aql-query-results-cache-configuration <https://docs.arangodb.com/stable/develop/http-api/queries/aql-query-results-cache/#get-the-aql-query-results-cache-configuration>`__
- `get-the-aql-query-results-cache-configuration <https://docs.arango.ai/stable/develop/http-api/queries/aql-query-results-cache/#get-the-aql-query-results-cache-configuration>`__
""" # noqa: E501
request = Request(method=Method.GET, endpoint="/_api/query-cache/properties")

Expand Down Expand Up @@ -193,7 +193,7 @@ async def configure(
AQLCacheConfigureError: If setting the configuration fails.

References:
- `set-the-aql-query-results-cache-configuration <https://docs.arangodb.com/stable/develop/http-api/queries/aql-query-results-cache/#set-the-aql-query-results-cache-configuration>`__
- `set-the-aql-query-results-cache-configuration <https://docs.arango.ai/stable/develop/http-api/queries/aql-query-results-cache/#set-the-aql-query-results-cache-configuration>`__
""" # noqa: E501
data: Json = dict()
if mode is not None:
Expand Down Expand Up @@ -298,7 +298,7 @@ async def execute(
Cursor: Result cursor.

References:
- `create-a-cursor <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#create-a-cursor>`__
- `create-a-cursor <https://docs.arango.ai/stable/develop/http-api/queries/aql-queries/#create-a-cursor>`__
""" # noqa: E501
data: Json = dict(query=query)
if count is not None:
Expand Down Expand Up @@ -353,7 +353,7 @@ async def tracking(self) -> Result[QueryTrackingConfiguration]:
AQLQueryTrackingGetError: If retrieval fails.

References:
- `get-the-aql-query-tracking-configuration <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#get-the-aql-query-tracking-configuration>`__
- `get-the-aql-query-tracking-configuration <https://docs.arango.ai/stable/develop/http-api/queries/aql-queries/#get-the-aql-query-tracking-configuration>`__
""" # noqa: E501
request = Request(method=Method.GET, endpoint="/_api/query/properties")

Expand Down Expand Up @@ -397,7 +397,7 @@ async def set_tracking(
AQLQueryTrackingSetError: If setting the configuration fails.

References:
- `update-the-aql-query-tracking-configuration <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#update-the-aql-query-tracking-configuration>`__
- `update-the-aql-query-tracking-configuration <https://docs.arango.ai/stable/develop/http-api/queries/aql-queries/#update-the-aql-query-tracking-configuration>`__
""" # noqa: E501
data: Json = dict()

Expand Down Expand Up @@ -462,7 +462,7 @@ async def queries(self, all_queries: bool = False) -> Result[Jsons]:
AQLQueryListError: If retrieval fails.

References:
- `list-the-running-queries <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#list-the-running-queries>`__
- `list-the-running-queries <https://docs.arango.ai/stable/develop/http-api/queries/aql-queries/#list-the-running-queries>`__
""" # noqa: E501
request = Request(
method=Method.GET,
Expand Down Expand Up @@ -493,7 +493,7 @@ async def slow_queries(self, all_queries: bool = False) -> Result[Jsons]:
AQLQueryListError: If retrieval fails.

References:
- `list-the-slow-aql-queries <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#list-the-slow-aql-queries>`__
- `list-the-slow-aql-queries <https://docs.arango.ai/stable/develop/http-api/queries/aql-queries/#list-the-slow-aql-queries>`__
""" # noqa: E501
request = Request(
method=Method.GET,
Expand Down Expand Up @@ -523,7 +523,7 @@ async def clear_slow_queries(self, all_queries: bool = False) -> Result[None]:
AQLQueryClearError: If retrieval fails.

References:
- `clear-the-list-of-slow-aql-queries <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#clear-the-list-of-slow-aql-queries>`__
- `clear-the-list-of-slow-aql-queries <https://docs.arango.ai/stable/develop/http-api/queries/aql-queries/#clear-the-list-of-slow-aql-queries>`__
""" # noqa: E501
request = Request(
method=Method.DELETE,
Expand Down Expand Up @@ -560,7 +560,7 @@ async def kill(
AQLQueryKillError: If killing the query fails.

References:
- `kill-a-running-aql-query <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#kill-a-running-aql-query>`__
- `kill-a-running-aql-query <https://docs.arango.ai/stable/develop/http-api/queries/aql-queries/#kill-a-running-aql-query>`__
""" # noqa: E501
request = Request(
method=Method.DELETE,
Expand Down Expand Up @@ -598,7 +598,7 @@ async def explain(
AQLQueryExplainError: If retrieval fails.

References:
- `explain-an-aql-query <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#explain-an-aql-query>`__
- `explain-an-aql-query <https://docs.arango.ai/stable/develop/http-api/queries/aql-queries/#explain-an-aql-query>`__
""" # noqa: E501
data: Json = dict(query=query)
if bind_vars is not None:
Expand Down Expand Up @@ -634,7 +634,7 @@ async def validate(self, query: str) -> Result[Json]:
AQLQueryValidateError: If validation fails.

References:
- `parse-an-aql-query <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#parse-an-aql-query>`__
- `parse-an-aql-query <https://docs.arango.ai/stable/develop/http-api/queries/aql-queries/#parse-an-aql-query>`__
""" # noqa: E501
request = Request(
method=Method.POST,
Expand All @@ -659,7 +659,7 @@ async def query_rules(self) -> Result[Jsons]:
AQLQueryRulesGetError: If retrieval fails.

References:
- `list-all-aql-optimizer-rules <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#list-all-aql-optimizer-rules>`__
- `list-all-aql-optimizer-rules <https://docs.arango.ai/stable/develop/http-api/queries/aql-queries/#list-all-aql-optimizer-rules>`__
""" # noqa: E501
request = Request(method=Method.GET, endpoint="/_api/query/rules")

Expand All @@ -684,7 +684,7 @@ async def functions(self, namespace: Optional[str] = None) -> Result[Jsons]:
AQLFunctionListError: If retrieval fails.

References:
- `list-the-registered-user-defined-aql-functions <https://docs.arangodb.com/stable/develop/http-api/queries/user-defined-aql-functions/#list-the-registered-user-defined-aql-functions>`__
- `list-the-registered-user-defined-aql-functions <https://docs.arango.ai/stable/develop/http-api/queries/user-defined-aql-functions/#list-the-registered-user-defined-aql-functions>`__
""" # noqa: E501
params: Json = dict()
if namespace is not None:
Expand Down Expand Up @@ -726,7 +726,7 @@ async def create_function(
AQLFunctionCreateError: If registration fails.

References:
- `create-a-user-defined-aql-function <https://docs.arangodb.com/stable/develop/http-api/queries/user-defined-aql-functions/#create-a-user-defined-aql-function>`__
- `create-a-user-defined-aql-function <https://docs.arango.ai/stable/develop/http-api/queries/user-defined-aql-functions/#create-a-user-defined-aql-function>`__
""" # noqa: E501
request = Request(
method=Method.POST,
Expand Down Expand Up @@ -765,7 +765,7 @@ async def delete_function(
AQLFunctionDeleteError: If removal fails.

References:
- `remove-a-user-defined-aql-function <https://docs.arangodb.com/stable/develop/http-api/queries/user-defined-aql-functions/#remove-a-user-defined-aql-function>`__
- `remove-a-user-defined-aql-function <https://docs.arango.ai/stable/develop/http-api/queries/user-defined-aql-functions/#remove-a-user-defined-aql-function>`__
""" # noqa: E501
params: Json = dict()
if group is not None:
Expand Down
12 changes: 6 additions & 6 deletions arangoasync/backup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ async def get(self, backup_id: Optional[str] = None) -> Result[Json]:
BackupGetError: If the operation fails.

References:
- `list-backups <https://docs.arangodb.com/stable/develop/http-api/hot-backups/#list-all-backups>`__
- `list-backups <https://docs.arango.ai/stable/develop/http-api/hot-backups/#list-all-backups>`__
""" # noqa: E501
data: Json = {}
if backup_id is not None:
Expand Down Expand Up @@ -97,7 +97,7 @@ async def create(
BackupCreateError: If the backup creation fails.

References:
- `create-backup <https://docs.arangodb.com/stable/develop/http-api/hot-backups/#create-a-backup>`__
- `create-backup <https://docs.arango.ai/stable/develop/http-api/hot-backups/#create-a-backup>`__
""" # noqa: E501
data: Json = {}
if label is not None:
Expand Down Expand Up @@ -137,7 +137,7 @@ async def restore(self, backup_id: str) -> Result[Json]:
BackupRestoreError: If the restore operation fails.

References:
- `restore-backup <https://docs.arangodb.com/stable/develop/http-api/hot-backups/#restore-a-backup>`__
- `restore-backup <https://docs.arango.ai/stable/develop/http-api/hot-backups/#restore-a-backup>`__
""" # noqa: E501
data: Json = {"id": backup_id}
request = Request(
Expand Down Expand Up @@ -165,7 +165,7 @@ async def delete(self, backup_id: str) -> None:
BackupDeleteError: If the delete operation fails.

References:
- `delete-backup <https://docs.arangodb.com/stable/develop/http-api/hot-backups/#delete-a-backup>`__
- `delete-backup <https://docs.arango.ai/stable/develop/http-api/hot-backups/#delete-a-backup>`__
""" # noqa: E501
data: Json = {"id": backup_id}
request = Request(
Expand Down Expand Up @@ -209,7 +209,7 @@ async def upload(
BackupUploadError: If upload operation fails.

References:
- `upload-a-backup-to-a-remote-repository <https://docs.arangodb.com/stable/develop/http-api/hot-backups/#upload-a-backup-to-a-remote-repository>`__
- `upload-a-backup-to-a-remote-repository <https://docs.arango.ai/stable/develop/http-api/hot-backups/#upload-a-backup-to-a-remote-repository>`__
""" # noqa: E501
data: Json = {}
if upload_id is not None:
Expand Down Expand Up @@ -265,7 +265,7 @@ async def download(
BackupDownloadError: If the download operation fails.

References:
- `download-a-backup-from-a-remote-repository <https://docs.arangodb.com/stable/develop/http-api/hot-backups/#download-a-backup-from-a-remote-repository>`__
- `download-a-backup-from-a-remote-repository <https://docs.arango.ai/stable/develop/http-api/hot-backups/#download-a-backup-from-a-remote-repository>`__
""" # noqa: E501
data: Json = {}
if download_id is not None:
Expand Down
Loading
Loading