Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Spec documentation does not say that request bodies are required #1182

Closed
richvdh opened this issue Jul 26, 2022 · 1 comment · Fixed by #1185
Closed

Spec documentation does not say that request bodies are required #1182

richvdh opened this issue Jul 26, 2022 · 1 comment · Fixed by #1185
Labels
clarification An area where the expected behaviour is understood, but the spec could do with being more explicit

Comments

@richvdh
Copy link
Member

richvdh commented Jul 26, 2022 •
edited
Loading

The OpenAPI definitions all have required: true for request bodies (meaning that clients must provide an empty JSON object even if they don't want to set any of the parameters), but this isn't reflected in the words of the spec.
@richvdh richvdh transferred this issue from matrix-org/matrix-spec-proposals Jul 26, 2022
@richvdh
Copy link
Member Author

richvdh commented Jul 26, 2022

possibly some text in the "API standards" section

@richvdh richvdh mentioned this issue Jul 26, 2022
Merged
@turt2live turt2live added the clarification An area where the expected behaviour is understood, but the spec could do with being more explicit label Jul 27, 2022
richvdh added a commit that referenced this issue Jul 28, 2022
@richvdh
Clarify the use of JSON in requests and responses (#1185)
b232148 
Fixes #1182
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
clarification An area where the expected behaviour is understood, but the spec could do with being more explicit
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Clarify the use of JSON in requests and responses matrix-org/matrix-spec
2 participants
@turt2live @richvdh