Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

Add name parameter docs #280

Merged
merged 1 commit into from
Jun 7, 2017
Merged

Conversation

reist
Copy link
Contributor

@reist reist commented Apr 28, 2017

Groups and Users info calls have included search by name for a number of versions already.

Channels would as well once pull 6827 is merged.

@@ -12,7 +12,8 @@ Retrieves the information about the channel.
## Query Parameters
| Argument | Example | Required | Description |
| :--- | :--- | :--- | :--- |
| `roomId` | `ByehQjC44FwMeiLbX` | Required | The channel's id |
| `roomId` | `ByehQjC44FwMeiLbX` | Required (if no roomName) | The channel's id |
| `roomName` | `ByehQjC44FwMeiLbX` | Required (if no roomId) | The channel's name |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you change the example to be like a room name? This applies to all of these, thanks for the pull request!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops. Sure.

@reist reist force-pushed the info-by-name branch 2 times, most recently from c3c9cb4 to 1a2ee2a Compare May 2, 2017 14:12
@reist
Copy link
Contributor Author

reist commented Jun 4, 2017

@graywolf336 Any chance for another review? I updated the commits a month ago.

@@ -12,7 +12,8 @@ Retrieves the information about the private group, only if you're part of the gr
## Query Parameters
| Argument | Example | Required | Description |
| :--- | :--- | :--- | :--- |
| `roomId` | `ByehQjC44FwMeiLbX` | Required | The private group's id |
| `roomId` | `ByehQjC44FwMeiLbX` | Required (if no roomName) | The private group's id |
| `roomName` | `Exclusive Chat` | Required (if no roomId) | The private group's name |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spaces aren't allowed in the names of channels, so this wouldn't work..

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, right. Fixed and pushed.

@graywolf336
Copy link
Contributor

I apologise for that, thanks for the reminder

@graywolf336
Copy link
Contributor

Thanks for the pull request. I'll see about fixing the conflicts unless you want to.

related to Rocket.Chat pull 6827 syncing channels.info
@reist
Copy link
Contributor Author

reist commented Jun 5, 2017

@graywolf336 rebased and dropped the conflicting Users.info change. abrom added username there already.

@geekgonecrazy geekgonecrazy merged commit 21d0de3 into RocketChat:master Jun 7, 2017
@reist reist deleted the info-by-name branch July 9, 2017 10:57
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants