-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provide documentation for pushing events (#31)
Provide documentation for pushing events. Closes #24
- Loading branch information
1 parent
c4cbb96
commit 71250cf
Showing
4 changed files
with
48 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
layout: default | ||
title: Push Events | ||
--- | ||
|
||
You can easily push events to your topic via the proxy: | ||
```bash | ||
curl -X POST "http://localhost:8999/api/v1/events/Arcus.NewCarRegistered" | ||
-H "accept: text/plain" -H "Content-Type: application/json-patch+json" | ||
-d "{ \"licensePlate\": \"1-ABC-337\"}" --include | ||
``` | ||
|
||
If everything is ok it will return an HTTP 204, otherwise an HTTP 503. | ||
|
||
```bash | ||
HTTP/1.1 204 No Content | ||
Date: Mon, 28 Jan 2019 17:49:43 GMT | ||
X-Event-Id: e9ca21cc-50ed-4138-a760-1ca9b01b092f | ||
X-Event-Subject: / | ||
X-Event-Timestamp: 2019-01-28T17:49:43.9021889+00:00 | ||
X-Event-Data-Version: 1.0 | ||
``` | ||
|
||
## Optional parameters | ||
We provide the capability to be more specific about your events. | ||
|
||
You can specify more information with the following query parameters: | ||
- `eventId` - Unique id for your event _(default: Guid)_ | ||
- `eventTimestamp` - Timestamp of event _(default: UTC)_ | ||
- `eventSubject` - Subject of event _(default: /)_ | ||
- `dataVersion` - Version of data payload _(default: 1.0)_ | ||
|
||
[← back](/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters