upstash / docs

Upstash documentation
https://upstash.com/docs/
9 stars 39 forks source link

fix sancars notes #29

Closed chronark closed 1 year ago

linear[bot] commented 1 year ago
DX-78 Qstash V2 Documentation Review

[https://upstash.com/docs/qstash/overall/pricing](https://upstash.com/docs/qstash/overall/pricing) MaxEventsSize is missing. [https://upstash.com/docs/qstash/howto/debug-logs](https://upstash.com/docs/qstash/howto/debug-logs) We may mention the limitation of logs and put a reference to the pricing page, as we did for DLQ. [https://upstash.com/docs/qstash/features/dlq#limitations](https://upstash.com/docs/qstash/features/dlq#limitations) \> Dead letter queues are limited to a certain number messages. If you exceed this limit, new messages will be dropped. Unhandled messages are evicted after some time. We don't drop new messages. We always drop the oldest. ✅ [https://upstash.com/docs/qstash/features/schedules#scheduling-to-a-topic](https://upstash.com/docs/qstash/features/schedules#scheduling-to-a-topic) It should be /schedules not /publish ✅ [https://upstash.com/docs/qstash/api/messages/create#response](https://upstash.com/docs/qstash/api/messages/create#response) We don't just return message id's. We return the following for puvlish to url { "messageId" : "" "url": "" "deduplicated" : "" } And array of this of publish to topic. ✅ [https://upstash.com/docs/qstash/api/messages/get#response](https://upstash.com/docs/qstash/api/messages/get#response) topicId should be topicName endpointName is missing. It is optional. ✅ [https://upstash.com/docs/qstash/api/topics/get#response](https://upstash.com/docs/qstash/api/topics/get#response) The name in the array of endpints is not required. ✅ [https://upstash.com/docs/qstash/api/schedules/create#request](https://upstash.com/docs/qstash/api/schedules/create#request) ContentType should be Content-Type ✅ [https://upstash.com/docs/qstash/api/schedules/get#response](https://upstash.com/docs/qstash/api/schedules/get#response) [https://upstash.com/docs/qstash/api/schedules/list#response](https://upstash.com/docs/qstash/api/schedules/list#response) id should be scheduleId ✅ [https://upstash.com/docs/qstash/api/events/list](https://upstash.com/docs/qstash/api/events/list) nextDeliveryTime we can mention that it is unix timestamp in milliseconds ✅ [https://upstash.com/docs/qstash/api/dlq/listMessages](https://upstash.com/docs/qstash/api/dlq/listMessages) topicName is missing endpointName is missing callback is missing createdAT should be createdAt ✅