Travis Ralston
98a445890c
Render a warning if the spec is unstable
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1499
This is done by using magic variables in the RST. The magic variables are generated based on the substitutions available, making them available for use at build-time.
Magic variables were chosen because it allows people to continue working on the spec and release process without having to worry about removing a chunk of text from the top of the file. Originally, this was attempted by using jinja2 if-statements, however the substitutions are replaced *after* the template is executed, so the condition would never match.
The format of the variable is to make the templating happy. Using colons or percent signs results in the templator thinking something else is going on, and then complaining about format.
6 years ago
Travis Ralston
70f72b5b3b
Merge pull request #1628 from turt2live/travis/as/external_url
...
Clarify how external_url is supposed to work
6 years ago
Travis Ralston
cc1e496287
Merge pull request #1629 from turt2live/travis/as/route-versions
...
Version all appservice endpoints and provide a fallback
6 years ago
Travis Ralston
326ff6b1a1
Merge branch 'master' into travis/as/external_url
6 years ago
Travis Ralston
1a3f112337
Clarify that the external_url is unsafe
6 years ago
Travis Ralston
be5c566028
Version all appservice endpoints and provide a fallback
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1616
6 years ago
Travis Ralston
a48f7b9278
Clarify how external_url is supposed to work
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1624
6 years ago
Travis Ralston
05b017276c
Don't accidentally limit application services to one homeserver
6 years ago
Travis Ralston
a5c3924492
Merge remote matrix-org/master
6 years ago
Travis Ralston
25b34e1d7b
Mention that ts massaging was in a draft, but not in the release
6 years ago
Travis Ralston
85b9769cd9
Comment out the timestamp massaging section for now
...
Pending discussion on https://github.com/matrix-org/matrix-doc/issues/1585
6 years ago
Travis Ralston
6f80db5ddf
Include the "other versions" section of the changelog
6 years ago
Travis Ralston
07153c22a9
Misc. cleanup of the appservice spec
6 years ago
Travis Ralston
fa96d8629b
Prepare the appservice spec for an r0 release
...
This puts the scaffolding in place for an r0 release to happen, such as the changelog and version variables.
6 years ago
Travis Ralston
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
Travis Ralston
51193cac39
Merge remote-tracking branch 'matrix-org/master' into travis/as/normal-events
6 years ago
Travis Ralston
090f852fdf
Merge pull request #1262 from matrix-org/anoa/document_as_options
...
Document new application service registration file options
6 years ago
Travis Ralston
54032964fc
Misc clarity for 3rd party appservice protocols/locations
6 years ago
Travis Ralston
017d6db737
Document third party network/protocol directories (for appservices)
...
Fixes https://github.com/matrix-org/matrix-doc/issues/869
6 years ago
Travis Ralston
9eda1a6971
Move the third party network API to it's own section
6 years ago
Travis Ralston
bbd33c1461
Move appservice transaction API to the right section
...
Part of https://github.com/matrix-org/matrix-doc/issues/1532
6 years ago
Travis Ralston
6172d5986a
Merge pull request #1537 from turt2live/travis/as/user-alias-query
...
Clean up user and alias querying for application services
6 years ago
Travis Ralston
997562786b
Merge pull request #1534 from turt2live/travis/as/auth-impersonation
...
Encourage appservices to use the Authorization header
6 years ago
Travis Ralston
1102fc59b2
Spelling
6 years ago
Travis Ralston
389fa87e6e
English
6 years ago
Travis Ralston
339a2748e8
Take out groups for now; Move namespace mention
...
Groups aren't landing in the spec yet, so we shouldn't include them yet.
6 years ago
Travis Ralston
24edec67c3
Merge remote-tracking branch 'matrix-org/master' into anoa/document_as_options
6 years ago
Travis Ralston
7e5160c7c2
Merge remote-tracking branch 'matrix-org/master' into travis/as/user-alias-query
6 years ago
Travis Ralston
13a1628f59
Improve wording about how masquerading works
6 years ago
Travis Ralston
7ad22b2454
Merge pull request #1533 from turt2live/travis/as/general
...
General/small improvements to the application service API specification
6 years ago
Travis Ralston
c8ba2e098c
Wording improvements for appservices
6 years ago
Travis Ralston
9ec914956f
Merge pull request #1536 from turt2live/travis/as/user-namespace
...
Recommend that application services use an underscore for namespacing
6 years ago
Travis Ralston
0863c5452e
Take out the false third party network endpoints
...
Fixes https://github.com/matrix-org/matrix-doc/issues/800
6 years ago
Travis Ralston
95b2b7c2bc
Move query APIs to the right heading
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1325
Addresses some of https://github.com/matrix-org/matrix-doc/issues/1532
6 years ago
Travis Ralston
069a2f7481
Split the query user and room APIs out to their own files
6 years ago
Travis Ralston
954498bf78
Recommend that application services use an underscore for namespacing
...
Fixes https://github.com/matrix-org/matrix-doc/issues/689
6 years ago
Travis Ralston
205b326e4a
Add a note that application services cannot /sync normally
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1144
6 years ago
Travis Ralston
857bcc0fe7
Encourage appservices to use the Authorization header
...
This also throws in a mention about how to handle a request with a lack of user_id.
The request samples now encourage the use of the header over the query string, and have had their sample values added for some readability.
Fixes https://github.com/matrix-org/matrix-doc/issues/1296
Fixes https://github.com/matrix-org/matrix-doc/issues/1424
6 years ago
Travis Ralston
7caad61b86
Clearly state how the users namespace relates to interest in events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1307
6 years ago
Travis Ralston
fd101b6ac9
Misc language changes
6 years ago
user
d6fb5afd16
Clarified group_id group visibility, url possibilities, regex starters
...
Changed Application Service capatalization to be consistent with the
rest of the document.
7 years ago
Andrew Morgan
9ca62edda0
Document new application service registration file options.
7 years ago
Matthew Hodgson
9cb626982a
s/user/username/ typo
8 years ago
Richard van der Hoff
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
Richard van der Hoff
5cc9066159
Add git versions to other parts of the spec
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
9bc07ea093
Add ID to application services
9 years ago
Matthew Hodgson
411ab64712
fix misnamed key in example; thanks SkaveRat
9 years ago
Daniel Wagner-Hall
f6b1b80678
Fix param name
9 years ago
Daniel Wagner-Hall
873b0dcecf
Replace version numbers with release numbers
9 years ago