Commit Graph

202 Commits (40f7eab73f1a3055c3c4874b8d122f6b9c57e167)

Author SHA1 Message Date
Kegan Dougal e0fe3c42c8 Review comments 9 years ago
Kegan Dougal 6770d6b2d6 Review comments 9 years ago
Erik Johnston 716c5b7a8b Add 400 and 429 response codes 9 years ago
Kegan Dougal eca98af896 Swaggerify /register endpoint
Need to move registration/login/auth sections around once #94 lands.
9 years ago
Erik Johnston cfca4a6c09 s/creteria/criteria/ 9 years ago
Kegan Dougal f20faa80e5 Swagger validation 9 years ago
Kegan Dougal 55cc5c5bb5 Swaggerify application services 9 years ago
Kegan Dougal 5de63b4f45 Merge branch 'master' into proofing
Conflicts:
	specification/0-intro.rst
9 years ago
Kegan Dougal 1f2f14dc08 YAML tweaks 9 years ago
Kegan Dougal 84af5776d7 Newlines 9 years ago
Erik Johnston 2b9484cf48 Spell things correctly 9 years ago
Erik Johnston 392a1c5ad8 Another title 9 years ago
Erik Johnston ca9e44baac Moar titles 9 years ago
Erik Johnston a7a5cb088b Add titles 9 years ago
Erik Johnston e42c8b5b63 Add search API 9 years ago
Richard van der Hoff 4a9db39277 Clean up some untruths in the login api doc
add "type", and "username" -> "user"
9 years ago
Kegan Dougal 6f6861a11d Swaggerify the createRoom API 9 years ago
Kegan Dougal 41fb0645a9 Add message pagination API 9 years ago
Kegan Dougal 7bdb71b1c9 Tweak the syncing section
Bring together disparate sections to make it more cohesive.
9 years ago
Daniel Wagner-Hall 2502ca7ac6 Merge branch 'master' into daniel/threepidinvites-2
Conflicts:
	specification/targets.yaml
9 years ago
Kegsay 616f3990aa Merge pull request #87 from matrix-org/module-push
Push Module
9 years ago
Kegan Dougal 8f5c796884 Linkify 'pushers' 9 years ago
Mark Haines d42c3195e6 Use 'true' rather than '1' for archived flag 9 years ago
Mark Haines 241096dc81 Add a flag to initial sync to indicate we want rooms that the user has left 9 years ago
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.
9 years ago
Daniel Wagner-Hall dc3c02aff5 Review comments 9 years ago
Daniel Wagner-Hall 21a40b317d Merge branch 'master' into daniel/threepidinvites-2 9 years ago
Kegan Dougal 9c95ee5c1f Modify wording and formatting 9 years ago
Kegan Dougal befa23624e It's dangerous to go alone, take this. 9 years ago
Kegan Dougal 65504db7bb Display nested keys on arrays of objects. Make it valid swagger. 9 years ago
Kegan Dougal 31ae4b3859 Swaggerify push notification API
Edit units.py to support nested JSON request keys
9 years ago
Kegan Dougal a9618a981b Swaggerify the /enabled endpoint 9 years ago
Kegan Dougal 56ce432399 Get profile tag keys displaying correctly. 9 years ago
Kegan Dougal f6da9d7760 Give valid swagger. Split out rule/ruleset to separate definitions. 9 years ago
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.
9 years ago
Kegan Dougal 9540069acd Use valid JSON 9 years ago
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.
9 years ago
Mark Haines 034241eb20 Missing symlink for the v2 swagger APIs 9 years ago
Mark Haines 509d178d58 Fix the receipts API to be valid swagger 9 years ago
Mark Haines 4f606cf3a7 Add the fields required by the templating system to v2 sync 9 years ago
Mark Haines 5a5a6565ff Merge pull request #68 from matrix-org/markjh/v2_sync_api
Swagger documentation for the v2 sync API
9 years ago
Mark Haines 0ce533d153 Split the room_map into separate sections based on whether they are
"joined/invited/archived".

Rename the room_map to rooms and remove the grouping indirection. When we
want groups then we can add them under a separate key, either at the
top-level or as part of the events themselves.
9 years ago
Mark Haines 0e5b00feaa Fix event type in v2 sync example 9 years ago
Mark Haines bbb5fa9398 Fix the state_key in the example v2 response, include the "sender" key in the list of keys included with invite_state events 9 years ago
Mark Haines a7b808c5cd Add a invite_state key for holding the state that is bundled with an
invite. This is kept separate from the actual state for the room as
it may be derived from an incomplete, unverified copy of the state
that was bundled with an invite event received over federation.
9 years ago
Mark Haines ed0f6d3ff3 Typo 9 years ago
Mark Haines 97cdd8106c s|client/api/v2_alpha|/client/v2_alpha| 9 years ago
Mark Haines 047419f2ad Remove the room_id since it is redundent. Remove text about invite event handling till we've thought about it some more. 9 years ago
Mark Haines bde003fe86 Split the rooms out into a separate top level key.
Divide the rooms into separate groups in preparation for adding tag
support.

Further subdivide the rooms into "joined/invited/archived" based the
membership of the user in the room because that membership affects what
events the user can view from the room. E.g only users that are joined
to a room may see the ephemeral events for the room.
9 years ago
Kegsay ead79614ff Merge pull request #78 from matrix-org/module-typing2
Typing module
9 years ago
Mark Haines a73cc50aa9 s|client/api/v2_alpha|client/v2_alpha| 9 years ago
Kegan Dougal 09ac367847 Merge branch 'master' into module-content-repo
Conflicts:
	templating/matrix_templates/units.py
9 years ago
Kegan Dougal 3d9dbe42e6 Bump to swagger-parser 3.2.1 - remove x- keys on headers
Removed x- keys due to https://github.com/BigstickCarpet/swagger-parser/issues/23
9 years ago
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
9 years ago
Daniel Wagner-Hall d2c56fb7a3 Merge branch 'master' into daniel/threepidinvites-2 9 years ago
Kegan Dougal 8c4d7f5051 Do not try to parse non-json request examples as json 9 years ago
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.
9 years ago
Kegsay 8aad238cda Merge pull request #80 from matrix-org/module-receipts
Receipts module
9 years ago
Kegan Dougal da2be7eae4 Merge branch 'master' into module-voip
Conflicts:
	specification/modules/voip_events.rst
9 years ago
Kegan Dougal 1520f3647f Merge branch 'master' into module-typing2
Conflicts:
	specification/modules/typing_notifications.rst
9 years ago
Kegan Dougal c972dad8b3 Flesh out receipts module. Add receipts swagger
Add templating support for v2 apis.
9 years ago
Kegan Dougal e82661413e Add /turnServer endpoint 9 years ago
Erik Johnston abe5d08ac6 Merge pull request #64 from matrix-org/erikj/invite_state
Bundle some state into invites
9 years ago
Kegan Dougal 2b7e02c080 Add sections for typing. Add swagger, JSON schema and example m.typing event 9 years ago
Mark Haines 931057accf Add a top level presence key for the presence events and remove the public_user_data/private_user_data for now 9 years ago
Mark Haines 4cb3f78d2b Wrap the "rooms" list inside an object so that we can add keys for pagination later 9 years ago
Mark Haines 218cf94ead Replace the events array with events_map inside the room objects.
Only use indirection for the state and timeline events.
Use event_ids to reference the state and timeline events.
9 years ago
Erik Johnston 50e1b4c3a7 Fix up rst 9 years ago
Mark Haines 6ad6c40147 List the allowed values for the 'event_format' as an enum 9 years ago
Mark Haines 9dd3b07394 Allow '.' characters in event field names to be escaped with '\' so that
fields including a '.' can be included in a filter.

I considered replacing '.' with '/'. Since '/' was less likely to appear
in event field names. However if we used '\' to escape a literal '/' we
risk confusing it with the JSON escape '\/'.
9 years ago
Mark Haines 14b42a41d6 Document wildcard's in filters 9 years ago
Mark Haines c115b4c2f4 Document the valid values for the "set_presence" parameter 9 years ago
Mark Haines 940e22940d Document how the "not_foo" keys interact with the "foo" keys 9 years ago
Mark Haines 41bc09ea22 Split the event_filter into a event_filter and a room_event_filter that
extends it.

So that we don't include "rooms" and "not_rooms" keys for the public_user_data
and private_user_data filters.
9 years ago
Mark Haines 00fd4aac26 s/publically/publicly/ 9 years ago
Mark Haines 3204c2f2b6 Fix spelling 9 years ago
Mark Haines f50e6d4c0a Add x-example fields for v2 /sync 9 years ago
Mark Haines 1aa916d690 s/indicies/indices/ 9 years ago
Mark Haines 393d283139 Add a "limit" to the timeline key in the example filter 9 years ago
Erik Johnston 8c22b715ca Add title 9 years ago
Mark Haines c3b3b2df63 Add "set_presence" in the sync parameters 9 years ago
Mark Haines de07586ab7 Rename 'events' to 'timeline' in the sync filter 9 years ago
Mark Haines a0068e1ada Draft documention for the v2 sync api 9 years ago
Mark Haines e1f73f5233 Add a limit to filters 9 years ago
Erik Johnston 37ccddb308 Typo 9 years ago
Erik Johnston d7d9f406a6 Bundle some state into invites 9 years ago
Daniel Wagner-Hall cd6f15f627 Remove obsolete comment 9 years ago
Daniel Wagner-Hall 0c1eb50ef4 Merge pull request #26 from matrix-org/macaroons
Spec macaroons and token refresh
9 years ago
Daniel Wagner-Hall 6c1491b3ba Respond to some review comments 9 years ago
Daniel Wagner-Hall 5c4398c181 Remove superfluous comma 9 years ago
Daniel Wagner-Hall fc87f4cdb0 Remove unused keys 9 years ago
Daniel Wagner-Hall 6c89e6ea67 Wrap refresh_token in `s 9 years ago
Mark Haines f34722485f Check the request example JSON matches the schema 9 years ago
Mark Haines a31a446661 Fix the POST example for the v2 filter API 9 years ago
Mark Haines 69298b9612 Check "v2_alpha" in jenkins 9 years ago
Mark Haines 883105eae6 Document the v2 filter GET API 9 years ago
Mark Haines 2f039a1142 Add swagger docs for the v2 filter POST API 9 years ago
Mark Haines 385b6c4759 Only validate a file if it ends with ".yaml".
Otherwise we try to validate vim .swp files.
9 years ago
Mark Haines 98d91d0c2b Make the example room id more "random" so that people are less likely to think that it is supposed to be human readable 9 years ago
Mark Haines f60190086a Describe the behaviour of /rooms/{roomId}/member when the user has left the room 9 years ago