[WIP] REST API endpoints Testing Plan

[shiqimei]

To-Do List:

Note: REST API endpoints with ✓ status means they work well right now that we don't need to update it yet.

• Miscellaneous Information

REST APIs	Related PR	Status
/api/info	#1212	Closed (this endpoint will be deprecated in the future #1146)
/api/v1/directory	#1226	Merged
/api/v1/shield.svg	✓	✓
/api/v1/spotlight	✓	✓
/api/v1/statistics	#1215	Merged
/api/v1/statistics.list	#1215	Merged

• Assets

REST APIs	Related PR	Status
/api/v1/assets.setAsset	#1227	Merged
/api/v1/assets.unsetAsset	#1227	Merged

• Authentication

REST APIs	Related PR	Status
/api/v1/login	#1245	Merged
/api/v1/logout	#1245	Merged
/api/v1/me	#1245	Merged

• Users

REST APIs	Related PR	Status
/api/v1/users.create	#1246	Merged
/api/v1/users.createToken	#1249	Merged
/api/v1/users.delete	#1249	Merged
/api/v1/users.deleteOwnAccount	#1249	Merged
/api/v1/users.forgotPassword	#1249	Merged
/api/v1/users.generatePersonalAccessToken	#1258	Merged
/api/v1/users.getAvatar	#1278	Merged
/api/v1/users.getPersonalAccessTokens	#1258	Merged
/api/v1/users.getPreferences	#1278	Merged
/api/v1/users.getPresence	#1278	Merged
/api/v1/users.getUsernameSuggestion	✓	✓
/api/v1/users.info	✓	✓
/api/v1/users.list	#1280	Pending
/api/v1/users.regeneratePersonalAccessToken	#1258	Merged
/api/v1/users.register	#1280	Pending
/api/v1/users.removePersonalAccessToken	#1258	Pending
/api/v1/users.resetAvatar	#1280	Pending
/api/v1/users.setAvatar	#1280	Pending
/api/v1/users.setPreferences	-	Working in Progress
/api/v1/users.setActiveStatus	-	Working in Progress
/api/v1/users.update	-	Working in Progress
/api/v1/users.updateOwnBasicInfo	-	Working in Progress

• Channels

REST APIs	Related PR	Status
/api/v1/channels.addAll
/api/v1/channels.addLeader
/api/v1/channels.archive
/api/v1/channels.cleanHistory
/api/v1/channels.close
/api/v1/channels.counters
/api/v1/channels.create
/api/v1/channels.delete
/api/v1/channels.files
/api/v1/channels.getAllUserMentionsByChannel
/api/v1/channels.getIntegrations
/api/v1/channels.history
/api/v1/channels.info
/api/v1/channels.invite
/api/v1/channels.join
/api/v1/channels.kick
/api/v1/channels.leave
/api/v1/channels.list
/api/v1/channels.list.joined
/api/v1/channels.members
/api/v1/channels.messages
/api/v1/channels.moderators
/api/v1/channels.online
/api/v1/channels.open
/api/v1/channels.removeleader
/api/v1/channels.rename
/api/v1/channels.roles
/api/v1/channels.setCustomFields
/api/v1/channels.setAnnouncement
/api/v1/channels.setDefault
/api/v1/channels.setDescription
/api/v1/channels.setJoinCode
/api/v1/channels.setPurpose
/api/v1/channels.setReadOnly
/api/v1/channels.setTopic
/api/v1/channels.setType
/api/v1/channels.unarchive

Continuous testing will be done until ensuring all the existing rest API endpoints works well :)

[Rodriq]

Well done @lolimay !
Let me know if you need a hand. I've been testing some of the endpoints too. :)

[shiqimei]

Well done @lolimay !
Let me know if you need a hand. I've been testing some of the endpoints too. :)

Great! You can comment on what you will do below so that I will not repeat your work.

[Rodriq]

Hey @lolimay I'll start with the channels.

[Rodriq]

• Channels

REST APIs	Related PR	Status
/api/v1/channels.addAll		Working in Progress
/api/v1/channels.addLeader	RocketChat/docs#1279	Not Merged
/api/v1/channels.addModerator	RocketChat/docs#1279	Not Merged
/api/v1/channels.addOwner	RocketChat/docs#1279	Not Merged
/api/v1/channels.archive	RocketChat/docs#1279	Not Merged
/api/v1/channels.close		Working in Progress