mirror of https://github.com/apibillme/broker
update readme
This commit is contained in:
parent
c7128c45be
commit
b55bd1f711
|
@ -451,7 +451,7 @@ dependencies = [
|
|||
|
||||
[[package]]
|
||||
name = "broker"
|
||||
version = "6.0.3"
|
||||
version = "6.0.4"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"async-std",
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
[package]
|
||||
name = "broker"
|
||||
version = "6.0.3"
|
||||
version = "6.0.4"
|
||||
authors = ["Bevan Hunt <bevan@bevanhunt.com>"]
|
||||
edition = "2018"
|
||||
license = "MIT"
|
||||
|
|
|
@ -57,9 +57,9 @@ POST /users
|
|||
- public endpoint
|
||||
- POST JSON to create a user
|
||||
```json
|
||||
{"username":{...}, "password":{...}, "collection_id":{...}, "tenant_id":{...}}
|
||||
{"username":{...}, "password":{...}}
|
||||
```
|
||||
- where {...} is for username and string, password a string, collection_id is the uuid of the event collection for user info, tenant_id is the uuid of the tenant
|
||||
- where {...} is for username is a string and password is a string
|
||||
|
||||
will return `200` or `500` or `400`
|
||||
|
||||
|
@ -73,7 +73,7 @@ POST /login
|
|||
```json
|
||||
{"username":{...}, "password":{...}}
|
||||
```
|
||||
- where {...} is for username a string and password a string
|
||||
- where {...} is for username is a string and password is a string
|
||||
|
||||
will return
|
||||
```json
|
||||
|
@ -88,7 +88,7 @@ GET /sse
|
|||
```
|
||||
- authenticated endpoint (Authorization: Bearer {jwt})
|
||||
- connect your sse-client to this endpoint using [broker-client](https://www.npmjs.com/package/broker-client)
|
||||
- note: broker-client uses fetch as eventsource doesn't support headers
|
||||
- `note`: broker-client uses fetch as eventsource doesn't support headers
|
||||
|
||||
#### Step 4 - insert an event
|
||||
|
||||
|
|
Loading…
Reference in New Issue