/synapse

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Add some basic admin API docs #963

Merged
merged 2 commits into from Jul 28, 2016

Conversation

Reviewers
No reviews
Assignees

@ara4n ara4n

Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@erikjohnston @ara4n
@erikjohnston
Owner

erikjohnston commented Jul 28, 2016

No description provided.

@erikjohnston
Add some basic admin API docs

Some checks were not successful

1 failing and 9 successful checks
@matrixbot
Sytest SQLite (Merged PR) — Build finished.
Details
@matrixbot
Flake8 + Packaging (Commit) — Build #1272 origin/erikj/admin_docs succeeded in 36 sec
Details
@matrixbot
Flake8 + Packaging (Merged PR) — Build finished.
Details
@matrixbot
Sytest Dendron (Commit) — Build #379 origin/erikj/admin_docs succeeded in 7 min 16 sec
Details
@matrixbot
Sytest Dendron (Merged PR) — Build finished.
Details
@matrixbot
Sytest Postgres (Commit) — Build #1214 origin/erikj/admin_docs succeeded in 6 min 48 sec
Details
@matrixbot
Sytest Postgres (Merged PR) — Build finished.
Details
@matrixbot
Sytest SQLite (Commit) — Build #1242 origin/erikj/admin_docs succeeded in 5 min 52 sec
Details
@matrixbot
Unit Tests (Commit) — Build #1309 origin/erikj/admin_docs succeeded in 2 min 13 sec
Details
@matrixbot
Unit Tests (Merged PR) — Build finished.
Details
367b594

@erikjohnston erikjohnston assigned ara4n Jul 28, 2016

@ara4n ara4n and 1 other commented on an outdated diff Jul 28, 2016

View full outdated diff
docs/admin_api/purge_remote_media.rst
@@ -0,0 +1,19 @@
+Purge Remote Media API
+======================
+
+The purge remote media API allows server admins to purge old cached remote
+media.
+
+The API is::
+
+ POST /_matrix/client/r0/admin/purge_history/
@ara4n

ara4n Jul 28, 2016

Owner

really? surely purge_media or something?

@erikjohnston

erikjohnston Jul 28, 2016

Owner

Ooops, good spot. Fixed
@ara4n
Owner

ara4n commented Jul 28, 2016

why are these endpoints on the CS API if they're synapse-specific admin?
@erikjohnston
Use correct path

All checks have passed

9 successful checks
@matrixbot
Flake8 + Packaging (Commit) — Build #1274 origin/erikj/admin_docs succeeded in 1 min 18 sec
Details
@matrixbot
Flake8 + Packaging (Merged PR) — Build finished.
Details
@matrixbot
Sytest Dendron (Merged PR) — Build finished.
Details
@matrixbot
Sytest Postgres (Commit) — Build #1216 origin/erikj/admin_docs succeeded in 7 min 4 sec
Details
@matrixbot
Sytest Postgres (Merged PR) — Build finished.
Details
@matrixbot
Sytest SQLite (Commit) — Build #1244 origin/erikj/admin_docs succeeded in 5 min 59 sec
Details
@matrixbot
Sytest SQLite (Merged PR) — Build finished.
Details
@matrixbot
Unit Tests (Commit) — Build #1311 origin/erikj/admin_docs succeeded in 2 min 29 sec
Details
@matrixbot
Unit Tests (Merged PR) — Build finished.
Details
3c3246c
@erikjohnston
Owner

erikjohnston commented Jul 28, 2016

The admin API has always been there. I can move them I suppose, or doc them as /_matrix/client/unstable/admin/... ?
@ara4n
Owner

ara4n commented Jul 28, 2016

let's move it in future. this LGTM otherwise.

@erikjohnston erikjohnston merged commit 591ad22 into develop Jul 28, 2016
7 of 9 checks passed

7 of 9 checks passed

Sytest Dendron (Merged PR) Build started sha1 is merged.
Details
Sytest Postgres (Commit) Build #1216 origin/erikj/admin_docs in progress...
Details
Flake8 + Packaging (Commit) Build #1274 origin/erikj/admin_docs succeeded in 1 min 18 sec
Details
Flake8 + Packaging (Merged PR) Build finished.
Details
Sytest Postgres (Merged PR) Build finished.
Details
Sytest SQLite (Commit) Build #1244 origin/erikj/admin_docs succeeded in 5 min 59 sec
Details
Sytest SQLite (Merged PR) Build finished.
Details
Unit Tests (Commit) Build #1311 origin/erikj/admin_docs succeeded in 2 min 29 sec
Details
Unit Tests (Merged PR) Build finished.
Details

@richvdh richvdh deleted the erikj/admin_docs branch Dec 1, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment