#42: add docs for ws

dgroup · Feb 6, 2022 · e532d0c · e532d0c
1 parent 6a3c527
commit e532d0c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -133,4 +133,5 @@ dmypy.json
 .github/templates/*
 
 .local
+/.idea
 /.idea
diff --git a/g2w/ws.py b/g2w/ws.py
@@ -100,6 +100,15 @@ def add_task(self, prj, subj, body) -> dict:
         return post(url)
 
     def post_task_url(self, prj, subj, body) -> str:
+        """
+        Construct Worksection API url for new tickets creation
+          https://worksection.com/faq/api-task.html#q1577
+        where
+         - 'WS_URL_POST_TASK' env variable with Worksection endpoint URL
+         - 'WS_PRJ_{YOUR_PROJECT_ID}_POST_TASK_HASH' env variable with
+            Worksection md5 hash for this action:
+             /project/{YOUR_PROJECT_ID}/post_task{YOUR_API_KEY}
+        """
         url = env("WS_URL_POST_TASK").format(
             prj,
             subj,