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
c25afa663e
Use consistent event examples throughout the Client-Server API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1968
2019-05-29 14:57:56 -06:00
e9579a7840
The `rank` in search results is actually a floating point number
...
This was accidentally changed in https://github.com/matrix-org/matrix-doc/pull/1571 and appears to be the only instance.
2018-08-28 11:01:43 -06:00
6cdb463829
Merge pull request #1571 from turt2live/travis/general/number-to-int
...
Replace applicable types of 'number' to 'integer'
2018-08-28 07:40:28 -06:00
5fa6b49365
Specify the type of filter the search API expects
...
Note: This is badly named until https://github.com/matrix-org/matrix-doc/pull/1570 lands
Fixes https://github.com/matrix-org/matrix-doc/issues/598
2018-08-27 15:56:47 -06:00
667fa082af
Replace applicable types of 'number' to 'integer'
...
`number` implies/represents a float where `integer` does not.
The only remaining `type: number` in the project appear on power levels: those have been left untouched pending clarification.
Fixes https://github.com/matrix-org/matrix-doc/issues/746
2018-08-26 21:32:44 -06:00
197c36c520
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
2018-07-12 12:13:07 -06:00
fbee83d5cf
Clarify some of the properties on the search result
...
Fixes https://github.com/matrix-org/matrix-doc/issues/773
2018-07-10 15:08:28 -06:00
55c27d6212
Merge branch 'master' into travis/better-errors
2018-07-05 13:40:17 -06:00
16860ddd22
De-quote
2018-07-05 10:46:53 -06:00
dfdc5f9bef
search.yaml: Rename some titles to avoid confusion between request and response schemas
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-07-04 20:11:08 -06:00
7cd22f5690
Describe the rate limit error everywhere
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
2018-07-04 13:45:34 -06:00
df5455de1f
re-arrange fields in example /search request to make them a valid request.
2018-06-05 10:12:34 +01:00
64f97c5b78
add example of highlights field in /search response
2018-06-05 10:10:24 +01:00
4ff5887c91
spec the highlights field in /search response
2018-06-05 10:06:26 +01:00
dc27323d8b
Document the defaults for the /search API
2018-01-30 14:29:59 +00:00
66268260c7
Merge remote-tracking branch 'remotes/origin/master'
2017-11-13 07:46:29 +09:00
a8afbfd27d
Avoid external link in search swagger
2017-10-15 23:01:54 +01: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
432c78f3b5
Fix the swagger for /search so that it works without preprocessing
...
Makes the /search swagger work when it is imported directly into the swagger-UI
without preprocessing by dump_swagger
2016-05-04 14:55:43 +01:00
5383754a40
Access event-schemas via a symlink
...
Swagger gets a bit confused about $refs via '../..', so use a symlink to make
everything nicely relative.
2016-05-04 14:39:52 +01:00
23c4ffbc1b
Add securityDefintions to generated swagger JSON
...
Also factor out to a common file
2016-05-03 13:57:16 +01:00
b7c255a887
Tweaks/clarifications to search spec
...
Fixes https://matrix.org/jira/browse/SPEC-305
2015-12-17 13:40:22 +00:00
88b350ca8b
Better wording
2015-12-11 11:41:51 +00:00
a2082e4b38
Note that count is approximate
2015-12-11 10:54:01 +00:00
95255bcdf5
Use rst not html
2015-12-08 16:02:55 +00:00
e1fda6b6b6
Remove double the
2015-12-08 15:35:59 +00:00
9c98c80bde
Fix up filter description
2015-12-08 15:26:06 +00:00
4967b092aa
Add description of state response key
2015-12-08 13:37:32 +00:00
856dd9100e
Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian
2015-12-07 16:28:14 +00:00
118a6aa040
Reword groupings descriptions
2015-12-07 16:06:25 +00:00
1ef9cc37e3
Typo
2015-12-07 15:58:31 +00:00
fca8e5abe7
Add top level next_batch key to example
2015-12-07 15:54:08 +00:00
f81b967e2d
Make all the schema files yaml
2015-12-07 13:56:36 +00:00
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.
2015-12-07 12:45:13 +00:00
873b0dcecf
Replace version numbers with release numbers
2015-12-04 11:09:35 +00:00
aa4ed10821
Unify v1 and v2 event schemas
2015-12-01 17:23:58 +00:00
ca7ef1b536
Update Results description
2015-12-01 15:34:25 +00:00
5e8bb34f36
Change the results dict to a list
2015-12-01 15:33:13 +00:00
46fd0b252c
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian
2015-12-01 15:06:13 +00:00
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.
2015-11-30 11:22:57 +00:00
Travis Ralston