spatial icon indicating copy to clipboard operation
spatial copied to clipboard

Add a part in the docs that describes usage via REST

Open Lin-Daiyu opened this issue 11 years ago • 8 comments

That could be a good addition in order to support bootstrapping in the webadmin after installing Neo4j the first time.

Lin-Daiyu avatar Jun 04 '13 09:06 Lin-Daiyu

:+1: Would really like to see some (more) documentation how to use the spatial plugin via the REST interface and via Cypher queries.

thomasfr avatar Jun 11 '13 19:06 thomasfr

You mean like this: http://neo4j.github.io/spatial/#spatial-server-plugin

jexp avatar Nov 11 '13 12:11 jexp

the manual linked is all about REST, I'd think that's enough? ah, getting it... this was issued before the manual was there, right?

ehx-v1 avatar May 04 '16 13:05 ehx-v1

Hello!

I think that as of posting this, the docs for REST API are inaccessible. Would anyone be able to update these? I didn't see the referenced asciidoc files in the project anywhere, otherwise would've tried to provide a fix.

Thanks!

http://neo4j-contrib.github.io/spatial/#spatial-server-plugin

Screenshot:

screen shot 2017-04-29 at 9 07 49 pm

TyGuy avatar Apr 30 '17 04:04 TyGuy

At the time when this issue was started, the entire manual at http://neo4j-contrib.github.io/spatial was all about REST. By now, things changed though - I encountered the same situation as you when looking it up. A possible reason is the following: Spatial has been ported to Neo4j 3.0 a couple of releases ago, and this involved defining spatial procedures that replace the REST API that was the main utility before. In this process, the REST API basically got deprecated, so someone might have cleaned up the docs and forgotten to update the main docsheet.

ehx-v1 avatar May 06 '17 13:05 ehx-v1

Either way, someone with more in-depth access to neo4j-contrib.github.io should have a look at what is happening, because it's definitely an inconsistency. If the REST API really isn't supposed to be part of the docs anymore, the cleanup should be done properly. I'm not sure either whether the cleanup is a good idea at all, since many people still use Spatial versions based on Neo4j 2.3 which don't have the procedure mechanics.

ehx-v1 avatar May 06 '17 13:05 ehx-v1

What I'd really like would be for the docs to be different for different versions, so the new docs focus on procedures, and the older docs focus on REST. And since the new versions do not remove the REST API, they could link to the older docs for that part, so that emphasizes the new priority on procedures, without denying anyone access to the REST docs. I think this would involve a small change to the docs structure, but have not looked into it. I believe the recent update to the docs was done by Michael because previously they were entirely lacking in information about procedures.

craigtaverner avatar May 06 '17 16:05 craigtaverner

There's probably no way to contribute on that from outside, is it? Because it requires actual access to the directory structure on the Neo4j docs server, which neither visitors nor external contributors have.

ehx-v1 avatar May 14 '17 14:05 ehx-v1