dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'ttl_docs' of https://github.com/artursouza/docs into pr/1092

This commit is contained in:
Aaron Crawfis 2021-01-15 16:16:34 -08:00
parent 2e6ce4dfb3 1223d5cd73
commit ccf3ec092f
2 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-message-ttl.md
View File

@ -10,7 +10,7 @@ description: "Use time-to-live in Pub/Sub messages."
Dapr enables per-message time-to-live (TTL). This means that applications can set time-to-live per message, and subscribers will not receive those messages after expiration. Dapr enables per-message time-to-live (TTL). This means that applications can set time-to-live per message, and subscribers will not receive those messages after expiration.
All Dapr [pub/sub components]({{< ref supported-pubsub >}}) are compatible with message TTL, as Dapr handles the TTL logic within the runtime. All Dapr [pub/sub components]({{< ref supported-pubsub >}}) are compatible with message TTL, as Dapr handles the TTL logic within the runtime. Simply set the `ttlInSeconds` metadata when publishing a message.
In some components, such as Kafka, time-to-live can be configured in the topic via `retention.ms` as per [documentation](https://kafka.apache.org/documentation/#topicconfigs_retention.ms). With message TTL in Dapr, applications using Kafka can now set time-to-live per message in addition to per topic. In some components, such as Kafka, time-to-live can be configured in the topic via `retention.ms` as per [documentation](https://kafka.apache.org/documentation/#topicconfigs_retention.ms). With message TTL in Dapr, applications using Kafka can now set time-to-live per message in addition to per topic.

28
daprdocs/content/en/reference/api/pubsub_api.md
View File

@ -14,7 +14,7 @@ Dapr guarantees at least once semantics for this endpoint.
### HTTP Request ### HTTP Request
``` ```
POST http://localhost:<daprPort>/v1.0/publish/<pubsubname>/<topic> POST http://localhost:<daprPort>/v1.0/publish/<pubsubname>/<topic>[?<metadata>]
``` ```
### HTTP Response codes ### HTTP Response codes
@ -31,8 +31,9 @@ Code | Description
Parameter | Description Parameter | Description
--------- | ----------- --------- | -----------
daprPort | the Dapr port daprPort | the Dapr port
pubsubname | the name of pubsub component. pubsubname | the name of pubsub component
topic | the name of the topic topic | the name of the topic
metadata | query parameters for metadata as described below
> Note, all URL parameters are case-sensitive. > Note, all URL parameters are case-sensitive.
@ -44,6 +45,16 @@ curl -X POST http://localhost:3500/v1.0/publish/pubsubName/deathStarStatus \
}' }'
``` ```
#### Metadata
Metadata can be sent via query parameters in the request's URL. It must be prefixed with `metadata.` as shown below.
Parameter | Description
--------- | -----------
metadata.ttlInSeconds | the number of seconds for the message to expire as [described here]({{< ref pubsub-message-ttl.md >}})
> Additional metadata parameters are available based on each pubsub component.
## Optional Application (User Code) Routes ## Optional Application (User Code) Routes
### Provide a route for Dapr to discover topic subscriptions ### Provide a route for Dapr to discover topic subscriptions
@ -89,7 +100,7 @@ The following example illustrates this point, considering a subscription for top
#### HTTP Request #### HTTP Request
``` ```
POST http://localhost:<appPort>/<path>[?<metadata>] POST http://localhost:<appPort>/<path>
``` ```
> Note, all URL parameters are case-sensitive. > Note, all URL parameters are case-sensitive.
@ -100,17 +111,6 @@ Parameter | Description
--------- | ----------- --------- | -----------
appPort | the application port appPort | the application port
path | route path from the subscription configuration path | route path from the subscription configuration
metadata | query parameters for metadata as described below
##### Metadata
Metadata can be sent via query parameters in the request's URL. It must be prefixed with `metadata.` as shown below.
Parameter | Description
--------- | -----------
metadata.ttlInSeconds | the number of seconds for the message to expire as [described here]({{< ref pubsub-message-ttl.md >}})
> Additional metadata parameters can be available based on each pubsub component.
#### Expected HTTP Response #### Expected HTTP Response