rename endpoints swagger tags constants

tracim · Jul 27, 2018 · 4af0c0b · 4af0c0b
1 parent 4cef802
commit 4af0c0b
Show file tree

Hide file tree

Showing 8 changed files with 65 additions and 65 deletions.
diff --git a/tracim/views/contents_api/comment_controller.py b/tracim/views/contents_api/comment_controller.py
@@ -24,12 +24,12 @@
 from tracim.models.revision_protection import new_revision
 from tracim.models.data import UserRoleInWorkspace
 
-COMMENT_ENDPOINTS_TAG = 'Comments'
+SWAGGER_TAG__COMMENT_ENDPOINTS = 'Comments'
 
 
 class CommentController(Controller):
 
-    @hapic.with_api_doc(tags=[COMMENT_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__COMMENT_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @hapic.input_path(WorkspaceAndContentIdPathSchema())
     @hapic.output_body(CommentSchema(many=True))
@@ -55,7 +55,7 @@ def content_comments(self, context, request: TracimRequest, hapic_data=None):
                 for comment in comments
         ]
 
-    @hapic.with_api_doc(tags=[COMMENT_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__COMMENT_ENDPOINTS])
     @hapic.handle_exception(EmptyCommentContentNotAllowed, HTTPStatus.BAD_REQUEST)  # nopep8
     @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
     @hapic.input_path(WorkspaceAndContentIdPathSchema())
@@ -84,7 +84,7 @@ def add_comment(self, context, request: TracimRequest, hapic_data=None):
         )
         return api.get_content_in_context(comment)
 
