Skip to content

Aura Query API tutorial #647

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

Closed
wants to merge 9 commits into from
Closed

Aura Query API tutorial #647

wants to merge 9 commits into from

Conversation

fiquick
Copy link
Collaborator

@fiquick fiquick commented Mar 19, 2025

No description provided.

@fiquick fiquick requested a review from AlexicaWright March 19, 2025 16:22
https://537dfda7.databases.neo4j.io/db/neo4j/query/v2
----

=== Explanation
Copy link
Contributor

Choose a reason for hiding this comment

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

I recommend using callouts directly in the example (# <.>). In this way you don't need to repeat all the parameters, and the distance between the example and its clarifications is shorter.

For an example, see https://github.com/neo4j/docs-drivers/blob/dev/python-manual/modules/ROOT/pages/query-simple.adoc?plain=1#L15


== Next Steps

Try executing different Cypher queries to retrieve, update, or delete nodes in your Aura database.
Copy link
Contributor

Choose a reason for hiding this comment

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

It's a nice intention, but too broad. Either you give people a specific task, or this just sounds as "Now you are ready to go into the world, good luck", which is superflous.

----
https://537dfda7.databases.neo4j.io/db/neo4j/query/v2
----

Copy link
Collaborator Author

@fiquick fiquick Mar 21, 2025

Choose a reason for hiding this comment

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

Add the custom endpoint for aura info

Then we don't need anything from curl queries onwards and examples - that can go in Query API docs

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Could use a tabbed example in the Query API docs

@neo-technology-commit-status-publisher
Copy link
Collaborator

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

@fiquick fiquick closed this Mar 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants