Preview: telemetry api documentation #2175

.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,176 @@
+---
+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: [
+                "../../javascript/schema.json",
+            ],
+            menu:[
+                {
+                    name: "User",
+                    tags: [
+                        "User Authentication",
+                        "me",
+                        "mfa", // TODO: split 'mfa' into administration and self
+                        "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",
+                    ],
+                },
+                {
+                    name: "Event Monitoring",
+                    tags: [
+                        "Events",
+                        "Intakes by status",
+                        "Intakes errors and warnings",
+                        "Intakes lag and processing lag"
+                    ]
+                },
+                {
+                    name: "Getting started",
+                    tags: [
+                        "UEBA"
+                    ]
+                },
+                {
+                    name: "Identification",
+                    tags: [
+                        "Assets"
+                    ]
+                },
+                {
+                    name: "Automated Response",
+                    tags: [
+                        "Playbook actions telemetry"
+                    ]
+                },
+                {
+                    name: "Intelligence",
+                    tags: [
+                        "Objects",
+                        "Indicators",
+                        "Observables",
+                        "Observable relationships",
+                        "Exports",
+                        "Kill Chains",
+                        "Outgoing Feeds",
+                        "Collections",
+                        "MISP",
+                        "TAXII",
+                        "Bundles",
+                        "Images",
+                        "Labels",
+                        "CTI Objects",
+                    ],
+                },
+                {
+                    name: "Configuration",
+                    tags: [
+                        "Intakes",
+                        "Assets",
+                        "Intakes by status",
+                        "Intakes errors and warnings",
+                        "Intakes lag and processing lag",
+                        "formats",
+                    ],
+                },
+                {
+                    name: "Detection",
+                    tags: [
+                        "Rules",
+                        "datasources",
+                        "generation-modes",
+                        "rules-catalog",
+                        "alert-filter", // TODO: to create, this tag doesn't exist yet
+                        "IOC Collections",
+                        "Alert filters telemetry"
+                    ],
+                },
+                {
+                    name: "Alerts",
+                    tags: [
+                        "Alert",
+                        "Alert Entities",
+                        "Alert Rules",
+                        "Alert Sources and Targets",
+                        "Countermeasures",
+                        "Cyber Kill Chain",
+                        "Stats",
+                        "Alert Status",
+                        "Alert Type",
+                    ],
+                },
+                {
+                    name: "Cases",
+                    tags: [
+                        "Case",
+                        "Comments",
+                        "Enrichers",
+                        "Callbacks",
+                        "Services",
+                        "Tasks",
+                    ],
+                },
+                {
+                    name: "Automations",
+                    tags: [
+                        "Playbooks",
+                        "Playbook actions telemetry",
+                        "modules",
+                        "Action Runs",
+                        "Actions",
+                        "Connector Configurations",
+                        "Connectors",
+                        "Module Configurations",
+                        "Modules",
+                        "Runs",
+                        "Trigger Configurations",
+                        "Triggers",
+                    ],
+                },
+                {
+                    name: "AI assistant",
+                    tags: [
+                        "Roy tokens use telemetry",
+                    ],
+                },
+                {
+                    name:"Reporting",
+                    tags: [
+                        "Intelligence statistics",
+                        "Automation statistics",
+                        "Statistics",
+                    ]
+                }
+            ]
+        })
+    };
+</script>