make it clear where RequestId type is defined

This commit is contained in:
Ivan FB 2026-04-23 22:11:08 +02:00
parent 2fc897e655
commit 89148cae12
No known key found for this signature in database
GPG Key ID: DF0C67A04C543270

View File

@ -125,7 +125,7 @@ types:
description: "All chunks of same message have the same value, i.e., num-chunks - 1." description: "All chunks of same message have the same value, i.e., num-chunks - 1."
requestId: requestId:
type: RequestId type: RequestId
description: "The request id this chunk belongs to. This is generated by the send function and its type is defined in messaging-api." description: "The request id this chunk belongs to. This is generated by the send function. `RequestId` is defined in [MESSAGING-API](./messaging-api.md)."
SyncStatusDetail: SyncStatusDetail:
type: object type: object
@ -351,7 +351,7 @@ types:
fields: fields:
requestId: requestId:
type: RequestId type: RequestId
description: "Identifier of the `send` operation that initiated the message sending" description: "Identifier of the `send` operation that initiated the message sending. `RequestId` is defined in [MESSAGING-API](./messaging-api.md)."
contentTopic: contentTopic:
type: string type: string
description: "Content topic on which the message was received" description: "Content topic on which the message was received"
@ -365,7 +365,7 @@ types:
fields: fields:
requestId: requestId:
type: RequestId type: RequestId
description: "The request ID associated with the sent message" description: "The request ID associated with the sent message. `RequestId` is defined in [MESSAGING-API](./messaging-api.md)."
EventMessageSendError: EventMessageSendError:
type: object type: object
@ -373,7 +373,7 @@ types:
fields: fields:
requestId: requestId:
type: RequestId type: RequestId
description: "The request ID associated with the failed message" description: "The request ID associated with the failed message. `RequestId` is defined in [MESSAGING-API](./messaging-api.md)."
error: error:
type: string type: string
description: "Error message describing what went wrong" description: "Error message describing what went wrong"
@ -384,7 +384,7 @@ types:
fields: fields:
requestId: requestId:
type: RequestId type: RequestId
description: "The request ID associated with the acknowledged message" description: "The request ID associated with the acknowledged message. `RequestId` is defined in [MESSAGING-API](./messaging-api.md)."
EventIrretrievableMessage: EventIrretrievableMessage:
type: object type: object
@ -392,7 +392,7 @@ types:
fields: fields:
requestId: requestId:
type: RequestId type: RequestId
description: "The request ID of the unrecoverable message" description: "The request ID of the unrecoverable message. `RequestId` is defined in [MESSAGING-API](./messaging-api.md)."
EventSyncStatus: EventSyncStatus:
type: object type: object
@ -441,6 +441,7 @@ functions:
description: "The raw message payload to send." description: "The raw message payload to send."
returns: returns:
type: result<RequestId, error> type: result<RequestId, error>
description: "`RequestId` is defined in [MESSAGING-API](./messaging-api.md)."
``` ```
#### Messaging extended definitions #### Messaging extended definitions