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
Daniel Wagner-Hall
e0c55eeccf
Add initial identity server spec
...
More to come
9 years ago
Daniel Wagner-Hall
f4f186baee
Add _cs suffix to client-server http APIs
...
I'm about to add identity service APIs, so differentiating is good.
9 years ago
Daniel Wagner-Hall
902f25ef4a
Include newline before table headings
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
7a244ff977
Merge branch 'master' into rav/body_params_in_tables
...
Conflicts:
templating/matrix_templates/units.py
9 years ago
Richard van der Hoff
b8669609a0
Merge pull request #255 from matrix-org/rav/refactor_schema_logic
...
Refactor a bunch of the logic in matrix_templates/units.py
9 years ago
Richard van der Hoff
18570126b5
Merge pull request #259 from matrix-org/rav/doc_speedups
...
Speed up gendoc.py by only running build.py once
9 years ago
Richard van der Hoff
87f2f9e878
Fix review comments
9 years ago
Richard van der Hoff
1f6c4d5bb2
Speed up gendoc.py by only running build.py once
9 years ago
Richard van der Hoff
4bdfd3d492
Fix 'required' annotations
...
We lost some required annotations. Add them back in.
9 years ago
Richard van der Hoff
f438644ec3
Don't sort the properties in object schemas
...
It makes more sense for us to order the properties manually in the yaml file,
rather than forcing their alphabeticising.
9 years ago
Richard van der Hoff
93eb6fb352
another diff noise fix
9 years ago
Richard van der Hoff
71b6ea8578
Fix a couple of things which were giving noisy diffs
9 years ago
Richard van der Hoff
c6f5ba09d4
Display POST body parameters as tables
...
Replace a whole bunch of special-casing for POST body parameters with the same
logic as is used for response objects: represent all but the top-level as
tables.
9 years ago
Richard van der Hoff
9a5673a1cc
Reinstate event type info
...
The 'typeof' info on the events was perpetrated by a fearsome hack which I
broke. I don't want to fix it any better right now, so just make the hack work
and pull the rug over.
9 years ago
Richard van der Hoff
d17c84b819
Fix a missed call to get_tables_for_schema
9 years ago
Richard van der Hoff
9f9b3a1fdd
Refactor a bunch of the logic in matrix_templates/units.py
...
Move 'inherit_parents' calls up to before get_json_schema_object_fields so that
things can inherit their types via allOf declarations. Also make it possible to
inherit descriptions.
Remove redundant 'include_parents' parameter, which was never used.
Move 'resolve_references' call out of get_tables_for_schema (it was redundant
sometimes and not others, and now it is clearer who has responsibility for it)
9 years ago
Daniel Wagner-Hall
3e086909f1
Deprecated deprecated APIs
9 years ago
Daniel Wagner-Hall
1d2ed9e9d6
Changelogs: indent instead of blockquoting
9 years ago
Daniel Wagner-Hall
dcd51c39b3
Indent state-key descriptions
...
Right now two spaces make a <dt> whereas four does the right thing.
9 years ago
Daniel Wagner-Hall
b8ea5f7ffb
Resolve references by default
...
This means I can re-use this function for the swagger-UI generation
I can't see why you would want un-resolved references as a consumer.
9 years ago
Daniel Wagner-Hall
39f43abbb7
Add per-API changelogs
9 years ago
Daniel Wagner-Hall
f81b967e2d
Make all the schema files yaml
9 years ago
Daniel Wagner-Hall
614ee9ea1b
Move application service swagger out of c-s dir
9 years ago
Daniel Wagner-Hall
97fd1fdd62
Embed client and server release numbers
...
Note that this also removes the changelog - I'm going to re-add the
changelog differently soon.
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
Richard van der Hoff
9fb26f7c85
Merge pull request #163 from matrix-org/rav/rework_objects
...
Updates to swagger table generation
9 years ago
Daniel Wagner-Hall
4faede73a1
Merge branch 'master' into daniel/multipleexamples
9 years ago
Richard van der Hoff
34ac544290
Merge branch 'master' into rav/rework_objects
...
Conflicts:
templating/matrix_templates/units.py
9 years ago
Kegan Dougal
d1c685f296
Merge branch 'master' into rav/refactor_tables
9 years ago
Kegan Dougal
8648f86032
Moar spaces
9 years ago
Erik Johnston
96be7ff241
Support more nesting
9 years ago
Richard van der Hoff
838af2a23e
Updates to swagger table generation
...
A bunch of related fixes to the code for parsing the state and API yaml files:
1. Some of our objects are {key: {key: value}} - style nested key/value
dictionaries. Handle this by refactoring get_json_schema_object_fields so
that such objects are handled wherever they appear, rather than when they
are just subproperties of a 'proper' object.
2. Fix multi-level inheritance (so an object can have an 'allOf' property which
can successfully refer to an object which itself has an 'allOf' property).
3. $ref fields in event schemas weren't being expanded correctly
4. sort type tables breadth-first rather than depth-first so that the ordering
in complex structures like the /sync response makes a bit more sense.
9 years ago
Richard van der Hoff
cc8ef691fb
Rewrite the table templates
...
Allow columns to stretch if they end up with wide content.
Apart from the hassle of having to manually update the calculations, having the
columns wide enough to hold the widest thing they might ever have leads to
tables with lots of whitespace in the results.
9 years ago
Daniel Wagner-Hall
d7357ef9b7
Specify /publicRooms
9 years ago
Daniel Wagner-Hall
c00abe9f2f
Fix msgtype display
9 years ago
Daniel Wagner-Hall
071edcd86e
Merge branch 'master' into daniel/multipleexamples
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
2734f9f9f2
Merge branch 'master' into daniel/multipleexamples
...
Conflicts:
specification/modules/third_party_invites.rst
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
c719946370
Enable syntax highlighting for message type examples
9 years ago
Mark Haines
8070489080
Handle lists of types in arrays
9 years ago
Mark Haines
e49ea9015f
Deduplicate tables with the same title
9 years ago
Mark Haines
8322151661
Don't put a space when appending the "Must be" strings to the desciption if there isn't a description, otherwise it will mess up the indent
9 years ago
Daniel Wagner-Hall
2e3a0b4e00
Specify guest accounts
9 years ago
Mark Haines
91eb25b76d
Include the full schema for an http API in the docs by resolving references to other files
9 years ago
Daniel Wagner-Hall
176f919fc8
Show multiple examples where present
9 years ago
Mark Haines
71874870c8
Enable syntax highlighting for example http requests
9 years ago