0
0
Fork 0
Commit Graph

392 Commits

Author SHA1 Message Date
Richard van der Hoff ccd7bb32d5 Specification for direct-to-device messages 2016-09-27 14:27:27 +01:00
David Baker 9a1db01d92 Clarify `highlight` and `sound` tweaks. 2016-09-08 11:59:49 +01:00
David Baker fd888fcbda Merge pull request #373 from matrix-org/dbkr/contains_display_name_override
Make the display name rule an override rule
2016-08-17 09:43:44 +01:00
David Baker b65b0d049e Make the display name rule an override rule 2016-08-15 18:32:35 +01:00
David Baker 6592646ee9 Add dot prefix to .rule.master
It's a default rule, so it needs a dot
2016-08-15 18:29:39 +01:00
Richard van der Hoff 1f1dfdd91c More clarifications 2016-08-09 15:51:12 +01:00
Richard van der Hoff ec81b4c9fe More PR feedback
Add a couple of TODO sections
2016-08-09 12:16:20 +01:00
Richard van der Hoff 4b0e546eeb PR feedback
Fix some typos, and clarify several aspects of server behaviour.
2016-08-09 12:02:38 +01:00
Richard van der Hoff 41368dc5a7 document CAS login
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
2016-08-08 17:33:48 +01:00
Richard van der Hoff 49cd65dd58 Add a license to the spec
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
2016-07-12 17:28:30 +01:00
Richard van der Hoff 885e6797f2 Fix double-negative in room naming 2016-07-12 14:50:49 +01:00
Richard van der Hoff 7b4c21fa77 Add link to room name bug 2016-07-12 11:47:39 +01:00
Richard van der Hoff d4194dd24e Clarify the room-naming behaviour
Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events
explicit.
2016-07-11 17:49:27 +01:00
Richard van der Hoff df3f4b4ecf Fix link to draft e2e spec 2016-06-30 18:01:32 +01:00
Mark Haines af091ff614 Document changes to the default push rules 2016-06-22 16:34:23 +01:00
Mark Haines 30a3302921 Merge pull request #274 from matrix-org/markjh/default_rules
Update the predefined push rules in the spec
2016-06-22 16:14:21 +01:00
Erik Johnston e80e32173f Merge pull request #278 from matrix-org/erikj/presence
Update presence spec.
2016-06-22 14:08:44 +01:00
Richard van der Hoff b59d16c4d1 Clarify `history_visibility` behaviour
Clear up some lies in the history_visibility section, and clarify behaviour for
`m.room.history_visibility` and the user's own `m.room.member` events.
2016-04-06 17:55:01 +01:00
Kegsay 506accee27 Merge pull request #288 from matrix-org/markjh/pushrule_stream
Add a snippet of documentation for a m.push_rules event.
2016-03-10 14:05:42 +00:00
Daniel Wagner-Hall f4f186baee Add _cs suffix to client-server http APIs
I'm about to add identity service APIs, so differentiating is good.
2016-03-08 17:42:41 +00:00
Mark Haines c3c95d0c09 Fix grammar and add backticks for /sync 2016-03-08 10:17:27 +00:00
Mark Haines 5407cc8e05 Add a snippet of documentation for a m.push_rules event. 2016-03-04 14:41:30 +00:00
Erik Johnston 3d4d91a462 Reword to make sense 2016-03-01 16:15:59 +00:00
Erik Johnston 167a08a805 Allow idle timeout to be configurable 2016-03-01 16:13:41 +00:00
Erik Johnston bc68177471 Grammar 2016-03-01 16:07:25 +00:00
Erik Johnston f1a8306d08 Spec currently_active time and idle timeout behaviour 2016-02-23 11:25:47 +00:00
Richard van der Hoff 68a4306773 Split room previews into a separate module
Guest access and room peeking are orthogonal
2016-02-19 15:26:28 +00:00
Mark Haines 740f775932 Fix a couple of typos, remove .m.rule.member_event 2016-02-18 18:36:08 +00:00
Mark Haines 3db6980e0b Remove references to device specific push rules
Since they weren't implemented on the servers and weren't
used by the clients.
2016-02-18 16:05:47 +00:00
Mark Haines 5d85e3a505 Remove indents 2016-02-15 16:53:08 +00:00
Mark Haines b16af5ef64 Fix JSON, add headers 2016-02-15 16:41:47 +00:00
Mark Haines 8a1a02a11b Update the predefined push rules in the spec 2016-02-15 16:28:43 +00:00
Matthew Hodgson 6925547875 remove the oversimplification that the WebRTC standard is based around two-oparty communication 2016-02-11 18:34:28 +00:00
Richard van der Hoff b2e0a855cc Add 'event' to event context API
also link through to the event schemas
2016-02-01 17:45:45 +00:00
Richard van der Hoff cff1b4ae35 Merge pull request #251 from matrix-org/daniel/guestshiz
Clarify guest /events and /sync
2016-01-08 00:47:57 +00:00
Daniel Wagner-Hall 3edff684a1 Merge pull request #253 from matrix-org/daniel/guestupgrade
Guests can upgrade to regular accounts
2016-01-07 16:39:35 +00:00
Daniel Wagner-Hall 7d9547274c Clarify guest /events and /sync 2016-01-07 11:59:38 +00:00
Daniel Wagner-Hall 713415015b Remove mention that /sync takes an inline filter 2016-01-06 15:51:07 +00:00
Daniel Wagner-Hall d3f05ae49a Guests can upgrade to regular accounts 2016-01-05 17:30:55 +00:00
Daniel Wagner-Hall ca67aa7b4f Tidy up guest access spec
* Mention that /leave is allowed
* Mention that /sync is allowed
* Re-order such that the whole list of APIs fits on one screen
2016-01-05 13:45:04 +00:00
Richard van der Hoff e4dd346a81 Restore 'client behaviour' section
Because it's the standard
2015-12-17 14:07:35 +00:00
Richard van der Hoff b7c255a887 Tweaks/clarifications to search spec
Fixes https://matrix.org/jira/browse/SPEC-305
2015-12-17 13:40:22 +00:00
Matthew Hodgson f8f76794a3 fix random whitespace bug 2015-12-14 08:40:41 +00:00
Daniel Wagner-Hall a484f04b33 Merge pull request #221 from matrix-org/daniel/pushaway
Merge pull request #221 from matrix-org/daniel/pushaway
2015-12-09 14:04:02 +00:00
Erik Johnston c96848d1bc Merge pull request #169 from matrix-org/erikj/search_yet_agian
Search: Document event context, groups and orders.
2015-12-08 16:11:03 +00:00
Daniel Wagner-Hall a2283f5499 Remove /notify from client-server API 2015-12-08 13:25:31 +00:00
Erik Johnston dd276d4c4d Add event context module 2015-12-07 16:56:03 +00:00
Erik Johnston 856dd9100e Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian 2015-12-07 16:28:14 +00:00
Erik Johnston 2aef684e7e Add list of required supported groupings 2015-12-07 16:02:22 +00:00
Erik Johnston c61ae86102 Specify behaviour if server does not support pagination 2015-12-07 16:00:15 +00:00
Richard van der Hoff 3939ccf20c Remove e2e drafts from master
This is now being tracked in the main spec, on the drafts/e2e branch.
2015-12-07 14:45:46 +00:00
Daniel Wagner-Hall 873b0dcecf Replace version numbers with release numbers 2015-12-04 11:09:35 +00:00
Daniel Wagner-Hall f308b7543c Specify /admin/whois/{userId} 2015-12-03 16:26:45 +00:00
Daniel Wagner-Hall 4baba85fe5 Draftify e2e in anticipation of a spec release 2015-12-03 11:52:11 +00:00
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 2015-12-02 19:23:33 +00:00
Matthew Hodgson b946d39886 typo 2015-12-02 01:25:07 +00:00
Daniel Wagner-Hall f6229f649a Remove confusing wording 2015-12-01 16:58:40 +00:00
Erik Johnston 23b2497743 Expand on where pagination tokens can be returned 2015-12-01 15:31:35 +00:00
Erik Johnston 46fd0b252c Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian 2015-12-01 15:06:13 +00:00
Daniel Wagner-Hall 6c66bfc755 Flatten out v1 and v2_alpha directories
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
2015-11-30 11:22:57 +00:00
Daniel Wagner-Hall e401d3e262 Merge pull request #184 from matrix-org/daniel/splitspec
Split spec into page-per-section
2015-11-27 16:46:06 +00:00
Daniel Wagner-Hall e171acf01f Split spec into page-per-section 2015-11-27 16:45:47 +00:00
Mark Haines a20a49abf6 Merge pull request #168 from matrix-org/markjh/client_config
Add API for setting client config
2015-11-27 15:32:21 +00:00
Mark Haines c5f457cee9 Merge pull request #132 from matrix-org/markjh/room_tags
Document a v2 api for setting tags on rooms
2015-11-27 15:31:54 +00:00
Richard van der Hoff 0b1ba70a32 fix rst markup
`` > `
2015-11-27 13:33:58 +00:00
Richard van der Hoff 2dbb8ba56c Fix title levels
make the title decoration consistent with the rest of the spec
2015-11-27 12:53:03 +00:00
Richard van der Hoff 51ca25a472 Merge branch 'master' into markjh/end_to_end_encryption 2015-11-27 11:49:11 +00:00
Richard van der Hoff 5f4458b2ff Merge branch 'master' into markjh/end_to_end_encryption 2015-11-27 11:45:49 +00:00
Daniel Wagner-Hall 5e30b5b8d7 Remove POST version of /send
PUT should always be used.
2015-11-26 16:46:29 +00:00
Mark Haines 032ee75537 Update specification wording to match s/config/account_data/ 2015-11-19 10:42:22 +00:00
Mark Haines 05c0092664 s/config/account_data/ 2015-11-19 10:38:22 +00:00
Mark Haines 40f7eab73f s/private_user_data/account_data/ 2015-11-18 15:44:18 +00:00
Mark Haines 24c4b8b095 Merge branch 'markjh/room_tags' into markjh/client_config
Conflicts:
	api/client-server/v1/rooms.yaml
	api/client-server/v1/sync.yaml
	api/client-server/v2_alpha/sync.yaml
	specification/targets.yaml
2015-11-18 15:30:16 +00:00
Mark Haines fcbb985073 s/private_user_data/account_data/ 2015-11-18 15:27:26 +00:00
Erik Johnston 373c6c8270 Add ordering, pagination and grouping comments 2015-11-17 11:56:05 +00:00
Mark Haines c77b22778f Add some documentation on names of tags 2015-11-16 17:48:41 +00:00
Mark Haines 25769493b1 Fix template 2015-11-16 17:14:41 +00:00
Mark Haines e7fbe6f13b Limit the size of a tag 2015-11-16 17:13:02 +00:00
Mark Haines 48f35e15cb describe how to order rooms that don't have an order in their tags 2015-11-16 17:08:59 +00:00
Mark Haines 299af673da Specify how ordering of tags is supposed to work 2015-11-16 17:04:19 +00:00
Mark Haines 3b390bff3c Merge branch 'master' into markjh/room_tags
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
2015-11-16 16:56:35 +00:00
Mark Haines 8f5783615c Merge branch 'master' into markjh/client_config
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
2015-11-16 16:51:45 +00:00
Mark Haines c3769ef75c Add a module for client config to the specification 2015-11-16 16:49:32 +00:00
Daniel Wagner-Hall ea364a108b Merge pull request #161 from matrix-org/daniel/guestdisplaynames
Merge pull request #161 from matrix-org/daniel/guestdisplaynames

Guests are allowed to set displaynames
2015-11-12 13:23:49 +00:00
Daniel Wagner-Hall 29d9c8eec6 Guests are allowed to set displaynames 2015-11-12 12:05:02 +00:00
Daniel Wagner-Hall 061105c9dc Guest users are allowed room initialSync 2015-11-11 17:18:58 +00:00
Daniel Wagner-Hall 24c2036a35 3pid invites: remove mentions of display_name 2015-11-09 17:30:18 +00:00
Daniel Wagner-Hall e72151f2c3 Specify guest room access
This was reviewed as PR #150 and merged from daniel/anonymousaccess
2015-11-06 18:15:21 +00:00
Daniel Wagner-Hall 161441fa3a Update 3pid spec based on new implementation 2015-11-05 18:11:20 +00:00
Richard van der Hoff 8cba11b1cd Add some links to spec bugs for display names
Just added a couple of TODO comments to useful jira bugs
2015-11-05 11:06:31 +00:00
Richard van der Hoff 2fd5fc39a0 Add spec for calculating display names for rooms and users
Merged from https://github.com/matrix-org/matrix-doc/pull/145
2015-11-05 10:55:11 +00:00
Mark Haines 3953006792 Fix spelling 2015-11-03 15:54:33 +00:00
Mark Haines 149890227a Fix wording 2015-11-02 13:35:11 +00:00
Mark Haines 52f55e0542 Allow room tags to have asssociated content, and return that content in the m.tag events 2015-11-02 13:31:25 +00:00
Mark Haines f557e69860 Note that m.tag events can appear in v1 initialSync and /events as well as v2 sync. Only add the room_id for v1 /events since it is redundant in v1 /initialSync 2015-11-02 10:13:47 +00:00
Mark Haines 65066a76b3 Add the m.tags event to a ``private_user_data`` key rather than including it under the ``ephemeral`` key 2015-10-26 18:30:04 +00:00
Mark Haines 9b0d20315a Add the tags module to the specification targets 2015-10-26 16:22:04 +00:00
Mark Haines 12e33a3b09 Document a v2 api for setting tags on rooms 2015-10-26 16:14:24 +00:00
Daniel Wagner-Hall 7c250f91ff Merge pull request #127 from matrix-org/daniel/exposedrooms
Allow history to be noted as world-readable
2015-10-26 10:30:32 +00:00
Kegsay 4823a133cd Merge pull request #124 from matrix-org/clarify_scale_crop
Clarify 'scale' & 'crop' resize methods
2015-10-26 09:57:32 +00:00
Daniel Wagner-Hall 67880686d5 Allow history to be noted as world-readable
SPEC-237
2015-10-23 14:02:53 +01:00
David Baker 01064369a4 Add some clarification on the difference between 'scale' and 'crop' resize methods 2015-10-23 11:57:15 +01:00
Mark Haines e3e8026025 Fix list formatting so that we aren't including everything in blockquotes 2015-10-23 10:51:31 +01:00
Erik Johnston f0c74a9c83 Merge pull request #96 from matrix-org/erikj/search_actual
Add search API
2015-10-23 10:19:36 +01:00
Erik Johnston 4a558ad63b Typo 2015-10-23 10:19:25 +01:00
Daniel Wagner-Hall a9a9067d7e Merge pull request #114 from matrix-org/daniel/3pidtosigned
Update 3pid invite section to reflect signed property
2015-10-19 15:52:50 +01:00
Erik Johnston 1d01f69c3c Merge remote-tracking branch 'origin/master' into erikj/search_actual 2015-10-19 13:46:58 +01:00
Erik Johnston 111ca99519 Clarify that this doesn't include events that occurred after you left the room. 2015-10-19 13:46:30 +01:00
Kegan Dougal ae90d15b3c Add m.room.avatar 2015-10-19 10:46:07 +01:00
Daniel Wagner-Hall c70067dd1e Simplify language 2015-10-19 10:44:26 +01:00
Daniel Wagner-Hall 6161a920b6 Update 3pid invite section to reflect signed property 2015-10-16 18:29:20 +01:00
Erik Johnston eb59b8e9d1 Mention count 2015-10-16 10:16:40 +01:00
Erik Johnston a6cb2e4339 Mention rank 2015-10-15 16:40:21 +01:00
Erik Johnston 24e36adbe3 Mention e2e encryption 2015-10-15 16:09:11 +01:00
Erik Johnston 770cfbc5de Be explicit about the events the search is performed over 2015-10-15 16:08:24 +01:00
Erik Johnston 906c59385f s/had/has/ 2015-10-15 15:49:58 +01:00
Erik Johnston c47a94658a Mention supported keys 2015-10-15 11:12:00 +01:00
Erik Johnston af347baa68 Better phrasing 2015-10-15 11:06:15 +01:00
Erik Johnston 96a4996c76 Mention search categories 2015-10-15 11:02:37 +01:00
Kegsay 3a2c8cd4b3 Merge pull request #91 from matrix-org/module-history-vis
History visibility module
2015-10-15 11:02:24 +01:00
Kegan Dougal 5aad67f74d Review comments round III 2015-10-15 11:01:11 +01:00
Kegsay c5dc383668 Merge pull request #85 from matrix-org/module-im
Instant messaging module
2015-10-15 10:59:41 +01:00
Kegan Dougal 507cb29e39 Review comments round deux 2015-10-15 10:37:15 +01:00
Kegan Dougal f51ee70633 Review comments round 2 2015-10-15 10:19:51 +01:00
Kegsay 1229ad24dd Merge pull request #103 from matrix-org/spec-165-mxc-security
SPEC-165: Outline directory traversal attacks on MXC URIs
2015-10-14 17:48:59 +01:00
Erik Johnston 728b5a7951 Add very short summary 2015-10-14 17:20:00 +01:00
Erik Johnston 007bb1a69a Add extra new line 2015-10-14 16:26:14 +01:00
Erik Johnston d8bc0c9315 Add search module 2015-10-14 16:13:43 +01:00
Kegan Dougal 44b19a8b0e SPEC-165: Outline directory traversal attacks on MXC URIs 2015-10-14 15:27:56 +01:00
Kegan Dougal 3608f3a282 SPEC-144 : Use https examples not http. 2015-10-14 14:44:09 +01:00
Kegan Dougal 4170dbd5cf Review comments 2015-10-13 11:29:54 +01:00
Kegan Dougal 173d00cea0 Review comments 2015-10-13 11:08:19 +01:00
Daniel Wagner-Hall 2502ca7ac6 Merge branch 'master' into daniel/threepidinvites-2
Conflicts:
	specification/targets.yaml
2015-10-12 18:11:01 +01:00
Daniel Wagner-Hall 4a1fb74897 Review comments 2015-10-12 18:08:51 +01:00
Kegan Dougal 8f5c796884 Linkify 'pushers' 2015-10-12 17:50:46 +01:00
Kegan Dougal e378de8379 Shuffle history visibility module to be in the module format 2015-10-09 11:04:11 +01:00
Kegan Dougal f2a6950cc3 Minor tweaks; allow objects without props/parents if a title is set
This allows us to do things like {Tweaks} where Tweaks is defined somewhere
else.
2015-10-08 16:21:26 +01:00
Daniel Wagner-Hall dc3c02aff5 Review comments 2015-10-08 10:08:38 -05:00
Daniel Wagner-Hall 21a40b317d Merge branch 'master' into daniel/threepidinvites-2 2015-10-08 09:41:17 -05:00
Kegan Dougal 9c95ee5c1f Modify wording and formatting 2015-10-08 15:36:03 +01:00
Kegan Dougal 31ae4b3859 Swaggerify push notification API
Edit units.py to support nested JSON request keys
2015-10-08 13:08:21 +01:00
Kegan Dougal a9618a981b Swaggerify the /enabled endpoint 2015-10-08 11:16:42 +01:00
Kegan Dougal 56ce432399 Get profile tag keys displaying correctly. 2015-10-08 10:14:05 +01:00
Kegan Dougal db25276856 Start adding in push definitions
This is going to be painful to represent due to how the push API allows
mixed types (strings or objects) and mixed top-level keys ("content" rule kind
allowing "pattern" as a top-level key). We may wish to re-visit the design
of this API for v2.
2015-10-07 17:44:05 +01:00
Kegan Dougal c5edc60c4c Add push YAML for pushers endpoint.
Also display "required" text on required JSON body request params. Also
increase the size of the request param column to support longer param names
present in the pushers API.
2015-10-07 16:01:36 +01:00
Kegan Dougal d3ed517ebf Finish laying out rough sections 2015-10-07 14:14:15 +01:00
Kegan Dougal a7400508c6 Define module titles from the template 2015-10-07 14:07:36 +01:00
Kegan Dougal 319ba8f404 Combine push files into one
We can fork it out again if it makes sense, but certainly 2/3 of the files
were very small and it just adds more complexity when refactoring.
2015-10-07 14:00:16 +01:00
Kegan Dougal 91ca36509b Flesh out IM module 2015-10-07 11:51:49 +01:00
Kegan Dougal 8e5c832ff9 Flesh out more of the IM module 2015-10-05 13:45:23 +01:00
Kegan Dougal 47cf958b54 Merge branch 'master' into module-im 2015-10-05 10:16:44 +01:00
Kegsay 8c092e3d11 Merge pull request #74 from matrix-org/module-presence
Presence module
2015-10-02 16:24:53 +01:00
Kegan Dougal 417c5b53c4 Remove duplicate sentences from merge conflicts 2015-10-02 16:24:33 +01:00
Daniel Wagner-Hall b29fdebec2 Give example of verification dance 2015-10-02 09:14:31 -05:00
Kegan Dougal 458383585f Stub sections 2015-10-02 15:03:55 +01:00
Kegsay ead79614ff Merge pull request #78 from matrix-org/module-typing2
Typing module
2015-10-02 14:36:30 +01:00
Daniel Wagner-Hall 9d8dc7971d Review comments 2015-10-02 08:33:12 -05:00
Kegan Dougal 09ac367847 Merge branch 'master' into module-content-repo
Conflicts:
	templating/matrix_templates/units.py
2015-10-02 10:46:46 +01:00
Kegan Dougal 4dabcd112e Remove redundant info now we have the http api template. Minor tweaks to display of schema with no names but a type 2015-10-02 10:44:50 +01:00
Daniel Wagner-Hall af7d2ca9fc Update 3pid invite spec
This takes into account:
 1) That finding the existing servers of a room is hard
 2) Federation
2015-10-01 22:19:11 -05:00
Kegan Dougal 87b6dd845e Flesh out content repo; modify templating to support headers
Edit content-repo.yaml to include examples and headers.
Restructure content module to conform to the module template.
Adjust the HTTP API template to give 1 more char to the response
param to fit "Content-Disposition" correctly.
Edit the templating system to support displaying enums for
swagger APIs (before it was just JSON schema). Also add support
for introspecting headers from swagger. Finally, replace - with
_ when forming the {{ template_var }} else things whine.
2015-10-01 17:55:16 +01:00
Kegsay 8aad238cda Merge pull request #80 from matrix-org/module-receipts
Receipts module
2015-10-01 17:33:38 +01:00
Kegan Dougal da2be7eae4 Merge branch 'master' into module-voip
Conflicts:
	specification/modules/voip_events.rst
2015-10-01 15:48:42 +01:00
Kegan Dougal 1520f3647f Merge branch 'master' into module-typing2
Conflicts:
	specification/modules/typing_notifications.rst
2015-10-01 15:47:46 +01:00
Kegan Dougal cc6f256b24 Merge branch 'master' into module-presence
Conflicts:
	specification/modules/presence.rst
2015-10-01 15:46:52 +01:00
Kegan Dougal 6000887201 Merge branch 'master' into module-receipts
Conflicts:
	specification/modules/receipts.rst
2015-10-01 15:44:53 +01:00
Kegan Dougal c972dad8b3 Flesh out receipts module. Add receipts swagger
Add templating support for v2 apis.
2015-10-01 15:41:54 +01:00
Kegsay 4a7a682c0f Merge pull request #65 from matrix-org/spec-feature-profiles
Spec feature profiles
2015-10-01 12:16:30 +01:00
Kegan Dougal 365a9076b9 Add nested dict template support; Add x-pattern
For cases where event schema specify `patternProperties` it would be nice
to give that pattern a "human-readable" form rather than a raw regex. This
is now supported by specifying `x-pattern` in the value part of the specified
pattern e.g. `patternProperties:{ "^.*":{ x-pattern: "$THING", ... } }`

Templating had limited record type descriptions limited to value primitives
e.g. `{string: integer}`. It now supports inspecting the values recursively
if the value is `object`.

Updated `m.receipt` to take both these points into account to make it read
better. Tweak receipt module text.
2015-10-01 12:11:26 +01:00
Kegan Dougal 3b73b07bab Clarifications that room invites are m.call.invites not actual invites 2015-10-01 11:11:08 +01:00
Kegan Dougal e82661413e Add /turnServer endpoint 2015-10-01 11:04:42 +01:00
Kegan Dougal 6c3e70d272 Start fleshing out voip module 2015-09-30 17:32:44 +01:00
Kegan Dougal 097dc50180 Minor tweaks 2015-09-30 15:51:20 +01:00
Kegan Dougal a82f2ad4ac Flesh out typing module 2015-09-30 15:51:12 +01:00
Kegan Dougal 2b7e02c080 Add sections for typing. Add swagger, JSON schema and example m.typing event 2015-09-30 15:51:04 +01:00
Kegan Dougal 52f6496cf0 Merge branch 'master' into module-presence 2015-09-30 10:56:17 +01:00
Kegan Dougal 4e1e82f995 Fix paragraph CSS and adjust where paragraphs are in the RST
The CSS for `nature.css` was such that it was preventing `p` tags from
having sufficient vertical whitespace. This meant that you couldn't insert
any kind of spacing between lengthy sections (they just appeared as new lines).

This PR fixes this so you can actually have some whitespace between paragraphs.
As a result of this change, some parts of the spec appeared to have too much
whitespace. These were often sections which shouldn't have begun a new
paragraph anyway (e.g. a single sentence being an entire paragraph, `TODO`
blocks resulting in new paragraphs). This PR fixes the most offending areas
where we shouldn't have been inserting new paragraphs.
2015-09-30 10:43:02 +01:00
Kegan Dougal 069e4e39f4 Move presence specific sections from intro to presence module 2015-09-30 10:22:51 +01:00
Kegan Dougal 0a04672d76 Start converting the presence module. Add Rationale admonition. 2015-09-29 17:57:44 +01:00
Kegan Dougal cdf9f011e9 Add room history visibility as a module. 2015-09-29 16:33:34 +01:00
Kegan Dougal 5abea1f2bc Minor tweaks 2015-09-28 14:07:34 +01:00
Kegan Dougal 70518ae655 Clarify template suffixes 2015-09-28 14:03:54 +01:00
Kegan Dougal 643468e914 Mention swagger. Clarify how event type template vars are formed. 2015-09-28 14:01:54 +01:00
Kegan Dougal c2fc1a2fb1 Add basic module template.
This has the core sections for events/server/client/security.
2015-09-28 13:41:31 +01:00
Kegan Dougal c6375ed3d1 Flesh out feature profiles section
Add table detailing the profiles. Add anchors to link through to each module
following a well-defined format (rather than the name of the module section).
Allow UTF-8 in the spec.
2015-09-25 15:09:15 +01:00
Kegan Dougal 5115346297 Add instant_messaging module; modify batesian section rules
Previously, all `m.room.*` events were wodged into `{{room_events}}` which
isn't great when you want to pull specific ones out. Batesian had a 1:1
mapping of `render_foo()` to a section `{{foo}}`, and having to constantly
add functions for new types is a PITA. Batesian now supports returning a
`dict` instead of a section `string` where the keys are the `{{foo}}` and
the value is what will be inserted. Also add conflicting section key checks
to avoid multiple definitions of the same `{{foo}}`. Define dicts for
event schemata and swagger HTTP APIs.

Using this new feature, split out the instant messaging stuff from the events
section, and replace `{{room_events}}` with a list of specific events e.g.
`{{m_room_member_event}}`.
2015-09-23 10:48:49 +01:00
Kegan Dougal 5b134119bd Add presence module; fix relative title bug
If a relative title appeared after an HTTP API table, it
would insert the wrong level because it thought that part
of the table was a title.
2015-09-23 09:59:54 +01:00
Kegan Dougal 0c0ac3e814 Fix common event fields template to use subtitle char 2015-09-22 14:07:23 +01:00
Kegan Dougal e8cdfcbba2 Rename spec files to not have numbers everywhere; update targets.yaml 2015-09-22 14:01:55 +01:00
Kegan Dougal f71763b0d3 Implement relative title styles
Templates don't know at what level they will be inserted. Previously, we
hard-coded the title style which is not compatible with the build target
system. Define a set of styles which will be replaced by the gendoc script
when it encounters them:
 '<' : Make this title a sub-heading
 '/' : Make this title a heading at the same level
 '>' : Make this title a super-heading

The build target system is now basically complete and functioning.
2015-09-22 13:08:15 +01:00
Kegan Dougal 067363c629 Get the desired title levels right; print out the actual level used to stdout 2015-09-21 17:21:08 +01:00
Kegan Dougal f520ac9d82 Create a modules folder to group together similar parts of the spec 2015-09-21 14:25:52 +01:00