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.

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 12 commits into
base: main
Choose a base branch
from

Conversation

Simran-B
Copy link
Contributor

@Simran-B Simran-B commented Dec 4, 2024

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.

  • Databases
  • Collections
  • Views
  • Documents
    • Computed Values
    • Schema Validation

Upstream PRs

  • 3.10:
  • 3.11: arangodb/enterprise:3.11.12
  • 3.12: arangodb/enterprise-preview:devel-nightly
  • 3.13: arangodb/enterprise-preview:devel-nightly

@Simran-B Simran-B self-assigned this Dec 4, 2024
Copy link
Contributor

Deploy Preview Available Via
https://deploy-preview-648--docs-hugo.netlify.app

@Simran-B
Copy link
Contributor Author

Simran-B commented Dec 4, 2024

/generate

@Simran-B
Copy link
Contributor Author

Simran-B commented Dec 9, 2024

/generate

@Simran-B Simran-B marked this pull request as ready for review December 17, 2024 21:12
Copy link
Member

@pluma4345 pluma4345 left a 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

@Simran-B Simran-B changed the title DOC-440 | Add interface examples for APIs and GUI DOC-440 | Add interface examples for APIs and GUI (Concepts section) Jan 20, 2025
Copy link
Member

@aMahanna aMahanna left a 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:

Co-authored-by: Michele Rastelli <[email protected]>
Co-authored-by: Anthony Mahanna <[email protected]>
Copy link
Member

@pluma4345 pluma4345 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :shipit:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants