Commit Graph

549 Commits (7a82a5d4279f47560258b389433c7835bb919b67)

Author SHA1 Message Date
Richard van der Hoff 1fe00b1517 Reinstate validator.js
It turns out that validator.js is used by the jenkins build script to, uh,
validate the docs.

This partially reverts commit affb106014.
9 years ago
Richard van der Hoff 23c4ffbc1b Add securityDefintions to generated swagger JSON
Also factor out to a common file
9 years ago
Richard van der Hoff cf87120d78 Fixes to the API docs
* fix security data for DELETE /user/{userId}/rooms/{roomId}/tags/{tag}

* fix definition for body of PUT /pushrules/{scope}/{kind}/{ruleId}/actions
9 years ago
Richard van der Hoff affb106014 Remove redundant scripts under api/
We now use newer swagger, via scripts/dump-swagger.py
9 years ago
David Baker 1a856b53f3 Remove redundant info & add backticks 9 years ago
David Baker 4b294b23de Tailor descriptions to GET method 9 years ago
David Baker 4fafe1ab73 Return an object as the root element
Because otherwise it's impossible to change later
9 years ago
David Baker 42834340e7 Add title to the pushers array 9 years ago
David Baker 0f6e414eb6 Fix format (array of objects, not object) 9 years ago
David Baker 27113d71ff Fix indentation 9 years ago
David Baker 73d6e901ae Add endpoint for getting a user's pushers
Also add profile_tag to the set docs as it was missing
9 years ago
Will Hunt c9ed063a36 Small copy paste error
'avatar url' should be 'profile information'
9 years ago
David Baker 1d6c405f62 Fix presumably c+p fail 9 years ago
David Baker cf850b4270 Fix level of `counts` and `devices`
They are actually within the notification object rather than the top level object. Add titles to objects so it works.
9 years ago
David Baker 89453bfd8c Remove spurious blank line 9 years ago
David Baker 64c6d30f90 hopefully fix rst 9 years ago
David Baker 7faf2cf642 Paragraph breaks & missed word 9 years ago
David Baker 7e1cb9003c Make swagger valid 9 years ago
David Baker 71cb646541 Change `id` in the push gateway poke to be `event_id` and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec. 9 years ago
David Baker 39fe9e3896 Merge pull request #284 from matrix-org/dbkr/notification_counts
Add notification counts to doc
9 years ago
Daniel Wagner-Hall fecff8afdc Specify association lookup 9 years ago
Daniel Wagner-Hall e0c55eeccf Add initial identity server spec
More to come
9 years ago
Daniel Wagner-Hall 11c572267e Add titles where they're missing 9 years ago
David Baker a78dff3981 Add notification counts to doc 9 years ago
Mark Haines d2c05d64c7 Document an API for setting and getting the actions for a push rule 9 years ago
Mark Haines 254fbe7983 Document GET for /pushrules/{scope}/{kind}/{ruleId}/enabled 9 years ago
David Baker e6143a6596 Merge pull request #281 from matrix-org/dbkr/fix_meta_escaping
Fix meta-escaping fail
9 years ago
David Baker 2c5392f1d1 Fix meta-escaping fail 9 years ago
Daniel Wagner-Hall 016ccf4544 Remove signed object which shouldn't exist 9 years ago
Erik Johnston cbe466e572 Update API docs 9 years ago
Daniel Wagner-Hall ccac9e7882 /join accepts a signature for a third party invite 9 years ago
Richard van der Hoff bc83677d98 Define the order for events returned by /context API 9 years ago
Richard van der Hoff 68a4306773 Split room previews into a separate module
Guest access and room peeking are orthogonal
9 years ago
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.
9 years ago
Oddvar Lovaas b28989b2ad fix for https://github.com/matrix-org/matrix-doc/issues/270 9 years ago
Mark Haines 8a050aebc0 Add a note to the docs for before and after to make it clear that they cannot be used with the predefined rules 9 years ago
David Baker 53a4a563e2 Actually we think they should not be present (which means synapse is buggy). 9 years ago
David Baker 542b17e944 Clarify what profile endpoints return if avatar url / display name isn't set 9 years ago
Richard van der Hoff 58b346e204 s/user_id/sender/ in context example response 9 years ago
Richard van der Hoff b2e0a855cc Add 'event' to event context API
also link through to the event schemas
9 years ago
Mark Haines e7f80b7c71 Fix the key name to be three_pid_creds rather than threePidCreds 9 years ago
Daniel Wagner-Hall 2e46b587b8 Require explicit un-banning 9 years ago
David Baker 169cc98101 M_INVALID_USERNAME to be consistent with the name of the parameter 9 years ago
David Baker 2301a792d7 Add an error code for invalid user names. 9 years ago
Matthew Hodgson cfbb695fd3 typoe 9 years ago
Daniel Wagner-Hall 1e2b63763e /join and /room/:roomId/join aren't exact aliases
Separate them, clarify their differences.

