Commit graph

2996 commits

Author SHA1 Message Date
Richard van der Hoff 986f5df82e Merge pull request #319 from matrix-org/rav/swagger_refs
Improve handling of $ref in swagger files
2016-05-04 14:38:38 +01:00
Richard van der Hoff 262c9ea113 Improve handling of $ref in swagger files
It turns out that swagger merges $refed attributes with those defined inline,
so do the same here.
2016-05-04 14:24:01 +01:00
Richard van der Hoff 4c46c95d0e Merge pull request #317 from ruma/master
Improvements to the spec index page
2016-05-04 10:34:32 +01:00
Jimmy Cuadra c44d61b3a9 Clarify which documents are generated from scripts. 2016-05-04 02:30:44 -07:00
Jimmy Cuadra 22b542e3f9 Fix grammar in spec index. 2016-05-04 02:27:29 -07:00
Jimmy Cuadra 5b18db9096 Make list of APIs on the index a table. 2016-05-04 01:42:01 -07:00
Jimmy Cuadra 4b27d6a7a4 Reorganize spec index. 2016-05-04 01:42:01 -07:00
Richard van der Hoff 7138205f31 Update README.md
escape angle-bracket to stop it getting lost in markdown
2016-05-04 01:08:50 +01:00
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.
2016-05-04 00:19:46 +01:00
Richard van der Hoff 0546f0917d Replace hacky shell to do matrix styling with hacky perl
Since the shell just wrapped three invocations of perl, we might as well do
it all in perl.
2016-05-04 00:01:54 +01:00
Richard van der Hoff 23c4ffbc1b Add securityDefintions to generated swagger JSON
Also factor out to a common file
2016-05-03 13:57:16 +01:00
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
2016-05-03 13:52:11 +01:00
Richard van der Hoff affb106014 Remove redundant scripts under api/
We now use newer swagger, via scripts/dump-swagger.py
2016-05-03 12:05:52 +01:00
Richard van der Hoff 60f36bf868 Script to serve the generated swagger JSON
We need custom CORS headers to serve the swagger JSON, so add a script to do it
2016-05-03 12:04:44 +01:00
Richard van der Hoff c39d797cce Dump-swagger: take output file name rather than output dir
Make the argument to dump-swagger.py be the name of the output file rather than
the output dir, and give it a sensible default.

Also, use the absolute path to the output file, so that the output path is
relative to the user's cwd rather than the templating dir.
2016-05-03 12:03:21 +01:00
Paul Evans 9b93c5f463 Merge pull request #314 from matrix-org/paul/update-howto-for-r0
Update client-server howto for r0
2016-04-25 14:20:23 +01:00
Paul "LeoNerd" Evans 8824fe8391 Remove port number from room IDs in pasted examples 2016-04-25 13:55:57 +01:00
Paul "LeoNerd" Evans b448c96096 Use port 8448 in example URLs 2016-04-25 13:51:10 +01:00
Paul "LeoNerd" Evans 4a565876ee Merge remote-tracking branch 'origin/master' into paul/update-howto-for-r0 2016-04-25 13:50:26 +01:00
Paul Evans 0d2bed7e66 Merge pull request #313 from matrix-org/paul/migrating-from-v1
Initial hack at migration guide
2016-04-21 18:56:49 +01:00
Paul "LeoNerd" Evans a077f8470a Various rewordings from latest review comments 2016-04-21 17:23:04 +01:00
Paul "LeoNerd" Evans ea6ac3e40f Another rewording of 'state' returned by '/sync' with 'since' parameter 2016-04-20 15:04:23 +01:00
Paul "LeoNerd" Evans 8f22cf6cb8 Minor rewording/grammar 2016-04-20 14:59:38 +01:00
Paul "LeoNerd" Evans 54624f397a Clarification/rewording on old and new sync-with-limit behaviour 2016-04-19 18:26:01 +01:00
Paul "LeoNerd" Evans 98df455a99 Refer to old v1 behaviours in past-tense for clarity of reading 2016-04-19 17:44:48 +01:00
Paul "LeoNerd" Evans 46341b2269 Add some notes about the main differences in return value of /sync as compared /initialSync 2016-04-19 17:29:59 +01:00
Paul "LeoNerd" Evans 29f675e3c6 Remark that per-room /sync probably isn't necessary these days 2016-04-19 16:13:17 +01:00
Oddvar Lovaas b2028616c1 spelling 2016-04-19 14:53:15 +01:00
Oddvar Lovaas 231d824cfd change date to move 2016-04-19 14:49:00 +01:00
Oddvar Lovaas a91d2e86c1 Merge pull request #315 from Half-Shot/master
Added Project .NET SDK
2016-04-19 14:41:21 +01:00
Will Hunt b020db779e Added github link to .NET SDK 2016-04-18 11:01:53 +01:00
Will Hunt 22a2c02d20 Added .NET SDK :) 2016-04-18 10:58:09 +01:00
Matthew Hodgson c67c350611 spell out that Matrix is more concerned with bridging than XMPP 2016-04-16 22:46:47 +01:00
Paul "LeoNerd" Evans a0de12f24e More detail on using /sync with ad-hoc filters 2016-04-14 18:35:49 +01:00
Paul "LeoNerd" Evans a064d37f64 Update v1 /initialSync + /events examples to use r0 /sync instead 2016-04-14 18:32:19 +01:00
Paul "LeoNerd" Evans 079a963bc5 Update room ID in example URLs for /r0 2016-04-14 18:11:30 +01:00
Paul "LeoNerd" Evans 5f72f1683c Use /r0 for regular room APIs 2016-04-14 18:07:05 +01:00
Paul "LeoNerd" Evans aa036f7ef1 The /register parameter for username is "username", not "user" 2016-04-14 18:03:55 +01:00
Paul "LeoNerd" Evans 8700406c92 Use /r0 login API 2016-04-14 17:24:11 +01:00
Paul "LeoNerd" Evans 4f5ae82be9 Actually it's only /register that discovers flows by empty POST; /login uses GET 2016-04-14 17:21:44 +01:00
Paul "LeoNerd" Evans 30b39d6455 Remove now-stale comment about r1 /register flow 2016-04-14 17:19:17 +01:00
Paul "LeoNerd" Evans 5abac2eb1c Use /r0 register API 2016-04-14 17:18:43 +01:00
Paul "LeoNerd" Evans 55a9d0b067 login&register flow discovery by empty POST 2016-04-14 17:00:56 +01:00
Paul "LeoNerd" Evans 96577cffd7 Also no /api path component any more 2016-04-14 16:56:41 +01:00
Paul "LeoNerd" Evans 5e49fe7e45 Use https in localhost examples 2016-04-14 16:48:24 +01:00
Paul "LeoNerd" Evans 313fdab848 Initial hack at migration guide 2016-04-14 16:15:46 +01:00
David Baker 98f1d4efec Merge pull request #308 from matrix-org/dbkr/get_pushers
Add endpoint for getting a user's pushers
2016-04-13 14:10:48 +01:00
David Baker 1a856b53f3 Remove redundant info & add backticks 2016-04-13 10:29:57 +01:00
Richard van der Hoff 647679cd66 Merge pull request #309 from matrix-org/rav/sanify_continuserv
Continuserv: Reduce number of watches
2016-04-12 11:17:44 +01:00
David Baker 4b294b23de Tailor descriptions to GET method 2016-04-12 09:56:24 +01:00