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 distinction between *m.key.verification.start* and its *m.sas.v1* variant. #2132

Merged
merged 4 commits into from Jun 19, 2019
Merged

Clarify the distinction between *m.key.verification.start* and its *m.sas.v1* variant. #2132

merged 4 commits into from Jun 19, 2019

Commits on Jun 14, 2019

  1. 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>
    jimmycuadra committed Jun 14, 2019
    Copy the full SHA
    bc71dac View commit details
    Browse the repository at this point in the history

Commits on Jun 15, 2019

  1. Fix style issues brought up during code review.

    Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
    jimmycuadra committed Jun 15, 2019
    Copy the full SHA
    5384b61 View commit details
    Browse the repository at this point in the history
  2. Address feedback from code review.

    * Switch "an SAS" back to "a SAS"
    * Remove the `next_method` field from m.key.verification.start$m.sas.v1
      but add additional clarification to its description on
      m.key.verification.start that it is never present for methods that
      verify keys both ways.
    jimmycuadra committed Jun 15, 2019
    Copy the full SHA
    8affb23 View commit details
    Browse the repository at this point in the history

Commits on Jun 18, 2019

  1. Copy the full SHA
    8246383 View commit details
    Browse the repository at this point in the history