From fb1aaa93ff1af9ab0382951de5b79d74d12d4878 Mon Sep 17 00:00:00 2001 From: haixin Date: Wed, 10 Nov 2021 11:12:13 +0800 Subject: [PATCH] [doc] update doc about query user message Change-Id: I22d35ac31f024712a2bdd6df307682de04301c22 --- api-ref/source/parameters.yaml | 40 ++++++++++++++++++++++++++++++++ api-ref/source/user-messages.inc | 2 ++ 2 files changed, 42 insertions(+) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 751a9ef165..719fc74085 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -201,6 +201,46 @@ backend_query: in: query required: false type: string +created_before: + description: | + The date and time stamp when the query operation, only return user + messages before it. + + The date and time stamp format is `ISO 8601 + `_: + + :: + + CCYY-MM-DDThh:mm:ss±hh:mm + + The ``±hh:mm`` value, if included, returns the time zone as an + offset from UTC. + + For example, ``2021-11-10T09:49:58+08:00``. + in: query + required: false + type: string + min_version: 2.52 +created_since: + description: | + The date and time stamp when the query operation, only return user + messages since it. + + The date and time stamp format is `ISO 8601 + `_: + + :: + + CCYY-MM-DDThh:mm:ss±hh:mm + + The ``±hh:mm`` value, if included, returns the time zone as an + offset from UTC. + + For example, ``2021-11-10T09:49:58+08:00``. + in: query + required: false + type: string + min_version: 2.52 description_inexact_query: description: | The description pattern that can be used to filter shares, diff --git a/api-ref/source/user-messages.inc b/api-ref/source/user-messages.inc index 3c1445867f..db5d4bfbad 100644 --- a/api-ref/source/user-messages.inc +++ b/api-ref/source/user-messages.inc @@ -57,6 +57,8 @@ Request - request_id: request_id - resource_id: resource_id - resource_type: resource_type + - created_since: created_since + - created_before: created_before Response parameters -------------------