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

Document the admin API #3038

Merged
merged 6 commits into from
Aug 7, 2024
Merged

Document the admin API #3038

merged 6 commits into from
Aug 7, 2024

Conversation

sandhose
Copy link
Member

@sandhose sandhose commented Jul 31, 2024

This documents the admin API, explaining how to use it, and links to the OpenAPI spec, as well as Swagger UI.

Fixes #2604
Fixes #2239

Copy link

cloudflare-workers-and-pages bot commented Jul 31, 2024

Deploying matrix-authentication-service-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 80e993e
Status: ✅  Deploy successful!
Preview URL: https://3acea481.matrix-authentication-service-docs.pages.dev
Branch Preview URL: https://quenting-admin-api-dev-doc.matrix-authentication-service-docs.pages.dev

View logs

@sandhose sandhose added A-Documentation Improvements or additions to documentation A-Admin-API Related to the admin API labels Jul 31, 2024
@sandhose sandhose force-pushed the quenting/admin-api/dev-doc branch 3 times, most recently from e582b12 to bf986f6 Compare August 1, 2024 14:31
@sandhose sandhose force-pushed the quenting/admin-api/merge branch from fab551c to 0f2363c Compare August 1, 2024 14:31
Copy link
Member

@hughns hughns left a comment

Choose a reason for hiding this comment

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

As per conversation this morning, we should clarify that the GraphQL API is now intended for internal (to MAS) usage only.

docs/SUMMARY.md Outdated Show resolved Hide resolved
docs/reference/scopes.md Outdated Show resolved Hide resolved
@sandhose sandhose mentioned this pull request Aug 2, 2024
13 tasks
@sandhose sandhose force-pushed the quenting/admin-api/dev-doc branch from 16b79cd to 57b1f88 Compare August 6, 2024 10:05
@sandhose sandhose changed the base branch from quenting/admin-api/merge to main August 6, 2024 10:05
@sandhose sandhose marked this pull request as ready for review August 6, 2024 10:05
@sandhose
Copy link
Member Author

sandhose commented Aug 6, 2024

I rebased it on top of main instead of the merge of all pending APIs, so that this can get merged without depending on the rest

@sandhose sandhose requested a review from hughns August 7, 2024 13:10
@sandhose sandhose force-pushed the quenting/admin-api/dev-doc branch from 57b1f88 to 80e993e Compare August 7, 2024 13:39
@sandhose sandhose merged commit eb4072f into main Aug 7, 2024
16 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-Admin-API Related to the admin API A-Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to leverage the client_credentials grant to gain admin-level API access API documenation
2 participants