Add slack connection apis #432
Conversation
There was a problem hiding this comment.
Thank you for your contribution. I think there are a few changes to be made before we can merge it.
Also, can you please squash the commits of the branch so all of these changes are within a single commit? It helps keep the history of the primary branch more clear.
|
|
||
| // SlackConnection is an entity that represents a Slack connections as per the | ||
| // documentation https://developer.pagerduty.com/api-reference/c2NoOjExMjA5MzMy-slack-connection. | ||
| type SlackConnection struct { |
There was a problem hiding this comment.
This type seems to be missing the ID string field.
| type SlackConnectionObject struct { | ||
| SlackConnection | ||
| APIObject | ||
| } |
There was a problem hiding this comment.
We intend to no longer use embedding in this project. Please list the fields on the type explicitly. See #318 for more details.
That said, I think we should probably just elide this type entirely and put all of the fields in the SlackConnection type.
| // ListSlackConnectionsResponse is an API object returned by the list function. | ||
| type ListSlackConnectionsResponse struct { | ||
| Connections []SlackConnectionObject `json:"slack_connections"` | ||
| APIListObject |
There was a problem hiding this comment.
Same comment around embedding as well.
| } | ||
|
|
||
| // CreateSlackConnectionWithContext creates a Slack connection. | ||
| func (c *Client) CreateSlackConnectionWithContext(ctx context.Context, slackTeamID string, s SlackConnection) (SlackConnectionObject, error) { |
There was a problem hiding this comment.
Please remove WithContext from the name, since there is not a non-context version.
| } | ||
|
|
||
| // GetSlackConnection gets a Slack connection. | ||
| func (c *Client) GetSlackConnectionWithContext(ctx context.Context, slackTeamID, connectionID string) (SlackConnectionObject, error) { |
There was a problem hiding this comment.
Please remove WithContext from the name, since there is not a non-context version.
| } | ||
|
|
||
| // DeleteSlackConnectionWithContext deletes a Slack connection. | ||
| func (c *Client) DeleteSlackConnectionWithContext(ctx context.Context, slackTeamID, connectionID string) error { |
There was a problem hiding this comment.
Please remove WithContext from the name, since there is not a non-context version.
| } | ||
|
|
||
| // UpdateSlackConnectionWithContext updates an existing Slack connection. | ||
| func (c *Client) UpdateSlackConnectionWithContext(ctx context.Context, slackTeamID, connectionID string, s SlackConnection) (SlackConnectionObject, error) { |
There was a problem hiding this comment.
Please remove WithContext from the name, since there is not a non-context version.
| } | ||
|
|
||
| // ListSlackConnectionsWithContext lists Slack connections. | ||
| func (c *Client) ListSlackConnectionsWithContext(ctx context.Context, slackTeamID string, o ListSlackConnectionsOptions) (*ListSlackConnectionsResponse, error) { |
There was a problem hiding this comment.
Please remove WithContext from the name, since there is not a non-context version. Also, I don't think this should return a pointer type. We're going to be moving away from those when it makes sense (#270).
| func dupeRequest(r *http.Request) (*http.Request, error) { | ||
| data, err := ioutil.ReadAll(r.Body) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to copy request body: %w", err) | ||
| } | ||
| var data []byte | ||
| // Body can be nil in GET requests, for example. | ||
| if r.Body != nil { | ||
| bodyData, err := ioutil.ReadAll(r.Body) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to copy request body: %w", err) | ||
| } | ||
|
|
||
| _ = r.Body.Close() | ||
| _ = r.Body.Close() | ||
|
|
||
| data = bodyData | ||
| } | ||
|
|
||
| dreq := r.Clone(r.Context()) | ||
|
|
||
| r.Body = ioutil.NopCloser(bytes.NewReader(data)) | ||
| dreq.Body = ioutil.NopCloser(bytes.NewReader(data)) | ||
| if data != nil { | ||
| r.Body = ioutil.NopCloser(bytes.NewReader(data)) | ||
| dreq.Body = ioutil.NopCloser(bytes.NewReader(data)) | ||
| } |
There was a problem hiding this comment.
Could you please raise this chunk as an isolated PR?
Add code for working with the relatively new Slack connection APIs as defined here: https://developer.pagerduty.com/api-reference/b3A6MTEyMDk1NDU-list-slack-connections and in other pages.
Tests pass: