Browse Source

Merge branch 'feature/578_add_api_for_workspace/apps' of github.com:tracim/tracim_backend into feature/578_add_api_for_workspace/apps

Guénaël Muller 6 years ago
parent
commit
87bf2dcfda
1 changed files with 12 additions and 0 deletions
  1. 12 0
      tracim/models/applications.py

+ 12 - 0
tracim/models/applications.py View File

@@ -16,6 +16,18 @@ class Application(object):
16 16
             config: typing.Dict[str, str],
17 17
             main_route: str,
18 18
     ) -> None:
19
+        """
20
+        @param label: public label of application
21
+        @param slug: identifier of application
22
+        @param icon: font awesome icon class
23
+        @param hexcolor: hexa color of application main color
24
+        @param is_active: True if application enable, False if inactive
25
+        @param config: a dict with eventual application config
26
+        @param main_route: the route of the frontend "home" screen of
27
+        the application. For exemple, if you have an application
28
+        called "calendar", the main route will be something
29
+        like /#/workspace/{wid}/calendar.
30
+        """
19 31
         self.label = label
20 32
         self.slug = slug
21 33
         self.fa_icon = fa_icon