Skip to content

Commit

Permalink
Fixed the doc bugs
Browse files Browse the repository at this point in the history
  • Loading branch information
jimwebber committed May 23, 2012
1 parent a7ac953 commit 6552eda
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions server/src/docs/dev/rest-api/index.txt
Expand Up @@ -287,7 +287,8 @@ The Neo4j REST API is a truly RESTful interface relying on hypermedia controls (
actions to users. Hypermedia is a dynamic interface style where declarative constructs (semantic markup) are used
to inform clients of their next legal choices just in time.

[CAUTION] RESTful APIs cannot be modelled by static interface description languages like WSDL or WADL.
[CAUTION]
RESTful APIs cannot be modelled by static interface description languages like WSDL or WADL.

However for some use cases, developers may wish to expose WADL descriptions of the Neo4j REST API, particularly when
using tooling that expects such.
Expand All @@ -297,10 +298,12 @@ In those cases WADL generation may be enabled by adding to your server's +neo4j.
[source]
----
unsupported_wadl_generation_enabled=true
----

[CAUTION]
WADL is not an officially supported part of the Neo4j server API because WADL is insufficiently expressive to capture
the set of potential interactions a client can have with Neo4j server. Expect the WADL description to be incomplete,
the set of potential interactions a client can drive with Neo4j server. Expect the WADL description to be incomplete,
and in some cases contradictory to the real API. In any cases where the WADL description disagrees with the REST API,
the REST API should be considered authoritative.
the REST API should be considered authoritative. WADL generation may be withdrawn at any point in the Neo4j release
cycle.

0 comments on commit 6552eda

Please sign in to comment.