Skip to content
This repository was archived by the owner on Jun 29, 2023. It is now read-only.

documentation: 'D' direct channel for "channel a update" #455

Closed
wants to merge 1 commit into from

Conversation

Ashid6
Copy link

@Ashid6 Ashid6 commented Jun 23, 2019

description for "direct channel" should also come for "update a channel"

description for "direct channel" should also come for "update a channel"
@Ashid6
Copy link
Author

Ashid6 commented Jun 23, 2019

Hi All, I am a GSoD'19 applicant. This is a minor fix but completes the channels.yml issue #429

@hanzei hanzei requested a review from jwilander June 23, 2019 18:35
@jwilander
Copy link
Member

Hi @Ashid6, D is not actually a valid input for this API. To fix the linked ticket I think what we need to do is update the responses to any of the channel endpoints that return channels with a description on the type field explaining what the different values can be. Does that make sense?

@Ashid6
Copy link
Author

Ashid6 commented Jun 24, 2019

@jwilander yeah that makes sense. To update the responses I think we can change the definitions.yaml file at https://github.com/mattermost/mattermost-api-reference/blob/master/v4/source/definitions.yaml#L141
here should we add "description:" with the types of the channel i.e. "O" and "P"

But the problem is '#/definitions/Channel' is used by many different types of requests, where not necessary "O" and "P" types are used. either make inline change for each type of request or make new keys in definitions.yaml What do you think?

@jwilander
Copy link
Member

Sorry for the late response @Ashid6

I'd suggest trying new definitions first. If they don't end up being very reusable then I think it would make sense to move to inline changes for each request

@mattermod
Copy link
Contributor

This issue has been automatically labelled "stale" because it hasn't had recent activity.
A core team member will check in on the status of the PR to help with questions.
Thank you for your contribution!

/cc @jasonblais @hanzei

@jasonblais
Copy link
Contributor

Hey @Ashid6, let us know if you have any questions about the above? Happy to help :)

@hanzei
Copy link
Contributor

hanzei commented Aug 15, 2019

Closing this PR due to inactivity. Still, thanks for the contribution, @Ashid6! Let me know, if you still want to work on this.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants