Skip to content

Only the Transactional API is deprecated and replaced by Query API#158

Closed
renetapopova wants to merge 2 commits into
neo4j:devfrom
renetapopova:dev-deprecate-transactional-api
Closed

Only the Transactional API is deprecated and replaced by Query API#158
renetapopova wants to merge 2 commits into
neo4j:devfrom
renetapopova:dev-deprecate-transactional-api

Conversation

@renetapopova
Copy link
Copy Markdown
Collaborator

@renetapopova renetapopova commented Apr 9, 2026

Copy link
Copy Markdown

@bigmontz bigmontz left a comment

Choose a reason for hiding this comment

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

For pages which are describing deprecated apis, it might be clear to add the deprecated badge in the page.

@NataliaIvakina
Copy link
Copy Markdown
Collaborator

I don't know why but in the preview there no 'Deprecated in 5.26' labels on the page level. You see only 'Not available on Aura'
Screenshot 2026-04-09 at 13 40 09

@NataliaIvakina
Copy link
Copy Markdown
Collaborator

I might be wrong but it seems that page-role: not-on-aura in the publish and preview files overwrites "local" page-role on the pages

Comment thread modules/ROOT/pages/index.adoc Outdated
@@ -1,11 +1,11 @@
:description: The Neo4j HTTP API allows to execute a series of Cypher statements against a Neo4j server through HTTP requests.

:page-role: deprecated-5.26
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:page-role: deprecated-5.26
[role=label--deprecated-5.26]

@renetapopova
Copy link
Copy Markdown
Collaborator Author

I might be wrong but it seems that page-role: not-on-aura in the publish and preview files overwrites "local" page-role on the pages

Yes, I thought that it might happen. I'll add it to the pages. Thanks

@neo4j-docops-agent
Copy link
Copy Markdown
Collaborator

neo4j-docops-agent commented Apr 9, 2026

Thanks for the documentation updates.

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

@stefano-ottolenghi
Copy link
Copy Markdown
Contributor

I don't think this is helpful for users. The HTTP API is deprecated, and the whole of it. None of this manual documents clustering endpoints. The fact that you can still submit a GET request to localhost:7474 and get a list of endpoints doesn't make the HTTP API less deprecated. The same content (the Discovery API) is surfaced in the Query API manual so I don't think anybody is particularly confused by the state of things.

@bigmontz
Copy link
Copy Markdown

bigmontz commented Apr 9, 2026

I don't think this is helpful for users. The HTTP API is deprecated, and the whole of it. None of this manual documents clustering endpoints. The fact that you can still submit a GET request to localhost:7474 and get a list of endpoints doesn't make the HTTP API less deprecated. The same content (the Discovery API) is surfaced in the Query API manual so I don't think anybody is particularly confused by the state of things.

Is there any documentation around the clustering endpoints? HTTP Api is kind of a broad term.

If we have docs pages with clustering endpoints and other non-deprecated endpoints, we can narrow down the introduction to mention that this docs only refers to run queries and transaction. Then point people for the other endpoints docs. In this case, we can simply add the global deprecation notice. Along with that, the clustering endpoint might need to be removed from the docs.

@NataliaIvakina
Copy link
Copy Markdown
Collaborator

NataliaIvakina commented Apr 9, 2026

I don't think this is helpful for users. The HTTP API is deprecated, and the whole of it. None of this manual documents clustering endpoints. The fact that you can still submit a GET request to localhost:7474 and get a list of endpoints doesn't make the HTTP API less deprecated. The same content (the Discovery API) is surfaced in the Query API manual so I don't think anybody is particularly confused by the state of things.

Is there any documentation around the clustering endpoints? HTTP Api is kind of a broad term.

If we have docs pages with clustering endpoints and other non-deprecated endpoints, we can narrow down the introduction to mention that this docs only refers to run queries and transaction. Then point people for the other endpoints docs. In this case, we can simply add the global deprecation notice. Along with that, the clustering endpoint might need to be removed from the docs.

Clustering endpoints are documented here - https://neo4j.com/docs/operations-manual/current/clustering/monitoring/endpoints/.

@NataliaIvakina
Copy link
Copy Markdown
Collaborator

Along with that, the clustering endpoint might need to be removed from the docs.

@bigmontz , do you mean that the clustering endpoints should be removed from this docset? But anyway they will remain in the Example responses, not only here but also in the Query API docs.

@bigmontz
Copy link
Copy Markdown

bigmontz commented Apr 9, 2026

Along with that, the clustering endpoint might need to be removed from the docs.

@bigmontz , do you mean that the clustering endpoints should be removed from this docset? But anyway they will remain in the Example responses, not only here but also in the Query API docs.

Yes, than the document can be returned to the original and we just need to make clear the scope of the document and deprecation on the introduction page.

@renetapopova
Copy link
Copy Markdown
Collaborator Author

renetapopova commented Apr 9, 2026

Along with that, the clustering endpoint might need to be removed from the docs.

@bigmontz , do you mean that the clustering endpoints should be removed from this docset? But anyway they will remain in the Example responses, not only here but also in the Query API docs.

Yes, than the document can be returned to the original and we just need to make clear the scope of the document and deprecation on the introduction page.

What about the Authorization header, the content type application/json, and the discovery API? Should I remove them as well?

Copy link
Copy Markdown

bigmontz commented Apr 9, 2026

Auth and application/json should keep on it, just with an notice that the auth-method itself is not deprecated since it is used in other places.

About the Discovery API, this a bit more complicated, since it doesn't have a place to go and the endpoint is not deprecated.

@renetapopova
Copy link
Copy Markdown
Collaborator Author

Replaced by #159

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.

5 participants