Also, fix some links which weren't being properly populated.
9 years ago
Richard van der Hoff 6265d6ce06 Merge pull request #254 from matrix-org/rav/filter_spec
Add some missing titles to the filter upload spec
9 years ago
Richard van der Hoff 972153be4f Fix endpoint path for /context
s/api//
9 years ago
Richard van der Hoff ff26e0dc48 Add some missing titles to the filter upload spec 9 years ago
Daniel Wagner-Hall 0e967edfd9 Fix thinko 9 years ago
Daniel Wagner-Hall 7d9547274c Clarify guest /events and /sync 9 years ago
Daniel Wagner-Hall 48aab7bad9 Return room avatar URLs in /publicRooms 9 years ago
Daniel Wagner-Hall 5e30d75ccb Add /_matrix/versions to spec 9 years ago
Erik Johnston 48f56bfbfb Support 3pid invites in /createRoom 9 years ago
Daniel Wagner-Hall 1eee36e889 Merge pull request #232 from matrix-org/daniel/deprecatestuff
Deprecated deprecated APIs
9 years ago
Matthew Hodgson c7d11335cf Merge branch 'master' of git+ssh://github.com/matrix-org/matrix-doc 9 years ago
Matthew Hodgson 691d9ba664 typo :( 9 years ago
Mark Haines 4c43939977 more backticks 9 years ago
Mark Haines 9b4a37f57b backticks 9 years ago
Mark Haines 288c7ed353 Add top level filters for filtering by room id. 9 years ago
Mark Haines 2ea66e9300 Merge branch 'markjh/account_data_filters' into markjh/room_filter 9 years ago
Mark Haines a32ed96a0f Document filtering for account data 9 years ago
Mark Haines e413f05c87 Merge pull request #243 from matrix-org/markjh/wildcards
Filters don't support wildcards for senders or room ids
9 years ago
Mark Haines c9349b302a Filters don't support wildcards for senders or room ids 9 years ago
Richard van der Hoff b7c255a887 Tweaks/clarifications to search spec
Fixes https://matrix.org/jira/browse/SPEC-305
9 years ago
Daniel Wagner-Hall b6cd3adc2f Merge pull request #233 from matrix-org/daniel/txnid
Merge pull request #233 from matrix-org/daniel/txnid
9 years ago
Christine Dodrill 7090e491de fix a typo in the example json for the old sync description 9 years ago
Erik Johnston 7980e65502 Merge pull request #234 from matrix-org/erikj/search_yet_agian
Note that count is approximate
9 years ago
Erik Johnston 88b350ca8b Better wording 9 years ago
Erik Johnston a2082e4b38 Note that count is approximate 9 years ago
Daniel Wagner-Hall dbba737135 Explain scope of uniqueness of txnid 9 years ago
Daniel Wagner-Hall 3e086909f1 Deprecated deprecated APIs 9 years ago
Daniel Wagner-Hall a484f04b33 Merge pull request #221 from matrix-org/daniel/pushaway
Merge pull request #221 from matrix-org/daniel/pushaway
9 years ago
Mark Haines a33e49fd1e Merge pull request #224 from matrix-org/markjh/filter_inline
Allow the filter JSON to be passed inline in the /sync request
9 years ago
Mark Haines c3a1318886 Make it explicit that the JSON filter object is passed as a string 9 years ago
Erik Johnston c96848d1bc Merge pull request #169 from matrix-org/erikj/search_yet_agian
Search: Document event context, groups and orders.
9 years ago
Erik Johnston 95255bcdf5 Use rst not html 9 years ago
Erik Johnston e1fda6b6b6 Remove double the 9 years ago
Erik Johnston 9c98c80bde Fix up filter description 9 years ago
Mark Haines ed70bcb180 Add a rationale for allowing both inline filters and passing filters by id. 9 years ago
Mark Haines 878ce2f206 Allow the filter JSON to be passed inline in the /sync request 9 years ago
Erik Johnston 6025569a73 Remove unused 403 stub 9 years ago
Erik Johnston 0fb88e26f0 Add tags 9 years ago
Erik Johnston 4290882034 Remove superfluous quote 9 years ago
Erik Johnston 8e7f6d44f6 Remove v1 references 9 years ago
Erik Johnston 4967b092aa Add description of state response key 9 years ago
Daniel Wagner-Hall a2283f5499 Remove /notify from client-server API 9 years ago
Erik Johnston f4b9433c7b Better wording 9 years ago
Erik Johnston 584104c432 Make example valid event id 9 years ago
Erik Johnston fda07e0d41 Merge remote-tracking branch 'origin/master' into erikj/event_context_api 9 years ago
Erik Johnston 856dd9100e Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian 9 years ago
Erik Johnston 118a6aa040 Reword groupings descriptions 9 years ago
Erik Johnston 1ef9cc37e3 Typo 9 years ago
Erik Johnston fca8e5abe7 Add top level next_batch key to example 9 years ago
Daniel Wagner-Hall f81b967e2d Make all the schema files yaml 9 years ago
Daniel Wagner-Hall 1f5b6271f2 Generate swagger-ui output for client-server API
Depends on:
https://github.com/matrix-org/matrix-doc/pull/212
https://github.com/matrix-org/matrix-doc/pull/208
https://github.com/matrix-org/matrix-doc/pull/207
for the actual rendered output to not throw javascript errors at runtime.
9 years ago
Daniel Wagner-Hall c9fee294df Merge pull request #211 from matrix-org/daniel/extractas
Move application service swagger out of c-s dir
9 years ago
Daniel Wagner-Hall 97579f15cb Merge pull request #212 from matrix-org/daniel/pushdictification
Take object, not bool, as param
9 years ago
Daniel Wagner-Hall 705556634a Add filters 9 years ago
Daniel Wagner-Hall 9c733a45e8 Take object, not bool, as param
Throughout our API we take objects. And swagger is unhappy with not
doing so.
9 years ago
Daniel Wagner-Hall 614ee9ea1b Move application service swagger out of c-s dir 9 years ago
Mark Haines 140206ca69 s/archived/leave/ 9 years ago
Mark Haines 79d109f7cc Add an flag to control whether rooms the user has left are included in the sync 9 years ago
Daniel Wagner-Hall e0ebabf8cc Explicitly document /rooms/{roomId}/state/{eventType} without state key 9 years ago
Daniel Wagner-Hall 873b0dcecf Replace version numbers with release numbers 9 years ago
Daniel Wagner-Hall f308b7543c Specify /admin/whois/{userId} 9 years ago
Daniel Wagner-Hall 19ce17cfed Merge pull request #200 from matrix-org/daniel/redact
Merge pull request #200 from matrix-org/daniel/redact
9 years ago
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 9 years ago
Daniel Wagner-Hall e072d215cf Specify redaction 9 years ago
Daniel Wagner-Hall 7f07da4b50 Remove obsolete documentation 9 years ago
Daniel Wagner-Hall aa4ed10821 Unify v1 and v2 event schemas 9 years ago
Daniel Wagner-Hall 681c258206 Fix turnServer endpoint 9 years ago
Erik Johnston ca7ef1b536 Update Results description 9 years ago
Erik Johnston 5e8bb34f36 Change the results dict to a list 9 years ago
Erik Johnston 46fd0b252c Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian 9 years ago
Daniel Wagner-Hall c6e0322a9e Swaggerify /account 9 years ago
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.
9 years ago
Daniel Wagner-Hall 3951785f19 Fix alias path 9 years ago
Daniel Wagner-Hall bc514dc9c4 Merge pull request #178 from matrix-org/daniel/directory
Fix and include /directory api docs
9 years ago
Daniel Wagner-Hall 7f2813354d Swaggerify /ban 9 years ago
Mark Haines a20a49abf6 Merge pull request #168 from matrix-org/markjh/client_config
Add API for setting client config
9 years ago
Mark Haines c5f457cee9 Merge pull request #132 from matrix-org/markjh/room_tags
Document a v2 api for setting tags on rooms
9 years ago
Daniel Wagner-Hall f0c99a6925 Generate API docs from swagger 9 years ago
Mark Haines c539b208f9 Merge branch 'markjh/room_tags' into markjh/client_config
Conflicts:
	api/client-server/v2_alpha/sync.yaml
9 years ago
Mark Haines d39494b6df Fix typo in sync example 9 years ago
Daniel Wagner-Hall 5e30b5b8d7 Remove POST version of /send
PUT should always be used.
9 years ago
Daniel Wagner-Hall c25a806cef Fix and include /directory api docs 9 years ago
Mark Haines 5ccc39b850 Say that type is an event type 9 years ago
Mark Haines e76068a2a6 Merge branch 'markjh/room_tags' into markjh/client_config 9 years ago
Mark Haines 5bae15d47b Merge branch 'master' into markjh/room_tags
Conflicts:
	api/client-server/v2_alpha/sync.yaml
9 years ago
Erik Johnston 46870da57d Add optional profile info and state in search response 9 years ago
Richard van der Hoff d8dd380dfa Merge pull request #164 from matrix-org/rav/SPEC-254
Fix /sync documentation, post SPEC-254
9 years ago
Mark Haines 05c0092664 s/config/account_data/ 9 years ago
Richard van der Hoff d7d59d78e1 /sync: Put state dict back to being a list
Turning the state into a dict-of-dicts caused more pain than it solved. Put it
back to a list.
9 years ago
Mark Haines 40f7eab73f s/private_user_data/account_data/ 9 years ago
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
9 years ago
Mark Haines fcbb985073 s/private_user_data/account_data/ 9 years ago
Richard van der Hoff 6653362f31 Unflatten 'unsigned'
It turns out that flattening 'unsigned' comes with too many downsides. Let's
stick with the status quo.
9 years ago
Daniel Wagner-Hall 6763317e64 Specify /rooms/:room_id/forget 9 years ago
Daniel Wagner-Hall 8201eaa042 Swaggerify /rooms/:room_id/leave 9 years ago
Erik Johnston ffed14a0cd Add next_batch token 9 years ago
Erik Johnston 8991c4fa78 Fix schema and example 9 years ago
Erik Johnston 5e0e4a8518 Document group and context response keys 9 years ago
Mark Haines 299af673da Specify how ordering of tags is supposed to work 9 years ago
Mark Haines 3b390bff3c Merge branch 'master' into markjh/room_tags
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
9 years ago
Mark Haines 8f5783615c Merge branch 'master' into markjh/client_config
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
9 years ago
Mark Haines 22b3159a39 Add examples of v1 initialSync and v2 /sync returning the client config 9 years ago
Mark Haines 769c5285ab Add API for setting client config 9 years ago
Erik Johnston e2eb0c7ad9 Add new request options 9 years ago
Richard van der Hoff e1b12a753e Fix typos and missing file 9 years ago
Richard van der Hoff 29bd4d45ee Flatten the response to /sync
Now that we don't expect there to be duplication betwen the 'timeline' and
'state' results, there's no point in having the state map. (That does mean the
events themselves need event_id fields though).

