d6d74c4cbe
Switch to using $ instead of # for sub-types
...
# is reserved by the swagger validator as a way to include partial content from a JSON object (eg: "#/path" would include {"test": true} from the object {"path":{"test":true}}). Instead of trying to convince the validator that it is wrong, we'll just use a different character.
Note that our rendering tools do not care about #-style references to objects. It's still somewhat worth changing the character though.
2019-05-29 15:28:48 -06:00
cc1e496287
Merge pull request #1629 from turt2live/travis/as/route-versions
...
Version all appservice endpoints and provide a fallback
2018-08-30 11:11:25 -06:00
be5c566028
Version all appservice endpoints and provide a fallback
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1616
2018-08-30 11:03:42 -06:00
f01cfa2c7b
Add security definitions to hs->as endpoints
2018-08-27 18:04:14 -06:00
17e0ef4b91
Remove empty file and now-empty section from the appservice spec
...
This commit has approval under https://github.com/matrix-org/matrix-doc/pull/1555 although is being included in this branch/PR so the build passes, permitting a merge.
2018-08-27 17:58:47 -06:00
51193cac39
Merge remote-tracking branch 'matrix-org/master' into travis/as/normal-events
2018-08-27 17:53:32 -06:00
32ac81c588
Spelling
2018-08-27 17:41:27 -06:00
2d43ff1234
Update third party network schemas
...
Some information was missed when this was reviewed. This commit adds some additional documentation for how these objects interact with each other.
2018-08-24 10:48:47 -06:00
9eda1a6971
Move the third party network API to it's own section
2018-08-24 10:22:19 -06:00
6a91ea9c85
Specify that application services receive events in the CSAPI format
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1269
This is also supposed to fix the 'age' problem, however that is a larger problem with the event schemas that is reserved for a future PR/commit.
Reference: https://github.com/matrix-org/matrix-doc/issues/1294
Reference: https://github.com/matrix-org/matrix-doc/issues/1524
2018-08-23 13:31:33 -06:00
bbd33c1461
Move appservice transaction API to the right section
...
Part of https://github.com/matrix-org/matrix-doc/issues/1532
2018-08-23 13:29:04 -06:00
7e5160c7c2
Merge remote-tracking branch 'matrix-org/master' into travis/as/user-alias-query
2018-08-20 12:37:05 -06:00
a320c58e42
A path parameter is obviously URL encoded
2018-08-20 12:36:26 -06:00
c8ba2e098c
Wording improvements for appservices
2018-08-20 12:09:17 -06:00
60b8e72a67
Minor text changes to the query APIs; Keep OpenMarket copyright
...
The bulk of these APIs were copied from OpenMarket's work - we should preserve the copyright header.
2018-08-17 15:45:10 -06:00
069a2f7481
Split the query user and room APIs out to their own files
2018-08-17 15:22:06 -06:00
5b5b4cfbed
Explicitly say how appservices should detect state events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1014
2018-08-17 13:38:38 -06:00
5f8967c074
Move TODO. field1, field2... -> fields...
2018-07-30 19:21:54 +01:00
53137a3c53
c/p bug, fix operationIds, move rst docs to md
2018-07-30 11:09:50 +01:00
273acb277c
Change fields to use new extended query array syntax
2018-07-30 11:09:50 +01:00
0ff882fb3b
Field definitions for protocol metadata
2018-07-30 11:09:50 +01:00
1829589d23
Convert 3pn errors to new definition
2018-07-12 12:16:11 -06:00
291a4dfc76
Third party lookup module. Fix wording
2018-07-12 16:59:30 +01:00
114bcf1a2e
Use $ref, clean up, fix errors, AS is now a C-S module.
2018-07-12 14:31:34 +01:00
e81e0328c2
Fix single protocol metadata endpoint path, remove 500s
2018-07-05 17:50:34 +01:00
4c38012122
I can spell
2018-07-05 12:58:42 +01:00
e6218b56ab
Switch properties to schema
2018-07-05 11:59:10 +01:00
a6dad76c01
Fix indentation
2018-07-05 11:56:30 +01:00
cc3724b54a
fix indentation, error messages. add rest of PR
2018-07-05 11:55:25 +01:00
d73b247688
3PE lookup service
2018-07-03 14:40:28 +01:00
828086a86c
Supply operationId for freshly added IS and AS operations
2017-11-15 07:53:36 +09:00
24afe7987c
Add operationId to all endpoints of all APIs
...
To facilitate generation of API stubs from the spec.
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
2017-10-11 01:58:31 +09:00
820704a16a
Format examples as raw objects
...
According the the openapi spec, examples for responses and schemas should be
raw objects rather than being json strings. (It's unclear what non-json
examples should look like...).
The swagger UI used to support json strings, but no longer does. In short,
let's turn the json strings into their raw formats.
2017-09-27 08:04:24 +01:00
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
614ee9ea1b
Move application service swagger out of c-s dir
2015-12-04 17:34:48 +00:00
Travis Ralston