Skip to content

Commit 8f29088

Browse files
committed
Changing API-docs format
Signed-off-by: aryan <[email protected]>
1 parent 430f3f8 commit 8f29088

File tree

1 file changed

+55
-1
lines changed

1 file changed

+55
-1
lines changed

docs/IntelOwl/api_docs.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,55 @@
1-
<swagger-ui src="../Submodules/IntelOwl/docs/source/schema.yml"/>
1+
# API Documentation
2+
3+
## Global Functions
4+
5+
### `ask_analysis_availability`
6+
:::docs.Submodules.IntelOwl.api_app.views.ask_analysis_availability
7+
8+
### `ask_multi_analysis_availability`
9+
:::docs.Submodules.IntelOwl.api_app.views.ask_multi_analysis_availability
10+
11+
### `analyze_file`
12+
:::docs.Submodules.IntelOwl.api_app.views.analyze_file
13+
14+
### `analyze_multiple_files`
15+
:::docs.Submodules.IntelOwl.api_app.views.analyze_multiple_files
16+
17+
### `analyze_observable`
18+
:::docs.Submodules.IntelOwl.api_app.views.analyze_observable
19+
20+
### `analyze_multiple_observables`
21+
:::docs.Submodules.IntelOwl.api_app.views.analyze_multiple_observables
22+
23+
## Classes
24+
25+
### `CommentViewSet`
26+
:::docs.Submodules.IntelOwl.api_app.views.CommentViewSet
27+
28+
### `JobViewSet`
29+
:::docs.Submodules.IntelOwl.api_app.views.JobViewSet
30+
31+
### `TagViewSet`
32+
:::docs.Submodules.IntelOwl.api_app.views.TagViewSet
33+
34+
### `ModelWithOwnershipViewSet`
35+
:::docs.Submodules.IntelOwl.api_app.views.ModelWithOwnershipViewSet
36+
37+
### `PluginConfigViewSet`
38+
:::docs.Submodules.IntelOwl.api_app.views.PluginConfigViewSet
39+
40+
### `PythonReportActionViewSet`
41+
:::docs.Submodules.IntelOwl.api_app.views.PythonReportActionViewSet
42+
43+
### `AbstractConfigViewSet`
44+
:::docs.Submodules.IntelOwl.api_app.views.AbstractConfigViewSet
45+
46+
### `PythonConfigViewSet`
47+
:::docs.Submodules.IntelOwl.api_app.views.PythonConfigViewSet
48+
49+
## Functions
50+
51+
### `plugin_state_viewer`
52+
:::docs.Submodules.IntelOwl.api_app.views.plugin_state_viewer
53+
54+
55+

0 commit comments

Comments
 (0)