mirror of
https://github.com/logos-messaging/logos-messaging-rest-api.git
synced 2026-01-07 08:23:06 +00:00
Merge 4ad07f897a70f31f8b1051146b8af253fa1b9faa into 56202ba88290cee9ce5184287c94383a55aeba76
This commit is contained in:
commit
64ccc4067e
@ -1,137 +0,0 @@
|
|||||||
# /store/v1/messages:
|
|
||||||
get:
|
|
||||||
summary: Gets message history
|
|
||||||
description: >
|
|
||||||
Retrieves WakuV2 message history. The returned history
|
|
||||||
can be potentially filtered by optional request parameters.
|
|
||||||
operationId: getMessageHistory
|
|
||||||
tags:
|
|
||||||
- legacy_store
|
|
||||||
parameters:
|
|
||||||
- name: peerAddr
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: >
|
|
||||||
P2P fully qualified peer multiaddress
|
|
||||||
in the format `(ip4|ip6)/tcp/p2p/$peerId` and URL-encoded.
|
|
||||||
example: '%2Fip4%2F127.0.0.1%2Ftcp%2F60001%2Fp2p%2F16Uiu2HAmVFXtAfSj4EiR7mL2KvL4EE2wztuQgUSBoj2Jx2KeXFLN'
|
|
||||||
|
|
||||||
- name: pubsubTopic
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: >
|
|
||||||
The pubsub topic on which a WakuMessage is published.
|
|
||||||
If left empty, no filtering is applied.
|
|
||||||
It is also intended for pagination purposes.
|
|
||||||
It should be a URL-encoded string.
|
|
||||||
example: 'my%20pubsub%20topic'
|
|
||||||
|
|
||||||
- name: contentTopics
|
|
||||||
in: query
|
|
||||||
schema: string
|
|
||||||
description: >
|
|
||||||
Comma-separated list of content topics. When specified,
|
|
||||||
only WakuMessages that are linked to any of the given
|
|
||||||
content topics will be delivered in the get response.
|
|
||||||
It should be a URL-encoded-comma-separated string.
|
|
||||||
example: 'my%20first%20content%20topic%2Cmy%20second%20content%20topic%2Cmy%20third%20content%20topic'
|
|
||||||
|
|
||||||
- name: startTime
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: >
|
|
||||||
The inclusive lower bound on the timestamp of
|
|
||||||
queried WakuMessages. This field holds the
|
|
||||||
Unix epoch time in nanoseconds as a 64-bits
|
|
||||||
integer value.
|
|
||||||
example: '1680590945000000000'
|
|
||||||
|
|
||||||
- name: endTime
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: >
|
|
||||||
The inclusive upper bound on the timestamp of
|
|
||||||
queried WakuMessages. This field holds the
|
|
||||||
Unix epoch time in nanoseconds as a 64-bits
|
|
||||||
integer value.
|
|
||||||
example: '1680590945000000000'
|
|
||||||
|
|
||||||
- name: senderTime
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: >
|
|
||||||
Cursor field intended for pagination purposes.
|
|
||||||
Represents the Unix time in nanoseconds at which a message was generated.
|
|
||||||
It could be empty for retrieving the first page,
|
|
||||||
and will be returned from the GET response so that
|
|
||||||
it can be part of the next page request.
|
|
||||||
example: '1680590947000000000'
|
|
||||||
|
|
||||||
- name: storeTime
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: >
|
|
||||||
Cursor field intended for pagination purposes.
|
|
||||||
Represents the Unix time in nanoseconds at which a message was stored.
|
|
||||||
It could be empty for retrieving the first page,
|
|
||||||
and will be returned from the GET response so that
|
|
||||||
it can be part of the next page request.
|
|
||||||
example: '1680590945000000000'
|
|
||||||
|
|
||||||
- name: digest
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: >
|
|
||||||
Cursor field intended for pagination purposes.
|
|
||||||
URL-base64-encoded string computed as a hash of the
|
|
||||||
a message content topic plus a message payload.
|
|
||||||
It could be empty for retrieving the first page,
|
|
||||||
and will be returned from the GET response so that
|
|
||||||
it can be part of the next page request.
|
|
||||||
example: 'Gc4ACThW5t2QQO82huq3WnDv%2FapPPJpD%2FwJfxDxAnR0%3D'
|
|
||||||
|
|
||||||
- name: pageSize
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: >
|
|
||||||
Number of messages to retrieve per page
|
|
||||||
example: '5'
|
|
||||||
|
|
||||||
- name: ascending
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
description: >
|
|
||||||
"true" for paging forward, "false" for paging backward
|
|
||||||
example: "true"
|
|
||||||
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: WakuV2 message history.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: './schemas/apitypes.yaml#/StoreResponse'
|
|
||||||
'400':
|
|
||||||
description: Bad request error.
|
|
||||||
content:
|
|
||||||
text/plain:
|
|
||||||
type: string
|
|
||||||
'412':
|
|
||||||
description: Precondition failed.
|
|
||||||
content:
|
|
||||||
text/plain:
|
|
||||||
type: string
|
|
||||||
'500':
|
|
||||||
description: Internal server error.
|
|
||||||
content:
|
|
||||||
text/plain:
|
|
||||||
type: string
|
|
||||||
@ -21,9 +21,7 @@ tags:
|
|||||||
- name: relay
|
- name: relay
|
||||||
description: Control of the relaying of messages. See [11/WAKU2-RELAY](https://rfc.vac.dev/spec/11/) RFC
|
description: Control of the relaying of messages. See [11/WAKU2-RELAY](https://rfc.vac.dev/spec/11/) RFC
|
||||||
- name: store
|
- name: store
|
||||||
description: Retrieve the message history. #TODO See [13/WAKU2-STORE]() RFC
|
description: Retrieve the message history. See [WAKU2-STORE](https://github.com/waku-org/specs/blob/master/standards/core/store.md)
|
||||||
- name: legacy_store
|
|
||||||
description: Retrieve the message history. See [13/WAKU2-STORE](https://rfc.vac.dev/spec/13/) RFC
|
|
||||||
- name: filter
|
- name: filter
|
||||||
description: Control of the content filtering. See [12/WAKU2-FILTER](https://rfc.vac.dev/spec/12/) RFC
|
description: Control of the content filtering. See [12/WAKU2-FILTER](https://rfc.vac.dev/spec/12/) RFC
|
||||||
- name: filter_legacy
|
- name: filter_legacy
|
||||||
@ -77,8 +75,6 @@ paths:
|
|||||||
$ref: "./relayapi_auto_messages.yaml"
|
$ref: "./relayapi_auto_messages.yaml"
|
||||||
/relay/v1/auto/subscriptions:
|
/relay/v1/auto/subscriptions:
|
||||||
$ref: "./relayapi_auto_subscriptions.yaml"
|
$ref: "./relayapi_auto_subscriptions.yaml"
|
||||||
/store/v1/messages:
|
|
||||||
$ref: "./legacystoreapi.yaml"
|
|
||||||
/store/v3/messages:
|
/store/v3/messages:
|
||||||
$ref: "./storeapi.yaml"
|
$ref: "./storeapi.yaml"
|
||||||
/filter/v2/subscriptions/{requestId}:
|
/filter/v2/subscriptions/{requestId}:
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user