This is an automated email from the ASF dual-hosted git repository.
sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-ponymail-foal.git
The following commit(s) were added to refs/heads/master by this push:
new aedd948 Expand description of d= date specifier
aedd948 is described below
commit aedd948ca0774d12a485d736c4a5c95a827fbbe9
Author: Sebb <[email protected]>
AuthorDate: Fri Nov 19 15:38:30 2021 +0000
Expand description of d= date specifier
---
server/openapi.yaml | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/server/openapi.yaml b/server/openapi.yaml
index 6ca1e1c..dd34274 100644
--- a/server/openapi.yaml
+++ b/server/openapi.yaml
@@ -45,8 +45,15 @@ components:
type: string
example: "2021-12"
d:
- description: Optional advanced date parameters. Uses gte (greater
than or equal) or lte (less than or equal) to narrow results
- example: "lte=2019-01"
+ description: |
+ Optional advanced date parameters. There are various options for
specifying the date range:
+ - a single month: yyyy-mm
+ - gte (greater than or equal) or lte (less than or equal) a number
of Months, weeks, years or days (Mwyd)
+ - dfr=yyyy-mm-dd|dto=yyy-mm-dd - a range of days (inclusive)
+ example: |
+ - "2019-01"
+ - "lte=10d", "gte=2y"
+ - "dfr=2021-9-21|dto=2021-10-31"
type: string
dfrom:
description: Optional start date, expressed as days ago. Used with
dto.
