Ottomata has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/327046 )
Change subject: Update README with /v2 docs
......................................................................
Update README with /v2 docs
Bug: T143925
Change-Id: I7db90a876e432f0eef3b70edd191e73b53ea65dd
---
M README.md
1 file changed, 4 insertions(+), 4 deletions(-)
Approvals:
Ottomata: Verified; Looks good to me, approved
diff --git a/README.md b/README.md
index e2127c2..4dabcce 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@
## Routes
-### `GET /v1/stream/{stream_name}`
+### `GET /v2/stream/{stream_name}`
`:stream` is configured in config.yaml. Each key in the `streams` config
object will be
created as a route. Each of these stream routes will consume from configured
topics. E.g.
@@ -22,8 +22,8 @@
topics: [topicA]
```
-In this example, `/v1/streams/edits` and `/v1/streams/single-topic-stream`
will be created as
-routes. Requests to `/v1/streams/edits` will consume from the topics
`datacenter1.edit` and
+In this example, `/v2/streams/edits` and `/v2/streams/single-topic-stream`
will be created as
+routes. Requests to `/v2/streams/edits` will consume from the topics
`datacenter1.edit` and
`datacenter2.edit`, and requests to `/v1/streams/single-topic-stream` will
consume only from topic
`topicA`. As long as the `Last-Event-ID` header (see below) is not set,
consumption will
start from the latest position in each of these topics.
@@ -32,7 +32,7 @@
as SSE events.
Note that `{stream_name}` is not a request parameter, but pseudo-code to
indicate that
-there are multiple routes created under `/v1/stream/`. These are each real
routes, for
+there are multiple routes created under `/v2/stream/`. These are each real
routes, for
which you should add proper entires to spec.yaml.
--
To view, visit https://gerrit.wikimedia.org/r/327046
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I7db90a876e432f0eef3b70edd191e73b53ea65dd
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/services/eventstreams
Gerrit-Branch: master
Gerrit-Owner: Ottomata <ao...@wikimedia.org>
Gerrit-Reviewer: Ottomata <ao...@wikimedia.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
