From b694889a943cd63badbdc2507226d9b6d61426ae Mon Sep 17 00:00:00 2001 From: elsif2 Date: Mon, 5 Feb 2024 16:11:09 +0000 Subject: [PATCH 1/2] Documentation update for #2455 --- docs/user/bots.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/user/bots.md b/docs/user/bots.md index f83b97afb..e7be5066e 100644 --- a/docs/user/bots.md +++ b/docs/user/bots.md @@ -930,8 +930,7 @@ oldest files available!). The resulting reports contain the following special field: -- `extra.file_name`: The name of the downloaded file, with fixed filename extension. The API returns file names with the - extension `.csv`, although the files are JSON, not CSV. Therefore, for clarity and better error detection in the parser, the file name in `extra.file_name` uses `.json` as extension. +- `extra.file_name`: The name of the downloaded file, with fixed filename extension. **Module:** `intelmq.bots.collectors.shadowserver.collector_reports_api` @@ -951,7 +950,7 @@ The resulting reports contain the following special field: **`types`** -(optional, string/array of strings) An array of strings (or a list of comma-separated values) with the names of report types you want to process. If you leave this empty, all the available reports will be downloaded and processed (i.e. 'scan', 'drones', 'intel', 'sandbox_connection', 'sinkhole_combined'). The possible report types are equivalent to the file names given in the section Supported Reports of the [Shadowserver parser](#intelmq.bots.parsers.shadowserver.parser). +(optional, string/array of strings) An array of strings (or a list of comma-separated values) with the names of report types you want to process. If you leave this empty, all the available reports will be downloaded and processed (i.e. 'scan', 'drones', 'intel', 'sandbox_connection', 'sinkhole_combined'). The possible report types are equivalent to the file names defined the the schema. Please see the Supported Reports of the [Shadowserver parser](#intelmq.bots.parsers.shadowserver.parser) for details. **Sample configuration** @@ -2154,7 +2153,7 @@ correct mapping of the columns: **`feedname`** -(optional, string) Name of the Shadowserver report, see list below for possible values. +(optional, string) Name of the Shadowserver report. The value for each report type can be found in the schema `feed_name` field. **`overwrite`** From d8dee572e1884dd6c0be303d2d47a2b2d1a928d4 Mon Sep 17 00:00:00 2001 From: elsif2 Date: Mon, 5 Feb 2024 17:18:04 +0000 Subject: [PATCH 2/2] Added suggested example from Sebix. --- docs/user/bots.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/user/bots.md b/docs/user/bots.md index e7be5066e..791142dc2 100644 --- a/docs/user/bots.md +++ b/docs/user/bots.md @@ -2155,6 +2155,8 @@ correct mapping of the columns: (optional, string) Name of the Shadowserver report. The value for each report type can be found in the schema `feed_name` field. +For example using `curl -s https://interchange.shadowserver.org/intelmq/v1/schema | jq .[].feed_name`. + **`overwrite`** (optional, boolean) If an existing `feed.name` should be overwritten.