Also:

- move the contents of the 'unsigned' dictionary into the events themselves
- replace the state list with two layers of dictionary keyed on type and
  state_key
- rename the children of the 'rooms' dict from "joined/invited/archived" to
  "join/invite/leave" to match the membership states
9 years ago
Richard van der Hoff b41d771c15 Fix typos in /sync example response 9 years ago
Richard van der Hoff 57995a815a Fix a number of untruths in the documentation about /sync.
Attempts to make the /sync documentation better represent fact as it currently
stands - in particular document the structure of the returned events.
9 years ago
Richard van der Hoff 3f0262081c Update sync API defn to reflect SPEC-254 changes
State now corresponds to the start of the timeline, not the end.
9 years ago
Daniel Wagner-Hall 061105c9dc Guest users are allowed room initialSync 9 years ago
Daniel Wagner-Hall dcf54e11b1 Specify /publicRooms world_readable and guest_access
Depends on https://github.com/matrix-org/matrix-doc/pull/154
9 years ago
Daniel Wagner-Hall d7357ef9b7 Specify /publicRooms 9 years ago
Daniel Wagner-Hall 24c2036a35 3pid invites: remove mentions of display_name 9 years ago
Daniel Wagner-Hall e72151f2c3 Specify guest room access
This was reviewed as PR #150 and merged from daniel/anonymousaccess
9 years ago
Daniel Wagner-Hall 161441fa3a Update 3pid spec based on new implementation 9 years ago
Daniel Wagner-Hall 232b10b0f6 Merge branch 'master' of github.com:matrix-org/matrix-doc 9 years ago
Mark Haines b7cc5b1018 Merge pull request #141 from matrix-org/markjh/full_http_api_docs
Include the full schema for an http API in the docs
9 years ago
Mark Haines ebc0237109 Add the missing titles to the schema 9 years ago
Mark Haines d53814097f Add example content to the tags in example tag events 9 years ago
Mark Haines e9d361841b Fix tag examples 9 years ago
Daniel Wagner-Hall 2e3a0b4e00 Specify guest accounts 9 years ago
Mark Haines 52f55e0542 Allow room tags to have asssociated content, and return that content in the m.tag events 9 years ago
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 9 years ago
Mark Haines ad86426e95 Add private_user_data to v1 room /initialSync 9 years ago
Mark Haines b49472e3b0 Add private_user_data to v1 /initialSync 9 years ago
Mark Haines 451801bf38 Add an example of ``prev_content`` in ``unsigned`` to v2 /sync 9 years ago
Erik Johnston fa2fe2ddd9 Add event context api swagger 9 years ago
Matthew Hodgson 6c1df04b4b typo 9 years ago
Richard van der Hoff ece42688d0 Clarify the interaction between full_state and timeout. 9 years ago
Mark Haines 65066a76b3 Add the m.tags event to a ``private_user_data`` key rather than including it under the ``ephemeral`` key 9 years ago
Mark Haines 12e33a3b09 Document a v2 api for setting tags on rooms 9 years ago
Richard van der Hoff 13eddd456f Proposal for adding full_state param to v2 sync 9 years ago
Kegsay ade0ad5ed1 Merge pull request #129 from matrix-org/erikj/search_actual
Add filter param to search API
9 years ago
Erik Johnston 36634df355 Add filter param 9 years ago
Richard van der Hoff f47a49de43 Merge pull request #126 from matrix-org/rav/send_events_api
Add the room send and state APIs to the spec
9 years ago
Richard van der Hoff 1945697456 Further tweaks to the room send and state APIs
- fix confusion re empty/absent state_keys
- move 'types of room events' section earlier in the 'Events' section
- remove some redundant anchors
9 years ago
Mark Haines 1d7cb6937f Merge pull request #123 from matrix-org/markjh/list_formatting
Fix list formatting
9 years ago
Mark Haines 637718108e Add newline before list 9 years ago
Richard van der Hoff 28ab643a4e Remove duplicated registration/login APIs
Currently the spec duplicates all of the account-management APIs. There's still
work to be done here, but the complete duplication is confusing.
9 years ago
Richard van der Hoff 587a8ba7ce Merge branch 'master' into rav/send_events_api 9 years ago
Richard van der Hoff d2bbc461e4 mark stateKey as required in room/{id}/state
Swagger insists that path params be mandatory.
9 years ago
Richard van der Hoff d18d406c41 Add the room send and state APIs to the spec 9 years ago
Mark Haines cc14620932 Add a newline before the list 9 years ago
Mark Haines e3e8026025 Fix list formatting so that we aren't including everything in blockquotes 9 years ago
Erik Johnston f0c74a9c83 Merge pull request #96 from matrix-org/erikj/search_actual
Add search API
9 years ago
Kegan Dougal f95d19cecd Merge branch 'master' into appservice-swagger
Conflicts:
	specification/application_service_api.rst
9 years ago
Kegan Dougal 4c3e1b9ed3 Find replace fail 9 years ago
Kegan Dougal bd539c72b4 More review comments 9 years ago
Erik Johnston 1d01f69c3c Merge remote-tracking branch 'origin/master' into erikj/search_actual 9 years ago
Kegan Dougal 26f27d95fb Merge branch 'master' into registration-swagger
Conflicts:
	specification/client_server_api.rst
9 years ago
Kegan Dougal f450fc1db6 Typo 9 years ago
Kegan Dougal 4bb042daeb Review comments round II 9 years ago
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