Skip to content
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

DOC-440 | Add interface examples for APIs and GUI (Concepts section) #648

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

DOC-440 | Add interface examples for APIs and GUI (Concepts section) #648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cb351dd
Add interface examples for databases, collection, Views
Simran-B Dec 4, 2024
ddce1c8
Explicitly use _system database for endpoints that require it in curl…
Simran-B Dec 9, 2024
d52bde4
Simpler collection properties examples, use _system db where necessary
Simran-B Dec 9, 2024
11ec902
More examples, fixes
Simran-B Dec 17, 2024
59ece1d
Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC…
Simran-B Dec 17, 2024
863a3ff
Fix link
Simran-B Dec 17, 2024
52c9e86
Fix another link
Simran-B Dec 17, 2024
05c8e55
README: cURL example can fail if the URL doesn't specify /_db/_system…
Simran-B Jan 20, 2025
da0cdf8
Fix arangosh example ID
Simran-B Jan 20, 2025
34923f1
Computed values interface examples
Simran-B Jan 20, 2025
0af31c4
Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC…
Simran-B Jan 20, 2025
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1384,6 +1384,11 @@ logJsonResponse(response);
```
````

If an endpoint requires the `_system` database as the context, the URL should be
set accordingly, e.g. `var url = "/_db/_system/_api/database";`. This ensures
that the request is issued correctly as the toolchain may process other examples
that change the database context simultaneously.

Unlike arangosh examples (`` ```js ``), requests and responses
need to be output explicitly by calling one of the following functions:

Expand Down
Loading