Freeze JSON API v1 (digital-asset#5387)

* move JSON API doc to "Building applications" * stop describing JSON API as experimental; limit to calling WebSocket endpoints alpha * remove "(experimental)" from daml json-api docstring * add changelog CHANGELOG_BEGIN - [JSON API] First stable version of the ``/v1`` endpoints, with the exception of the WebSocket endpoints, which remain in alpha. See `issue digital-asset#4458 <https://github.com/digital-asset/daml/issues/4458>`_. CHANGELOG_END * move json-api in PDF ToC, adapting to digital-asset#5411 c496e2b - pointed out by @cocreature; thanks
axman6 · Apr 3, 2020 · ff68252 · ff68252
1 parent 55f3762
commit ff68252
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 12 deletions.
diff --git a/docs/configs/pdf/index.rst b/docs/configs/pdf/index.rst
@@ -37,9 +37,9 @@ Building applications
    :maxdepth: 2
 
    app-dev/app-arch
-   json-api/index
    daml2js/index
    app-dev/bindings-ts/index
+   json-api/index
    DAML Script <daml-script/index>
    upgrade/index
    app-dev/authentication

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -42,9 +42,9 @@ DAML SDK documentation
    :caption: Building applications
 
    app-dev/app-arch
-   json-api/index
    daml2js/index
    app-dev/bindings-ts/index
+   json-api/index
    DAML Script <daml-script/index>
    upgrade/index
    app-dev/authentication

diff --git a/docs/source/json-api/index.rst b/docs/source/json-api/index.rst
@@ -6,16 +6,6 @@
 HTTP JSON API Service
 #####################
 
-**WARNING:** the HTTP JSON API described in this document is actively
-being designed and is *subject to breaking changes*, including all
-request and response elements demonstrated below or otherwise
-implemented by the API.  We welcome feedback about the API on `our issue
-tracker
-<https://github.com/digital-asset/daml/issues/new?milestone=HTTP+JSON+API+Maintenance>`_
-or `on Slack <https://hub.daml.com/slack/>`_.
-
-Please keep in mind that the presence of **/v1** prefix in the the URLs below does not mean that the endpoint interfaces are stabilized.
-
 The **JSON API** provides a significantly simpler way than :doc:`the Ledger
 API </app-dev/ledger-api>` to interact with a ledger by providing *basic active contract set functionality*:
 
@@ -1084,6 +1074,18 @@ HTTP Response
 Streaming API
 *************
 
+**WARNING:** the WebSocket endpoints described below are in alpha,
+so are *subject to breaking changes*, including all
+request and response elements demonstrated below or otherwise
+implemented by the API.  We welcome feedback about the API on `our issue
+tracker
+<https://github.com/digital-asset/daml/issues/new?milestone=HTTP+JSON+API+Maintenance>`_
+or `on Slack <https://hub.daml.com/slack/>`_.
+
+Please keep in mind that the presence of **/v1** prefix in the the
+WebSocket URLs does not mean that the endpoint interfaces are
+stabilized.
+
 Two subprotocols must be passed with every request, as described in
 `Passing token with WebSockets <#passing-token-with-websockets>`__.
 
@@ -1151,6 +1153,8 @@ Contracts Query Stream
 - Scheme: ``ws``
 - Protocol: ``WebSocket``
 
+*Endpoint is in alpha as described above.*
+
 List currently active contracts that match a given query, with
 continuous updates.
 
@@ -1315,6 +1319,8 @@ Fetch by Key Contracts Stream
 - Scheme: ``ws``
 - Protocol: ``WebSocket``
 
+*Endpoint is in alpha as described above.*
+
 List currently active contracts that match one of the given ``{templateId, key}`` pairs, with continuous updates.
 
 ``application/json`` body must be sent first, formatted according to the following rule: