adding swagger documentation

[spiderxm]

Added Swagger and Redoc documentation for rest apis.

[mlodic]

Thank you for your PR!

However it is really important that you read and follow the contributions guidelines.

Also please do not delete the PR template. You should compile it. Otherwise your contributions won't be considered. Everything you need to know is written there.

[eshaan7]

We need to make this autogenerate for every commit same way as readthedocs and host them publicly like: https://intelowl.readthedocs.io/api-docs.

How can we achieve that, @spiderxm?

[spiderxm]

We can use the command

python manage.py generateschema

This will generate open api definitions in yaml.
That can be used to make swagger documentation and serve them via different application.

[eshaan7]

This will generate open api definitions in yaml.
That can be used to make swagger documentation and serve them via different application.

Okay so what we need to do is create a GH action (or readthedocs webhook) which builds the .yml schema and puts it into /docs/source/ which then gets rendered using sphinx openapi extension sphinx redoc extension. (see Usage section, it's pretty straightforward to use this extension).

The catch here is that this action should take place before readthedocs build gets triggered for which you should find something in readthedocs documentation.

[eshaan7]

please fix codefactor issue

[eshaan7]

instead of adding this here, we should add a new file called schemas.py and add all this docs related code there.

[spiderxm]

Will look into it

[eshaan7]

sphinx-contrib/redoc#15