Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Combine related admin API docs #8810

Closed
aaronraimist opened this issue Nov 25, 2020 · 4 comments · Fixed by #8839
Closed

Combine related admin API docs #8810

aaronraimist opened this issue Nov 25, 2020 · 4 comments · Fixed by #8839
Labels
A-Docs things relating to the documentation Z-Help-Wanted We know exactly how to fix this issue, and would be grateful for any contribution z-p3 (Deprecated Label)

Comments

@aaronraimist
Copy link
Contributor

aaronraimist commented Nov 25, 2020 •
edited
Loading

Currently there is a separate file for the purge remote media API docs and the rest of the media APIs
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/purge_remote_media.rst
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/media_admin_api.md

There is also separate files for the purge room API, shutdown room API, and then the rest of the room APIs
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/purge_room.md
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/shutdown_room.md
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/rooms.md

It probably makes sense for all of the media APIs to be in one file and all of the room APIs to be in another, rather than being spread out like this.
@dklimpel
Copy link
Contributor

These should be deprecated and removed:
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/purge_room.md
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/shutdown_room.md

@clokep clokep added A-Docs things relating to the documentation Z-Help-Wanted We know exactly how to fix this issue, and would be grateful for any contribution labels Nov 25, 2020
@clokep
Copy link
Member

clokep commented Nov 25, 2020

Agreed! Would really appreciate someone taking a once over of those and seeing how they could be better organized. Some of them (e.g. the rooms.md file) could use a table of contents at the top -- similar to the user_admin_api.md.

@clokep clokep added the z-p3 (Deprecated Label) label Nov 25, 2020
This was referenced Nov 26, 2020
Closed
Merged
Merged
Merged
@clokep clokep linked a pull request Nov 30, 2020 that will close this issue
Combine related media admin API docs #8839
Merged
4 tasks
anoadragon453 pushed a commit that referenced this issue Dec 9, 2020
@dklimpel
Combine related media admin API docs (#8839)
43bf3c5 
Related: #8810
Also a few small improvements.

Signed-off-by: Dirk Klimpel dirk@klimpel.org
@anoadragon453
Copy link
Member

These should be deprecated and removed:
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/purge_room.md
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/shutdown_room.md

This is still to be done, and will be once #8829 lands.

@anoadragon453 anoadragon453 reopened this Dec 9, 2020
anoadragon453 pushed a commit that referenced this issue Dec 10, 2020
@dklimpel
Deprecate Shutdown Room and Purge Room Admin API (#8829)
a5f7aff 
Deprecate both APIs in favour of the Delete Room API.

Related: #8663 and #8810
@anoadragon453
Copy link
Member

#8829 has now landed. Thanks @dklimpel!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
A-Docs things relating to the documentation Z-Help-Wanted We know exactly how to fix this issue, and would be grateful for any contribution z-p3 (Deprecated Label)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Combine related media admin API docs dklimpel/synapse_archive
4 participants
@clokep @anoadragon453 @dklimpel @aaronraimist