Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update endpoints and docs

Browse Source
This commit is contained in:
vrde
2017-04-07 14:57:11 +02:00
parent aeb8827e30
commit be3f62dd10
6 changed files with 20 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/server/source/websocket-event-stream-api.rst
View File

@@ -1,6 +1,11 @@
The WebSocket Event Stream API
==============================
.. important::
The WebSocket Event Stream runs on a different port than the Web API. The
default port for the Web API is `9984`, while the one for the Event Stream
is `9985`.
BigchainDB provides real-time event streams over the WebSocket protocol with
the Event Stream API.
@@ -25,7 +30,7 @@ response contains a ``streams_<version>`` property in ``_links``::
{
"_links": {
"streams_v1": "ws://example.com:9984/api/v1/streams/"
"streams_v1": "ws://example.com:9985/api/v1/streams/"
}
}