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.

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 use of JSON in requests and responses #1185

Merged
merged 4 commits into from
Jul 28, 2022

Conversation

richvdh
Copy link
Member

@richvdh richvdh commented Jul 26, 2022

@richvdh richvdh requested a review from a team as a code owner July 26, 2022 18:24
@@ -196,6 +208,8 @@ only read state (e.g.: `/sync`, get account data, etc).
The user is unable to reject an invite to join the server notices room.
See the [Server Notices](#server-notices) module for more information.

### Transaction identifiers
Copy link
Member Author

Choose a reason for hiding this comment

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

Gave this a new heading to stop it being stuck under "Other error codes"

@@ -208,8 +222,6 @@ Some API endpoints may allow or require the use of `POST` requests
without a transaction ID. Where this is optional, the use of a `PUT`
request is strongly recommended.

{{% http-api spec="client-server" api="versions" %}}
Copy link
Member Author

Choose a reason for hiding this comment

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

and moved this into "discovery" (for want of a better place), for the same reason.

content/client-server-api/_index.md Outdated Show resolved Hide resolved
content/identity-service-api.md Outdated Show resolved Hide resolved
content/server-server-api.md Outdated Show resolved Hide resolved
content/identity-service-api.md Outdated Show resolved Hide resolved
content/client-server-api/_index.md Outdated Show resolved Hide resolved
content/server-server-api.md Outdated Show resolved Hide resolved
@richvdh richvdh merged commit b232148 into main Jul 28, 2022
@richvdh richvdh deleted the rav/clarify_content_types branch July 28, 2022 12:45
with the exception of 200 responses to
[`GET /_matrix/media/v3/download/{serverName}/{mediaId}`](#get_matrixmediav3downloadservernamemediaid)
and [`GET /_matrix/media/v3/thumbnail/{serverName}/{mediaId}`](#get_matrixmediav3thumbnailservernamemediaid).
Servers msut include a `Content-Type` header of `application/json` for all JSON responses.
Copy link
Member

Choose a reason for hiding this comment

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

s/msut/must/

Copy link
Member Author

Choose a reason for hiding this comment

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

bother. thanks.

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed in 3dc3150

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Spec documentation does not say that request bodies are required
3 participants