Skip to content

update doc for uv/pydantic v2 and remove event_uuids from Get Alert o… - #3150

Open
tfanouillere-sekoia wants to merge 2 commits into
mainfrom
docs/fix-integration-doc-inconsistencies
Open

update doc for uv/pydantic v2 and remove event_uuids from Get Alert o…#3150
tfanouillere-sekoia wants to merge 2 commits into
mainfrom
docs/fix-integration-doc-inconsistencies

Conversation

@tfanouillere-sekoia

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates integration development and automation library documentation to reflect the shift toward uv for newly scaffolded Python projects and to align alert API output docs with recent platform changes (ref: https://github.com/SekoiaLab/platform/issues/89760).

Changes:

  • Adds uv alternatives alongside existing Poetry commands for adding dependencies and running tests in the “Create a module” guide.
  • Removes event_uuids from the documented outputs of the “Retrieve the definition of an alert” endpoint.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/integration/develop_integration/automation/create_a_module.md Adds uv notes as alternatives to Poetry commands for dependency management and test execution.
_shared_content/automate/library/sekoia-io.md Updates alert output documentation by removing event_uuids from one alert output table.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 1089 to 1093
| `short_id` | `string` | Human-readable short identifier for the alert (e.g. `ALa1b2c3d4e5`). |
| `first_seen_at` | `string` | Timestamp of the first event that contributed to this alert. |
| `last_seen_at` | `string` | Timestamp of the most recent event that contributed to this alert. |
| `event_uuids` | `array` | |
| `kill_chain_short_id` | `string` | Short identifier of the MITRE ATT&CK tactic associated with the alert (e.g. `TA0001` for Initial Access). |
| `similar` | `integer` | Number of similar alerts detected by the platform's deduplication mechanism. |
@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown

Newest code from tfanouillere-sekoia has been published to preview environment

🚀 Latest deployment was built on 2026-08-05 12:02:57 (17406e2dba9cdc8270a7907e5294aaccfbf5cbd6).

@mchupeau-sk

Copy link
Copy Markdown
Contributor

@tfanouillere-sekoia you need to rewrite the documentation to replace poetry command by uv, poetry is not used anymore for new modules

@tfanouillere-sekoia

Copy link
Copy Markdown
Contributor Author

@mchupeau-sk It's done !

@mchupeau-sk

Copy link
Copy Markdown
Contributor

@tfanouillere-sekoia thanks, in the python example in the page can you change the pydantic.v1 to pydantic (to use the new pydantic v2 version already present in sekoia automation sdk)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants