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.
6 years ago
cc1e496287
Merge pull request #1629 from turt2live/travis/as/route-versions
...
Version all appservice endpoints and provide a fallback
6 years ago
be5c566028
Version all appservice endpoints and provide a fallback
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1616
6 years ago
f01cfa2c7b
Add security definitions to hs->as endpoints
6 years ago
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.
6 years ago
51193cac39
Merge remote-tracking branch 'matrix-org/master' into travis/as/normal-events
6 years ago
32ac81c588
Spelling
6 years ago
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.
6 years ago
9eda1a6971
Move the third party network API to it's own section
6 years ago
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
6 years ago
bbd33c1461
Move appservice transaction API to the right section
...
Part of https://github.com/matrix-org/matrix-doc/issues/1532
6 years ago
7e5160c7c2
Merge remote-tracking branch 'matrix-org/master' into travis/as/user-alias-query
6 years ago
a320c58e42
A path parameter is obviously URL encoded
6 years ago
c8ba2e098c
Wording improvements for appservices
6 years ago
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.
6 years ago
069a2f7481
Split the query user and room APIs out to their own files
6 years ago
5b5b4cfbed
Explicitly say how appservices should detect state events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1014
6 years ago
5f8967c074
Move TODO. field1, field2... -> fields...
6 years ago
53137a3c53
c/p bug, fix operationIds, move rst docs to md
6 years ago
273acb277c
Change fields to use new extended query array syntax
6 years ago
0ff882fb3b
Field definitions for protocol metadata
6 years ago
1829589d23
Convert 3pn errors to new definition
6 years ago
291a4dfc76
Third party lookup module. Fix wording
6 years ago
114bcf1a2e
Use $ref, clean up, fix errors, AS is now a C-S module.
6 years ago
e81e0328c2
Fix single protocol metadata endpoint path, remove 500s
6 years ago
4c38012122
I can spell
6 years ago
e6218b56ab
Switch properties to schema
6 years ago
a6dad76c01
Fix indentation
6 years ago
cc3724b54a
fix indentation, error messages. add rest of PR
6 years ago
d73b247688
3PE lookup service
7 years ago
828086a86c
Supply operationId for freshly added IS and AS operations
7 years ago
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>
7 years ago
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.
7 years ago
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).
9 years ago
614ee9ea1b
Move application service swagger out of c-s dir
9 years ago
Travis Ralston