Swagger download capability

[4sfaloth]

Hi all,

I wanted to generate a Python client for the cvat REST API through its swagger documentation. Usually I can do so using http://editor.swagger.io/, either by importing the swagger as a .json file on my disk or by linking to the swagger URL directly. However in the case of CVAT I am unable to link to the swagger URL (it gives an authentication error, I believe it is because you need to log-in to access the swagger) nor can I find any way to download the swagger as a .json.
I guess for now I'll start implementing the methods myself based on the swagger documentation, but it would be really nice to have a way to auto-generate clients. Any idea how I can do that?

Thanks in advance

[nmanovic]

A related PR: #732

[nmanovic]

It seems that generating of swagger documentation doesn't work properly. Need to investigate.

(cvat) nmanovic@nmanovic-pc:/workspace/cvat$ python manage.py generate_swagger
System check identified some issues:

WARNINGS:
?: (2_0.W001) Your URL pattern 'api/swagger.<slug:format>$' [name='schema-json'] has a route that contains '(?P<', begins with a '^', or ends with a '$'. This was likely an oversight when migrating to django.urls.path().
Traceback (most recent call last):
  File "manage.py", line 21, in <module>
    execute_from_command_line(sys.argv)
  File "/home/nmanovic/.virtualenvs/cvat/lib/python3.6/site-packages/django/core/management/__init__.py", line 381, in execute_from_command_line
    utility.execute()
  File "/home/nmanovic/.virtualenvs/cvat/lib/python3.6/site-packages/django/core/management/__init__.py", line 375, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/home/nmanovic/.virtualenvs/cvat/lib/python3.6/site-packages/django/core/management/base.py", line 323, in run_from_argv
    self.execute(*args, **cmd_options)
  File "/home/nmanovic/.virtualenvs/cvat/lib/python3.6/site-packages/django/core/management/base.py", line 364, in execute
    output = self.handle(*args, **options)
  File "/home/nmanovic/.virtualenvs/cvat/lib/python3.6/site-packages/drf_yasg/management/commands/generate_swagger.py", line 120, in handle
    'settings.SWAGGER_SETTINGS["DEFAULT_INFO"] should be an '
django.core.exceptions.ImproperlyConfigured: settings.SWAGGER_SETTINGS["DEFAULT_INFO"] should be an import string pointing to an openapi.Info object

[bsekachev]

Related PR #936

[nmanovic]

It should be fixed by #978

try /api/swagger.json or /api/swagger.yaml