API Updates#372

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

apetenchea merged 3 commits intomainfromchore/api-update

Jun 4, 2025

Merged

API Updates#372

apetenchea merged 3 commits intomainfromchore/api-update

Jun 4, 2025

Conversation

Copy link

Member

apetenchea commentedJun 1, 2025•
edited
Loading

This PR does not modify much of the implementation, but adds or removes parameters to some of the graph-related functions.

Vertex and Edge collections don't (actually never did) support thesilent parameter. This could be confusing and it just makes type hinting more awkward because we have to return anUnion instead of the actual type. Seehttps://docs.arangodb.com/stable/develop/http-api/graphs/named-graphs/.
Creating a vertex or edge collection has an additionaloptions parameter which was not available in the driver.
replace_edge_definition andreplace_vertex were missing thesync parameter.
Theedge_collections method was missing. It corresponds tohttps://docs.arangodb.com/stable/develop/http-api/graphs/named-graphs/#list-edge-collections
Added comments ingraph.rst in order to clear up confusion about our "Edge definitions" example (seeUpdate graph.rst - teachers to lectures #371)

Changed the driver version, so we can do a new release.

apetenchea added2 commits

June 1, 2025 11:52

Updated API

1cc4908

Bumping up driver version

317847d

apetenchea self-assigned this

Jun 1, 2025

Updating docs

49b2997

apetenchea requested a review fromaMahanna

June 1, 2025 12:11

Copy link

codecov-commenter commentedJun 2, 2025•
edited
Loading

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is85.29412% with5 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.89%. Comparing base (8e6aaca) to head (49b2997).
⚠️ Report is 27 commits behind head on main.

Files with missing lines	Patch %	Lines
arango/graph.py	78.26%	5 Missing⚠️
❗ Your organization needs to install theCodecov GitHub app to enable full functionality.

❗ There is a different number of reports uploaded between BASE (8e6aaca) and HEAD (49b2997). Click for more details.
HEAD has 1 upload less than BASE
Flag BASE (8e6aaca) HEAD (49b2997)
3 2

Additional details and impacted files

@@             Coverage Diff             @@##             main     #372       +/-   ##===========================================- Coverage   95.94%   83.89%   -12.06%===========================================  Files          26       26                 Lines        4296     4322       +26     ===========================================- Hits         4122     3626      -496- Misses        174      696      +522

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report?Share it here.

🚀 New features to boost your workflow: