From 8f2908862f84bec87d4efab43aae4c7656b01d6e Mon Sep 17 00:00:00 2001 From: aryan Date: Sat, 24 Aug 2024 01:25:35 +0530 Subject: [PATCH] Changing API-docs format Signed-off-by: aryan --- docs/IntelOwl/api_docs.md | 56 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/docs/IntelOwl/api_docs.md b/docs/IntelOwl/api_docs.md index 1b23a16..1fbf4a6 100644 --- a/docs/IntelOwl/api_docs.md +++ b/docs/IntelOwl/api_docs.md @@ -1 +1,55 @@ - +# API Documentation + +## Global Functions + +### `ask_analysis_availability` +:::docs.Submodules.IntelOwl.api_app.views.ask_analysis_availability + +### `ask_multi_analysis_availability` +:::docs.Submodules.IntelOwl.api_app.views.ask_multi_analysis_availability + +### `analyze_file` +:::docs.Submodules.IntelOwl.api_app.views.analyze_file + +### `analyze_multiple_files` +:::docs.Submodules.IntelOwl.api_app.views.analyze_multiple_files + +### `analyze_observable` +:::docs.Submodules.IntelOwl.api_app.views.analyze_observable + +### `analyze_multiple_observables` +:::docs.Submodules.IntelOwl.api_app.views.analyze_multiple_observables + +## Classes + +### `CommentViewSet` +:::docs.Submodules.IntelOwl.api_app.views.CommentViewSet + +### `JobViewSet` +:::docs.Submodules.IntelOwl.api_app.views.JobViewSet + +### `TagViewSet` +:::docs.Submodules.IntelOwl.api_app.views.TagViewSet + +### `ModelWithOwnershipViewSet` +:::docs.Submodules.IntelOwl.api_app.views.ModelWithOwnershipViewSet + +### `PluginConfigViewSet` +:::docs.Submodules.IntelOwl.api_app.views.PluginConfigViewSet + +### `PythonReportActionViewSet` +:::docs.Submodules.IntelOwl.api_app.views.PythonReportActionViewSet + +### `AbstractConfigViewSet` +:::docs.Submodules.IntelOwl.api_app.views.AbstractConfigViewSet + +### `PythonConfigViewSet` +:::docs.Submodules.IntelOwl.api_app.views.PythonConfigViewSet + +## Functions + +### `plugin_state_viewer` +:::docs.Submodules.IntelOwl.api_app.views.plugin_state_viewer + + +