TDL-19198: Provide description of groups in README #88
Conversation
jtilala
requested review from
dbshah1212,
KrisPersonal,
nitingaikwad1,
RushiT0122,
savan-chovatiya and
shantanu73
| @@ -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. `groups` is optional parameter. Default value of groups is ["jira-administrators", "jira-software-users", "jira-core-users", "jira-users", "site-admin", "users"]. | |||
|
|
|||
There was a problem hiding this comment.
I think the default value is as per below.
Lines 230 to 234 in 41be597
There was a problem hiding this comment.
Yea, I have updated the groups default values as shown in streams.py
README.md
Outdated
| @@ -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" | |||
There was a problem hiding this comment.
| "groups": "jira-administrators,site-admins,jira-software-users" | |
| "groups": "jira-administrators, site-admins, jira-software-users" |
There was a problem hiding this comment.
As shown in the code, when we split the 'groups' value, we are not removing extra spaces. So if we are giving 'groups' value with space as shown in the above suggestion, we are getting a list ["jira-administrators", " site-admins", " jira-software-users"] instead of ["jira-administrators", "site-admins", "jira-software-users"].
There was a problem hiding this comment.
I think extra space should not fail the tap. Ideally after a split we should strip() the leading spaces.
There was a problem hiding this comment.
In the existing code, we are not using strip, but this suggestion is right, we should ignore extra spaces, so added strip() and also updated README as per code change.
README.md
Outdated
| @@ -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" | |||
There was a problem hiding this comment.
| "groups": "jira-administrators,site-admins,jira-software-users" | |
| "groups": "jira-administrators, site-admins, jira-software-users" |
There was a problem hiding this comment.
As discussed above we can not pass 'groups' value with extra spaces.
README.md
Outdated
| @@ -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. `groups` is optional parameter. Default value of groups is `["jira-administrators", "jira-software-users", "jira-core-users", "jira-users", "users"]`. | |||
There was a problem hiding this comment.
| The `groups` specifies groups for users stream. `groups` is optional parameter. Default value of groups is `["jira-administrators", "jira-software-users", "jira-core-users", "jira-users", "users"]`. | |
| 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"]`. |
There was a problem hiding this comment.
Yeah, it looks good, I have updated the comment as per suggestion.
Description of change
Manual QA steps
Risks
Rollback steps