feat: API documentation renderer

.github/workflows/deploy-public-website.yaml

@@ -23,12 +23,6 @@ jobs:
       - name: Make destination directory for compiled CSS
         run: mkdir -vp docs/stylesheets/
 
-      - name: Compile CSS from SCSS files
-        uses: gha-utilities/[email protected]
-        with:
-          source: src/sekoiaio.scss
-          destination: docs/stylesheets/sekoiaio.css
-
       - name: Install Poetry
         run: |
           pip install poetry

.github/workflows/preview.yaml

@@ -20,12 +20,6 @@ jobs:
       - name: Make destination directory for compiled CSS
         run: mkdir -vp docs/stylesheets/
 
-      - name: Compile CSS from SCSS files
-        uses: gha-utilities/[email protected]
-        with:
-          source: src/sekoiaio.scss
-          destination: docs/stylesheets/sekoiaio.css
-
       - name: Install Poetry
         run: |
           pip install poetry

.gitignore

@@ -1,6 +1,7 @@
 .idea
 site
 docs/stylesheets/sekoiaio.css
+docs/stylesheets/openapi.css
 venv
 *~
 redoc.egg-info

docs/developer/api.md

@@ -0,0 +1,183 @@
+---
+template: overrides/openapi.html
+---
+
+# Sekoia.io API documentation
+
+{!docs/developer/quickstart.md!}
+
+
+<script>
+    window.onload = ()=> {
+        OpenAPIViewer.init({
+            title:"Sekoia.io API Documentation",
+            regions: [
+                "FRA1",
+                // "FRA2",
+                // "MCO1",
+                // "UAE1",
+            ],
+            urls: [
+                "https://app.sekoia.io/api/v1/dashboard/swagger.json?context=public",
+                "https://app.sekoia.io/api/v1/telemetry/openapi.json?context=public",
+                "https://app.sekoia.io/api/v1/events/openapi.json?context=public",
+                "https://app.sekoia.io/api/v1/notebooks/openapi.json?context=public",
+                "https://app.sekoia.io/api/v1/sic/conf/swagger.json?context=public",
+                "https://app.sekoia.io/api/v1/swagger.json?context=public",
+                "https://app.sekoia.io/api/v1/ingest/swagger.json?context=public",
+                "https://app.sekoia.io/api/v1/sic/swagger.json?context=public",
+                "https://app.sekoia.io/api/v1/symphony/swagger.json?context=public",
+                "https://app.sekoia.io/api/v2/asset-management/openapi.json?context=public",
+                "https://app.sekoia.io/api/v1/edl-gateway/openapi.json",
+                "https://app.sekoia.io/api/v2/inthreat/swagger.json?context=public",
+            ],
+            tag_mappings:{
+                "mfa": "MFA",
+                "me": "User profile",
+                "automations": "Automation",
+            },
+            menu:[
+                {
+                    name: "User",
+                    tags: [
+                        "User Authentication",
+                        "User profile",
+                        "MFA",
+                        "permissions",
+                    ],
+                },
+                {
+                    name: "Workspace",
+                    tags: [
+                        "customers", // TODO deprecated, get rid of it
+                        "communities",
+                        "api-keys",
+                        "licenses",
+                        "invitations",
+                        "plans",
+                        "sub-communities",
+                        "avatars",
+                        "users", // TODO set this tag on all user administration stuff
+                        "roles",
+                        "counters", // TODO => +Avatars
+                    ],
+                },
+                {
+                    name: "Configuration",
+                    tags: [
+                        "Entities",
+                        "Enrichers",
+                        "Callbacks",
+                        "Services",
+                        "Intakes",
+                        "Assets",
+                        "Atoms",
+                        "Intakes by status",
+                        "Intakes errors and warnings",
+                        "Intakes lag and processing lag",
+                        "formats",
+                        "Intake Optimization Rules",
+                    ]
+                },
+                {
+                    name: "Intelligence",
+                    tags: [
+                        "Objects",
+                        "CTI Objects", // TODO fix telemetry => Objects
+                        "Indicators",
+                        "Observables",
+                        "Observable relationships",
+                        "Exports",
+                        "Kill Chains",
+                        "Outgoing Feeds",
+                        "Collections",
+                        "MISP",
+                        "TAXII",
+                        "Bundles",
+                        "Images",
+                        "Labels",
+                        "Graphs",
+                        "Relationships",
+                        "Reports",
+                        "Support",
+                        "Sources",
+                        "Vulnerabilities",
+                    ],
+                },
+                {
+                    name: "Detection",
+                    tags: [
+                        "Rules",
+                            "compilation-reports", // TODO sicconf => Rules
+                            "rules-catalog-multi-tenant", // TODO sicconf => Rules
+                            "rules-catalog", // TODO sicconf => Rules
+                        "Alerts",
+                        "datasources",
+                        "generation-modes", // TODO sicconf => Generation modes
+                        "Alert filters",
+                        "IOC Collections",
+                        "Alerts",
+                            "Alert", // TODO sicalert => Detection+Alerts
+                            "Alert Entities", // TODO sicalert => Detection+Alerts
+                            "Alert Rules", // TODO sicalert => Detection+Alerts
+                            "Alert Sources and Targets", // TODO sicalert => Detection+Alerts
+                            "Stats", // TODO sicalert => Detection+Alerts+Alert stats
+                            "Alert Status", // TODO sicalert => Detection+Alerts
+                            "Alert Type", // TODO sicalert => Detection+Alerts
+                        "Countermeasures",
+                        "Cyber Kill Chain",
+                        "UEBA",
+                    ],
+                },
+                {
+                    name: "Investigation",
+                    tags: [
+                        "Cases",
+                            "Case", // TODO => Cases
+                            "Comments", // TODO => + Cases
+                        "Notebooks",
+                        "Events",
+                        "Tasks",
+                    ],
+                },
+                {
+                    name: "Automation",
+                    tags: [
+                        "Playbooks",
+                        "Playbook actions telemetry",
+                        "modules",
+                        "Playbook runs",
+                            "Playbooks runs", // TODO: Fix symphony => Playbook runs
+                        "Node runs",
+                        "Action Runs",
+                        "Actions",
+                        "Connector Configurations",
+                        "Connectors",
+                        "Module Configurations",
+                        "Modules",
+                        "Runs",
+                        "Trigger Configurations",
+                        "Triggers",
+                        "SSH Keys",
+                    ],
+                },
+                {
+                    name:"Reporting",
+                    tags: [
+                        "dashboards",
+                        "Intelligence",
+                            "Intelligence statistics", // => Intelligence
+                        "Events",
+                        "Rules",
+                        "Alert filters",
+                        "Assets",
+                        "Playbooks",
+                            "Automation statistics", // => Playbooks
+                        "AI assistant",
+                        "Statistics", // ?
+                    ]
+                }
+            ]
+        })
+    };
+</script>