-
Notifications
You must be signed in to change notification settings - Fork 6
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.
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
base: main
Are you sure you want to change the base?
Conversation
Deploy Preview Available Via |
/generate |
/generate |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've only checked the arangojs examples but they LGTM
site/content/3.12/concepts/data-structure/documents/schema-validation.md
Outdated
Show resolved
Hide resolved
… for endpoints that require this context
site/content/3.12/concepts/data-structure/documents/computed-values.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Python examples look good,2 small adjustments:
site/content/3.12/concepts/data-structure/documents/computed-values.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Michele Rastelli <[email protected]> Co-authored-by: Anthony Mahanna <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
Add examples for all official drivers, cURL, and the web interface to the pages under Concepts > Data structure for common operations that were previously only described for arangosh.
The driver code examples must be reviewed and possibly adjusted to include some error handling.
Up for discussion: How much should the examples show? For example, should setting options like
returnNew
be covered or should the examples rather be kept as minimal as possible?Preview: https://deploy-preview-648--docs-hugo.netlify.app/stable/concepts/data-structure/databases/#set-the-database-context ff.
Upstream PRs