TDL-19198: Provide description of groups in README (#88)

* add description for groups in README * formted description * udpate default values in description * change the description of the 'groups' * add group strip in code * updated README as per code change Co-authored-by: Jay Tilala <[email protected]>
singer-io · Jun 1, 2022 · 37df463 · 37df463
1 parent 41be597
commit 37df463
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -41,7 +41,8 @@ This tap:
         "password": "your-jira-password",
         "base_url": "https://your-jira-domain",
         "user_agent": "<user-agent>",
-        "request_timeout": 300
+        "request_timeout": 300,
+        "groups": "jira-administrators, site-admins, jira-software-users"
     }
     ```
 
@@ -56,7 +57,8 @@ This tap:
      "cloud_id": "<cloud-id>",
      "refresh_token": "<refresh-token>",
      "start_date": "<i.e. 2017-12-04T19:19:32Z>",
-     "request_timeout": 300
+     "request_timeout": 300,
+     "groups": "jira-administrators, site-admins, jira-software-users"
    }
    ```
 
@@ -67,6 +69,8 @@ This tap:
    can be found. For example, it might look like:
    `https://mycompany.atlassian.net`.
 
+   The `groups` specifies groups for users stream. It is an optional parameter. Default value is `["jira-administrators", "jira-software-users", "jira-core-users", "jira-users", "users"]`.
+
 4. Run the Tap in Discovery Mode
 
    ```

diff --git a/tap_jira/streams.py b/tap_jira/streams.py
@@ -234,6 +234,7 @@ def sync(self):
                       "users"]
 
         for group in groups:
+            group = group.strip()
             try:
                 params = {"groupname": group,
                           "maxResults": max_results,