-    @hapic.with_api_doc(tags=[COMMENT_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__COMMENT_ENDPOINTS])
     @require_comment_ownership_or_role(
         minimal_required_role_for_anyone=UserRoleInWorkspace.WORKSPACE_MANAGER,
         minimal_required_role_for_owner=UserRoleInWorkspace.CONTRIBUTOR,

diff --git a/tracim/views/contents_api/file_controller.py b/tracim/views/contents_api/file_controller.py
@@ -39,7 +39,7 @@
 from tracim.exceptions import PageOfPreviewNotFound
 from tracim.exceptions import PreviewDimNotAllowed
 
-FILE_ENDPOINTS_TAG = 'Files'
+SWAGGER_TAG__FILE_ENDPOINTS = 'Files'
 
 
 class FileController(Controller):
@@ -48,7 +48,7 @@ class FileController(Controller):
     """
 
     # File data
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
     @require_content_types([file_type])
     @hapic.input_path(WorkspaceAndContentIdPathSchema())
@@ -84,7 +84,7 @@ def upload_file(self, context, request: TracimRequest, hapic_data=None):
 
         return
 
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
     @hapic.input_path(WorkspaceAndContentIdPathSchema())
@@ -109,7 +109,7 @@ def download_file(self, context, request: TracimRequest, hapic_data=None):
         response.app_iter = FileIter(file)
         return response
 
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
     @hapic.input_path(WorkspaceAndContentRevisionIdPathSchema())
@@ -140,7 +140,7 @@ def download_revisions_file(self, context, request: TracimRequest, hapic_data=No
 
     # preview
     # pdf
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
     @hapic.handle_exception(UnavailablePreviewType, HTTPStatus.BAD_REQUEST)
@@ -169,7 +169,7 @@ def preview_pdf(self, context, request: TracimRequest, hapic_data=None):
         )
         return FileResponse(pdf_preview_path)
 
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
     @hapic.handle_exception(UnavailablePreviewType, HTTPStatus.BAD_REQUEST)
@@ -192,7 +192,7 @@ def preview_pdf_full(self, context, request: TracimRequest, hapic_data=None):  #
         pdf_preview_path = api.get_full_pdf_preview_path(content.revision_id)
         return FileResponse(pdf_preview_path)
 
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
     @hapic.handle_exception(UnavailablePreviewType, HTTPStatus.BAD_REQUEST)
@@ -225,7 +225,7 @@ def preview_pdf_revision(self, context, request: TracimRequest, hapic_data=None)
         return FileResponse(pdf_preview_path)
 
     # jpg
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
     @hapic.handle_exception(PageOfPreviewNotFound, HTTPStatus.BAD_REQUEST)
@@ -256,7 +256,7 @@ def preview_jpg(self, context, request: TracimRequest, hapic_data=None):
         )
         return FileResponse(jpg_preview_path)
 
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
     @hapic.handle_exception(PageOfPreviewNotFound, HTTPStatus.BAD_REQUEST)
@@ -287,7 +287,7 @@ def sized_preview_jpg(self, context, request: TracimRequest, hapic_data=None):
         )
         return FileResponse(jpg_preview_path)
 
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
     @hapic.handle_exception(PageOfPreviewNotFound, HTTPStatus.BAD_REQUEST)
@@ -322,7 +322,7 @@ def sized_preview_jpg_revision(self, context, request: TracimRequest, hapic_data
         )
         return FileResponse(jpg_preview_path)
 
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
     @hapic.input_path(WorkspaceAndContentIdPathSchema())
@@ -341,7 +341,7 @@ def allowed_dim_preview_jpg(self, context, request: TracimRequest, hapic_data=No
         return api.get_jpg_preview_allowed_dim()
 
     # File infos
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
     @hapic.input_path(WorkspaceAndContentIdPathSchema())
@@ -362,7 +362,7 @@ def get_file_infos(self, context, request: TracimRequest, hapic_data=None) -> Co
         )
         return api.get_content_in_context(content)
 
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @hapic.handle_exception(EmptyLabelNotAllowed, HTTPStatus.BAD_REQUEST)
     @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
     @require_content_types([file_type])
@@ -397,7 +397,7 @@ def update_file_info(self, context, request: TracimRequest, hapic_data=None) ->
             api.save(content)
         return api.get_content_in_context(content)
 
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([file_type])
     @hapic.input_path(WorkspaceAndContentIdPathSchema())
@@ -427,7 +427,7 @@ def get_file_revisions(
             for revision in revisions
         ]
 
-    @hapic.with_api_doc(tags=[FILE_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__FILE_ENDPOINTS])
     @hapic.handle_exception(EmptyLabelNotAllowed, HTTPStatus.BAD_REQUEST)
     @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
     @require_content_types([file_type])

diff --git a/tracim/views/contents_api/html_document_controller.py b/tracim/views/contents_api/html_document_controller.py
@@ -30,12 +30,12 @@
 from tracim.models.contents import html_documents_type
 from tracim.models.revision_protection import new_revision
 
-HTML_DOCUMENT_ENDPOINTS_TAG = 'HTML documents'
+SWAGGER_TAG__HTML_DOCUMENT_ENDPOINTS = 'HTML documents'
 
 
 class HTMLDocumentController(Controller):
 
-    @hapic.with_api_doc(tags=[HTML_DOCUMENT_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__HTML_DOCUMENT_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([html_documents_type])
     @hapic.input_path(WorkspaceAndContentIdPathSchema())
@@ -56,7 +56,7 @@ def get_html_document(self, context, request: TracimRequest, hapic_data=None) ->
         )
         return api.get_content_in_context(content)
 
-    @hapic.with_api_doc(tags=[HTML_DOCUMENT_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__HTML_DOCUMENT_ENDPOINTS])
     @hapic.handle_exception(EmptyLabelNotAllowed, HTTPStatus.BAD_REQUEST)
     @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
     @require_content_types([html_documents_type])
@@ -91,7 +91,7 @@ def update_html_document(self, context, request: TracimRequest, hapic_data=None)
             api.save(content)
         return api.get_content_in_context(content)
 
-    @hapic.with_api_doc(tags=[HTML_DOCUMENT_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__HTML_DOCUMENT_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([html_documents_type])
     @hapic.input_path(WorkspaceAndContentIdPathSchema())
@@ -121,7 +121,7 @@ def get_html_document_revisions(
             for revision in revisions
         ]
 
-    @hapic.with_api_doc(tags=[HTML_DOCUMENT_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__HTML_DOCUMENT_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
     @require_content_types([html_documents_type])
     @hapic.input_path(WorkspaceAndContentIdPathSchema())

diff --git a/tracim/views/contents_api/threads_controller.py b/tracim/views/contents_api/threads_controller.py
@@ -29,12 +29,12 @@
 from tracim.models.contents import thread_type
 from tracim.models.revision_protection import new_revision
 
-THREAD_ENDPOINTS_TAG = 'Threads'
+SWAGGER_TAG__THREAD_ENDPOINTS = 'Threads'
 
 
 class ThreadController(Controller):
 
-    @hapic.with_api_doc(tags=[THREAD_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__THREAD_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([thread_type])
     @hapic.input_path(WorkspaceAndContentIdPathSchema())
@@ -55,7 +55,7 @@ def get_thread(self, context, request: TracimRequest, hapic_data=None) -> Conten
         )
         return api.get_content_in_context(content)
 
-    @hapic.with_api_doc(tags=[THREAD_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__THREAD_ENDPOINTS])
     @hapic.handle_exception(EmptyLabelNotAllowed, HTTPStatus.BAD_REQUEST)
     @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
     @require_content_types([thread_type])
@@ -90,7 +90,7 @@ def update_thread(self, context, request: TracimRequest, hapic_data=None) -> Con
             api.save(content)
         return api.get_content_in_context(content)
 
-    @hapic.with_api_doc(tags=[THREAD_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__THREAD_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.READER)
     @require_content_types([thread_type])
     @hapic.input_path(WorkspaceAndContentIdPathSchema())
@@ -120,7 +120,7 @@ def get_thread_revisions(
             for revision in revisions
         ]
 
-    @hapic.with_api_doc(tags=[THREAD_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__THREAD_ENDPOINTS])
     @require_workspace_role(UserRoleInWorkspace.CONTRIBUTOR)
     @require_content_types([thread_type])
     @hapic.input_path(WorkspaceAndContentIdPathSchema())

diff --git a/tracim/views/core_api/session_controller.py b/tracim/views/core_api/session_controller.py
@@ -16,12 +16,12 @@
 from tracim.exceptions import NotAuthenticated
 from tracim.exceptions import AuthenticationFailed
 
-SESSION_ENDPOINTS_TAG = 'Session'
+SWAGGER_TAG__SESSION_ENDPOINTS_TAG = 'Session'
 
 
 class SessionController(Controller):
 
-    @hapic.with_api_doc(tags=[SESSION_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__SESSION_ENDPOINTS_TAG])
     @hapic.input_headers(LoginOutputHeaders())
     @hapic.input_body(BasicAuthSchema())
     # TODO - G.M - 17-04-2018 - fix output header ?
@@ -42,7 +42,7 @@ def login(self, context, request: TracimRequest, hapic_data=None):
         user = uapi.authenticate_user(login.email, login.password)
         return uapi.get_user_with_context(user)
 
-    @hapic.with_api_doc(tags=[SESSION_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__SESSION_ENDPOINTS_TAG])
     @hapic.output_body(NoContentSchema(), default_http_code=HTTPStatus.NO_CONTENT)  # nopep8
     def logout(self, context, request: TracimRequest, hapic_data=None):
         """
@@ -51,7 +51,7 @@ def logout(self, context, request: TracimRequest, hapic_data=None):
 
         return
 
-    @hapic.with_api_doc(tags=[SESSION_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__SESSION_ENDPOINTS_TAG])
     @hapic.output_body(UserSchema(),)
     def whoami(self, context, request: TracimRequest, hapic_data=None):
         """

diff --git a/tracim/views/core_api/system_controller.py b/tracim/views/core_api/system_controller.py
@@ -18,12 +18,12 @@
 from tracim.views.core_api.schemas import ApplicationSchema
 from tracim.views.core_api.schemas import ContentTypeSchema
 
-SYSTEM_ENDPOINTS_TAG = 'System'
+SWAGGER_TAG__SYSTEM_ENDPOINTS = 'System'
 
 
 class SystemController(Controller):
 
-    @hapic.with_api_doc(tags=[SYSTEM_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__SYSTEM_ENDPOINTS])
     @require_profile(Group.TIM_USER)
     @hapic.output_body(ApplicationSchema(many=True),)
     def applications(self, context, request: TracimRequest, hapic_data=None):
@@ -32,7 +32,7 @@ def applications(self, context, request: TracimRequest, hapic_data=None):
         """
         return applications
 
-    @hapic.with_api_doc(tags=[SYSTEM_ENDPOINTS_TAG])
+    @hapic.with_api_doc(tags=[SWAGGER_TAG__SYSTEM_ENDPOINTS])
     @require_profile(Group.TIM_USER)
     @hapic.output_body(ContentTypeSchema(many=True),)
     def content_types(self, context, request: TracimRequest, hapic_data=None):