matrix-spec/event-schemas/schema
Jimmy Cuadra bc71dacaf4 Clarify the distinction between *m.key.verification.start* and its *m.sas.v1* variant.
Currently the *m.key.verification.start* event appears twice with the
exact same title, in the "Key verification framework" section and the
"Short Authentication (SAS) verification" section. It's not immediately
clear that the first occurrence describes the format of the event in
general terms and that the second occurrence describes the fields when
the *m.sas.v1* verification method is being used. This is a similar
relationship to the *m.room.message* event and its various *msgtype*
variants.

This commit does three things:

* It tweaks the generation of the documentation to change the title
  of the second occurrence of *m.key.verification.start* to
  distinguish it from the first.
* It updates the language in the description of the two versions of the
  event to better describe the relationship between the two.
* It adds the optional `next_method` field to the schema of the
  *m.sas.v1* variant, as specified in the general form of
  *m.key.verification.start*.

Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
2019-06-14 16:20:51 -07:00
..
core-event-schema Merge pull request #2087 from matrix-org/travis/1.0/events-are-extensible 2019-06-11 09:55:17 -06:00
m.call.answer Make all the schema files yaml 2015-12-07 13:56:36 +00:00
m.call.candidates Make all the schema files yaml 2015-12-07 13:56:36 +00:00
m.call.hangup Move wording for reason definitions 2019-05-27 21:18:04 -06:00
m.call.invite Fix a typo in m.call.invite 2019-04-20 21:56:43 +02:00
m.direct Better types for additionalProps 2016-10-14 15:57:52 +01:00
m.dummy typo 2019-05-30 16:51:24 -06:00
m.forwarded_room_key fixup! document m.forwarded_room_key 2018-08-25 17:26:00 +02:00
m.fully_read Add read markers 2018-08-30 16:21:31 -06:00
m.ignored_user_list Add clarity to the m.ignored_user_list 2018-03-06 10:32:18 -07:00
m.key.verification.accept Apply suggestions from code review 2019-06-07 08:01:17 -06:00
m.key.verification.cancel Spec SAS verification and the common key verification framework 2019-06-04 12:43:47 -06:00
m.key.verification.key Spec SAS verification and the common key verification framework 2019-06-04 12:43:47 -06:00
m.key.verification.mac Spec SAS verification and the common key verification framework 2019-06-04 12:43:47 -06:00
m.key.verification.request Spec SAS verification and the common key verification framework 2019-06-04 12:43:47 -06:00
m.key.verification.start Clarify the distinction between *m.key.verification.start* and its *m.sas.v1* variant. 2019-06-14 16:20:51 -07:00
m.key.verification.start$m.sas.v1 Clarify the distinction between *m.key.verification.start* and its *m.sas.v1* variant. 2019-06-14 16:20:51 -07:00
m.presence Update the m.presence schema to include status_msg 2018-12-10 15:44:01 -07:00
m.push_rules Avoid duplicates. 2019-02-24 19:43:03 +03:00
m.receipt Add event as a parent for all event types 2016-03-16 16:46:16 +01:00
m.room.aliases Convert event schemas to yaml 2016-06-22 12:01:08 +01:00
m.room.avatar Make the key orders consistent 2016-11-07 14:54:59 +00:00
m.room.canonical_alias Make null m.room.name behaviour explicit 2016-07-12 13:44:04 +01:00
m.room.create Add room version upgrades 2019-01-09 17:02:09 -07:00
m.room.encrypted Remove unused algorithms for encrypted messages 2018-08-27 15:05:56 -06:00
m.room.encryption require megolm algorithm in m.room.encryption 2018-08-18 11:41:45 +02:00
m.room.guest_access Convert event schemas to yaml 2016-06-22 12:01:08 +01:00
m.room.history_visibility Convert event schemas to yaml 2016-06-22 12:01:08 +01:00
m.room.join_rules Convert event schemas to yaml 2016-06-22 12:01:08 +01:00
m.room.member Merge pull request #2067 from matrix-org/travis/1.0/stripped-state 2019-06-07 07:12:17 -06:00
m.room.message Convert event schemas to yaml 2016-06-22 12:01:08 +01:00
m.room.message$m.audio Remove the "required" designation from the url field of certain 2019-06-14 13:49:14 -07:00
m.room.message$m.emote Switch to using $ instead of # for sub-types 2019-05-29 15:28:48 -06:00
m.room.message$m.file Remove the "required" designation from the url field of certain 2019-06-14 13:49:14 -07:00
m.room.message$m.image Remove the "required" designation from the url field of certain 2019-06-14 13:49:14 -07:00
m.room.message$m.location Switch to using $ instead of # for sub-types 2019-05-29 15:28:48 -06:00
m.room.message$m.notice Add missing format fields to m.room.message$m.notice schema. 2019-06-12 16:36:58 -07:00
m.room.message$m.server_notice Switch to using $ instead of # for sub-types 2019-05-29 15:28:48 -06:00
m.room.message$m.text Switch to using $ instead of # for sub-types 2019-05-29 15:28:48 -06:00
m.room.message$m.video Remove the "required" designation from the url field of certain 2019-06-14 13:49:14 -07:00
m.room.message.feedback Convert event schemas to yaml 2016-06-22 12:01:08 +01:00
m.room.name Make null m.room.name behaviour explicit 2016-07-12 13:44:04 +01:00
m.room.pinned_events Add spec for m.room.pinned_events 2017-09-29 11:59:27 -06:00
m.room.power_levels Power levels always have a default of 50 for state_default 2018-09-04 11:43:37 -06:00
m.room.redaction Convert event schemas to yaml 2016-06-22 12:01:08 +01:00
m.room.server_acl Fix server ACL schema: The type is a string 2018-08-28 10:34:49 -06:00
m.room.third_party_invite Convert event schemas to yaml 2016-06-22 12:01:08 +01:00
m.room.tombstone Add room version upgrades 2019-01-09 17:02:09 -07:00
m.room.topic Convert event schemas to yaml 2016-06-22 12:01:08 +01:00
m.room_key complete m.room_key documentation 2018-08-18 11:41:45 +02:00
m.room_key_request fixup! document key sharing and m.room_key_request 2018-08-25 17:26:40 +02:00
m.sticker Sticker messages (m.sticker) (#1158) 2018-03-27 10:00:41 +01:00
m.tag Elaborate the structure of m.tag events 2018-08-29 14:47:59 -06:00
m.typing Add event as a parent for all event types 2016-03-16 16:46:16 +01:00
stripped_state.yaml Clarify exactly what StrippedState is 2019-06-02 17:41:39 -06:00