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

big reshuffle: #13

Merged
merged 5 commits into from
Mar 23, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1,148 changes: 574 additions & 574 deletions drafts/as-http-api.rst

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions drafts/definitions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Definitions

# *Event* -- A JSON object that represents a piece of information to be
distributed to the the room. The object includes a payload and metadata,
including a `type` used to indicate what the payload is for and how to process
including a ``type`` used to indicate what the payload is for and how to process
them. It also includes one or more references to previous events.

# *Event graph* -- Events and their references to previous events form a
directed acyclic graph. All events must be a descendant of the first event in a
room, except for a few special circumstances.

# *State event* -- A state event is an event that has a non-null string valued
`state_key` field. It may also include a `prev_state` key referencing exactly
`state_key` field. It may also include a ``prev_state`` key referencing exactly
one state event with the same type and state key, in the same event graph.

# *State tree* -- A state tree is a tree formed by a collection of state events
Expand Down
5 changes: 4 additions & 1 deletion drafts/erik-model.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
This is a standalone description of the data architecture of Synapse. There is a lot of overlap with the currennt specification, so it has been split out here for posterity. Hopefully all the important bits have been merged into the relevant places in the main spec.
This is a standalone description of the data architecture of Synapse. There is a
lot of overlap with the current specification, so it has been split out here for
posterity. Hopefully all the important bits have been merged into the relevant
places in the main spec.


Model
Expand Down
7 changes: 6 additions & 1 deletion drafts/general_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -555,7 +555,7 @@ signature. Requesting the "raw" federation event will have to return these keys.

Account Management API ``[Draft]``
----------------------------------
The registration and login APIs in v2 do not support specifying device IDs. In v2,
The registration and login APIs in v1 do not support specifying device IDs. In v2,
this will become *mandatory* when sending your initial request. Access tokens will
be scoped per device, so using the same device ID twice when logging in will
clobber the old access token.
Expand Down Expand Up @@ -810,6 +810,11 @@ Notes:

Presence API ``[Draft]``
------------------------

.. FIXME
this seems to be ignoring activity timers entirely, which were present on
the planning etherpad and are present in the actual HTTP API. Needs attention.

The goals of presence are to:

- Let other users know if someone is "online".
Expand Down
77 changes: 0 additions & 77 deletions drafts/media_repository.rst

This file was deleted.

5 changes: 2 additions & 3 deletions drafts/object_model.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@



..TODO
What are the start & end tokens doing here?!

::

Expand Down
1 change: 1 addition & 0 deletions scripts/gendoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ def prepare_env():
pass

def cleanup_env():
#pass
shutil.rmtree("./tmp")

def main():
Expand Down