Skip to content
This repository has been archived by the owner on Dec 22, 2021. It is now read-only.

Add openapi spec for new SOGS API #30

Merged
merged 3 commits into from
Oct 26, 2021
Merged

Add openapi spec for new SOGS API #30

merged 3 commits into from
Oct 26, 2021

Conversation

jagerman
Copy link
Member

@jagerman jagerman commented Oct 8, 2021

TODO:

  • room ban list retrieval (for moderators/admins). Should be extensible in the future so that we can add fields (e.g. User-viewable ban reason #32 ) to rows without breaking the response structure.
  • room permission override retrieval so that moderators can view overrides to remove/update them.
  • Similar endpoints for global bans/permission overrides.
  • Endpoint to access list of global moderators/admins (we have this for rooms already, but not global mods).
  • Define generic error responses that can get returned from any endpoint.

src/api.yaml Outdated Show resolved Hide resolved
src/api.yaml Outdated Show resolved Hide resolved
The initial version came out of swagger edit, which is a crappy text
editor.
@jagerman
Copy link
Member Author

(Current version, as of this post, is viewable view a tool such as: https://redocly.github.io/redoc/?url=https://jagerman.com/api.yaml)

@jagerman jagerman changed the base branch from stable to dev October 26, 2021 16:01
@jagerman jagerman marked this pull request as ready for review October 26, 2021 16:01
@jagerman
Copy link
Member Author

Merging into dev, which we can continue to amend with future PRs before it gets merged into a stable release.

@jagerman jagerman merged commit c7bf4ac into oxen-io:dev Oct 26, 2021
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.

2 participants