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

Remove the "required" designation from the `url` field of certain m.room.message msgtypes. #2129

Merged

Conversation

@jimmycuadra
Copy link
Contributor

jimmycuadra commented Jun 14, 2019

Now that content referenced by the m.audio, m.file, m.image, and m.video message types can be encrypted, the url field is required only if the content is unencrypted. The "required" designation in the event schemas (which prefixes the field description with "Required" in bold in the generated HTML) is used to indicate fields which must always be present, and this is no longer the case.

Signed-off-by: Jimmy Cuadra jimmy@jimmycuadra.com

@jimmycuadra jimmycuadra force-pushed the jimmycuadra:conditionally-required-url-fields branch from c8b5d64 to b09494f Jun 14, 2019
Copy link
Member

turt2live left a comment

otherwise lgtm - thanks

This was mistakenly handled in #2053 as I failed to read the descriptions :(

m.room.message msgtypes.

Now that content referenced by the *m.audio*, *m.file*, *m.image*, and
*m.video* message types can be encrypted, the `url` field is required
*only* if the content is unencrypted. The "required" designation in the
event schemas (which prefixes the field description with "Required" in
bold in the generated HTML) is used to indicate fields which must always
be present, and this is no longer the case.

Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
@jimmycuadra jimmycuadra force-pushed the jimmycuadra:conditionally-required-url-fields branch from b09494f to b885714 Jun 14, 2019
@turt2live turt2live merged commit b807e1c into matrix-org:master Jun 14, 2019
7 checks passed
7 checks passed
ci/circleci: build-dev-scripts Your tests passed on CircleCI!
Details
ci/circleci: build-docs Your tests passed on CircleCI!
Details
ci/circleci: build-swagger Your tests passed on CircleCI!
Details
ci/circleci: check-docs Your tests passed on CircleCI!
Details
ci/circleci: validate-docs Your tests passed on CircleCI!
Details
docs Click details to preview the HTML documentation.
Details
swagger Click to preview the swagger build.
Details
@jimmycuadra jimmycuadra deleted the jimmycuadra:conditionally-required-url-fields branch Jun 14, 2019
@jplatte jplatte referenced this pull request Nov 9, 2019
1 of 21 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.