Merge pull request #155 from SEKOIA-IO/Add/arguments_desc

Add Configuration part
SEKOIA-IO · Dec 3, 2024 · e156e6b · e156e6b
2 parents b8cd28f + 630b57c
commit e156e6b
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 1.18.1 - 2024-12-03
+
+### Add
+
+- Add a configuration part for action documentation
+
 ### Fixed
 
 - Fix checkpoint for timestamps

diff --git a/pyproject.toml b/pyproject.toml
@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 name = "sekoia-automation-sdk"
 
-version = "1.18.0"
+version = "1.18.1"
 description = "SDK to create Sekoia.io playbook modules"
 license = "MIT"
 readme = "README.md"

diff --git a/sekoia_automation/scripts/documentation/templates/module.md b/sekoia_automation/scripts/documentation/templates/module.md
@@ -69,6 +69,14 @@ This module accepts no configuration.
 
 {{action.description}}
 
+{%- if action.arguments.description %}
+
+**Configuration**
+
+{{action.arguments.description}}
+
+{%- endif -%}
+
 {%- if action.arguments.properties %}
 
 **Arguments**