-
Notifications
You must be signed in to change notification settings - Fork 385
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clarify the key object definition for the key management API #2083
Conversation
Fixes #1907 One too far
c6d742b
to
a19eb59
Compare
It's very annoying that Swagger doesn't support the thing we want to do (anyOf on a response schema). It supports it just fine for request parameters, but not in the response schema for some reason. Error is the cryptic:
Edit: our rendering engine can figure it out (which is why it is defined as such in the s2s spec), however we'll run into problems when https://github.com/matrix-org/matrix-doc/issues/2085 gets implemented. I'm inclined to just fork that problem off to that issue though rather than hide a swagger definition in both specs. |
errrm... looks like swagger. maybe? possibly? </dog_goggles> |
It's definitely swagger, although the diff (and swagger, annoyingly) is very confusing. It's supposed to be fix the nesting levels while also making documentation a thing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The content looks good. The structure (other than the error message from the above comment) looks plausible, though I'm not a swagger expert. Should be fine to merge once the error is fixed.
Another annoying case of Swagger fighting us
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
made a suggestion, but lgtm otherwise
Fixes #1907