wip: preview for intelligence service api doc

SEKOIA-IO · Jan 16, 2025 · 33edd83 · 33edd83
1 parent 595893c
commit 33edd83
Show file tree

Hide file tree

Showing 5 changed files with 7,859 additions and 28 deletions.
diff --git a/docs/developer/api.md b/docs/developer/api.md
@@ -18,18 +18,19 @@ template: overrides/openapi.html
                 "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/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/v1/enricher/swagger.json?context=tip",
-                "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",
+                // "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/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/v1/enricher/swagger.json?context=tip",
+                // "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",
+                "/javascript/schema.json"
             ],
             menu:[
                 {
@@ -59,21 +60,19 @@ template: overrides/openapi.html
                 {
                     name: "Intelligence",
                     tags: [
+                        "Objects",
+                        "Indicators",
                         "Observables",
-                        "CTI Objects",
-                        "Bundles",
-                        "Collections",
+                        "Observable relationships",
                         "Exports",
+                        "Kill Chains",
                         "Outgoing Feeds",
-                        "Graphs",
+                        "Collections",
                         "MISP",
-                        "Objects",
-                        "Observable relationships",
-                        "Indicators",
+                        "TAXII",
+                        "Bundles",
                         "Images",
-                        "support",
                         "Labels",
-                        "Kill Chains",
                     ],
                 },
                 {
@@ -86,18 +85,18 @@ template: overrides/openapi.html
                         "Intakes errors and warnings",
                         "Intakes lag and processing lag",
                         "formats",
-                        "IOC Collections",
                     ],
                 },
 
                 {
-                    name: "Detection rules",
+                    name: "Detection",
                     tags: [
                         "Rules",
                         "datasources",
                         "generation-modes",
                         "rules-catalog",
                         "alert-filter", // TODO: to create, this tag doesn't exist yet
+                        "IOC Collections",
                     ],
                 },
                 {
@@ -119,7 +118,6 @@ template: overrides/openapi.html
                     tags: [
                         "Case",
                         "Comments",
-                        "Statistics",
                         "Enrichers",
                         "Callbacks",
                         "Services",
@@ -151,6 +149,13 @@ template: overrides/openapi.html
                         "Roy tokens use telemetry",
                     ],
                 },
+                {
+                    name:"Reporting",
+                    tags: [
+                        "Intelligence statistics",
+                        "Statistics",
+                    ]
+                }
             ]
         })
     };

diff --git a/docs/javascript/openapi-viewer.min.js b/docs/javascript/openapi-viewer.min.js