digital-asset/daml
1
1
Fork 0
mirror of https://github.com/digital-asset/daml.git synced 2024-09-20 01:07:18 +03:00
Code Issues Projects Releases Wiki Activity

declare http-json Streaming API as stable (#6152)

Browse Source 
CHANGELOG_BEGIN
- [JSON API] The WebSocket endpoints ``/v1/stream/query`` and ``/v1/stream/fetch`` are now
  stable; these endpoints in SDK v1.0.0 are fully compatible with this first officially
  stable version.
  See `issue #6152 <https://github.com/digital-asset/daml/pull/6152>`_.
CHANGELOG_END
This commit is contained in:
Stephen Compall 2020-05-29 08:33:11 -04:00 committed by GitHub
parent 404d043b22
commit 3ad9f2b52f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/source/json-api/index.rst
View File

@ -25,6 +25,11 @@ complicating concerns, including but not limited to:
For these and other features, use :doc:`the Ledger API </app-dev/ledger-api>`
instead.
We welcome feedback about the JSON API on `our issue tracker
<https://github.com/digital-asset/daml/issues/new?milestone=HTTP+JSON+API+Maintenance>`_
`on our forum <https://discuss.daml.com>`_, or `on Slack
<https://slack.daml.com>`_.
.. toctree::
:hidden:
@ -1176,18 +1181,6 @@ HTTP Response with Error
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 our forum <https://discuss.daml.com>`_ or `on Slack <https://slack.daml.com>`_.
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>`__.
@ -1255,8 +1248,6 @@ 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.
@ -1421,8 +1412,6 @@ 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: