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

Spec is unclear about what is stored in the content repository #772

Closed
jimmycuadra opened this issue Dec 30, 2016 · 1 comment · Fixed by #2068
Closed

Spec is unclear about what is stored in the content repository #772

jimmycuadra opened this issue Dec 30, 2016 · 1 comment · Fixed by #2068
Assignees
Labels
clarification An area where the spec could do with being more explicit client-server Client-Server API

Comments

@jimmycuadra
Copy link
Contributor

jimmycuadra commented Dec 30, 2016

Confusing/unclear things about the content repository module in the client-server spec:

  • The module is described with the terms "content" and "attachments" without ever defining what they mean.
  • Content stored in the repository is referred to in URLs and JSON objects as "media" rather than "content" or "attachments." This implies that it is intended for images, audio, and video, but is never actually stated.
  • Other than asking for a Content-Type header, the APIs seem to allow storage of arbitrary binary files, which is confusing since the content uploaded is sometimes referred to as "media".
  • The thumbnail API seems to assume that the content uploaded was an image, but doesn't mention anything about how the API should behave if the original content was not an image.
@turt2live turt2live added the clarification An area where the spec could do with being more explicit label Jul 9, 2018
@turt2live turt2live added the client-server Client-Server API label Sep 6, 2018
@turt2live turt2live self-assigned this Jun 3, 2019
turt2live added a commit that referenced this issue Jun 3, 2019
@jimmycuadra
Copy link
Contributor Author

I don't think #2068 totally covered what was reported in this issue. Specifically, it's still never stated explicitly what type of data can be uploaded and stored via this API. The words "content" and "media" are still used as they were when I originally reported this, and the high level description of the module now refers to the content as "files" but still does not state whether this means arbitrary binary data, or whether the data needs to be some format that the server understands. The follow up issue matrix-org/matrix-spec#453 further implies that only "media" (image, video, audio) files are expected, but it's still not clear.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification An area where the spec could do with being more explicit client-server Client-Server API
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants