Metadata-Version: 2.4
Name: edf-helium-server
Version: 2.0.0
Summary: EDF Helium Server
Author-email: CERT-EDF <cert@edf.fr>
License-Expression: MIT
Project-URL: Homepage, https://github.com/cert-edf/helium
Project-URL: Repository, https://github.com/cert-edf/helium
Project-URL: Bug Tracker, https://github.com/cert-edf/helium/issues
Keywords: edf,helium,server
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Utilities
Classifier: Topic :: Security
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: edf-helium-core~=2.0
Dynamic: license-file

# EDF Helium Server


## Introduction

This server implements the API for Helium service. It uses EDF Fusion framework as a library to ease maintainance and take advantage of new generic features as they become available.

> [!TIP]
> This documentation does not aim at completeness but provides an overview of the main features


## Events

Helium, when configured to do so, can emit events using webhooks. Here is a list of event's categories it can emit:

- `create_case`
- `update_case`
- `create_collector`
- `import_collector`
- `create_collection`
- `update_collection`

Event's structure looks like this:

```json
{
    "source": "event's source, service's name is often used as source",
    "category": "event's category, the nature of the event",
    "case": {},
    "ext": {},
}
```
