SystemSh0cker/gocsaf
1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 05:40:11 +01:00
Code Issues Releases Activity Actions

Prettifying docs

Browse source
This commit is contained in:
Sascha L. Teichmann 2023-07-26 04:25:45 +02:00
parent 9e665a2fa1
commit 1f301b6301
1 changed files with 15 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docs/csaf_downloader.md
View file

@ -61,24 +61,24 @@ validatorpreset = ["mandatory"]
The `timerange` parameter enables downloading advisories which last changes falls
into a given intervall. There are three possible notations:
1 - Relative. If the given string follows the rules of being a [Go duration](https://pkg.go.dev/time@go1.20.6#ParseDuration)
1. Relative. If the given string follows the rules of being a [Go duration](https://pkg.go.dev/time@go1.20.6#ParseDuration)
the time interval from now minus that duration till now is used.
E.g. `"3h"` means downloading the advisories that have changed in the last three hours.
2 - Absolute. If the given string is an RFC 3339 date timestamp the time interval between
this date and now is used.
E.g. "2006-01-02" means that all files between 2006 January 2nd and now going to being
downloaded. Accepted patterns are:
- "2006-01-02T15:04:05Z07:00"
- "2006-01-02T15:04:05"
- "2006-01-02T15:04"
- "2006-01-02T15"
- "2006-01-02"
- "2006-01"
- "2006"
Missing parts are set to the smallest value possible in that field.
2. Absolute. If the given string is an RFC 3339 date timestamp the time interval between
this date and now is used.
E.g. "2006-01-02" means that all files between 2006 January 2nd and now going to being
downloaded. Accepted patterns are:
- `"2006-01-02T15:04:05Z07:00"`
- `"2006-01-02T15:04:05"`
- `"2006-01-02T15:04"`
- `"2006-01-02T15"`
- `"2006-01-02"`
- `"2006-01"`
- `"2006"`
Missing parts are set to the smallest value possible in that field.
3 - Range. Same as 2 but separated by a `,` to span an interval. e.g `2019,2024`
spans an interval from 1st January 2019 to the 1st January of 2024.
3. Range. Same as 2 but separated by a `,` to span an interval. e.g `2019,2024`
spans an interval from 1st January 2019 to the 1st January of 2024.
All interval boundaries are inclusive.