Updating instructions to serve Swagger documentation (cvat-ai#1502)

Icxa · May 7, 2020 · 7b31525 · 7b31525
1 parent 1b93d6e
commit 7b31525
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,7 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -
 
 ### Fixed
--
+- Updated Rest API document, Swagger document serving instruction issue (https://github.com/opencv/cvat/issues/1495)
 
 ### Security
 -

diff --git a/README.md b/README.md
@@ -66,6 +66,8 @@ If you have any questions, please contact Onepanel directly at support@onepanel.
 Automatically generated Swagger documentation for Django REST API is
 available on ``<cvat_origin>/api/swagger`` (default: ``localhost:8080/api/swagger``).
 
+Swagger documentation is visiable on allowed hostes, Update environement variable in docker-compose.yml file with cvat hosted machine IP or domain name. Example - ``ALLOWED_HOSTS: 'localhost, 127.0.0.1'``)
+
 ## LICENSE
 
 Code released under the [MIT License](https://opensource.org/licenses/MIT).
-Original file line number
+Diff line change
@@ Expand Up @@
     -
     ### Fixed
-    -
+    - Updated Rest API document, Swagger document serving instruction issue (https://github.com/opencv/cvat/issues/1495)
     ### Security
     -
@@ Expand Down @@