r0 for the Application Services API

[Half-Shot]

Tracking issue for all the tasks that need to be completed for an r0 release of the AS API spec:

Required

• AppServices: We need to specify the API endpoints under Querying #1325 AppServices: We need to specify the API endpoints under Querying - Clean up user and alias querying for application services #1537
• AS traffic rate-limiting #1323 AS traffic rate-limiting
• AppServices: Document how filterings events work #1307 AppServices: Document how filterings events work - General/small improvements to the application service API specification #1533
• AppServices: Document client-server requests omitting user_id param #1296 AppServices: Document client-server requests omitting user_id param - Encourage appservices to use the Authorization header #1534
• 'age' field should be in unsigned #1294 'age' field should be in unsigned - Specify that application services receive events in the CSAPI format #1552
• Document Appservice Directories #1272 Document Appservice Directories - Application service room directories (and other third party network things) #1554
• Document Thirdparty AS Endpoints #1271 Document Thirdparty AS Endpoints
• AppServices: Why do events sent to AS's use "user_id", whereas events use "sender" #1269 AppServices: Why do events sent to AS's use "user_id", whereas events use "sender" - Specify that application services receive events in the CSAPI format #1552
• Document new application service registration file options #1262 Document new application service registration file options
• Remove lies from AS API spec about /_matrix/app/r0/alias and /_matrix/app/r0/user #800 Remove lies from AS API spec about /_matrix/app/r0/alias and /_matrix/app/r0/user - Clean up user and alias querying for application services #1537

Nice to haves

• https://github.com/matrix-org/matrix-doc/issues/1306 Proposal to filter out traffic to Appservices based on filters

(Disclaimer: This is not yet a complete list, but a roundup of the issues we know that need to be completed so far)

[non-Jedi]

#800 should also be fixed before r0 release imo.

[Half-Shot]

@non-Jedi Good shout. Added

[turt2live]

Have updated the original post to better reflect the current state of affairs. The linked project (https://github.com/matrix-org/matrix-doc/projects/1) is a living document for all the specs, although this issue is still useful to keep track of all things appservice.

Still not entirely comfortable with removing the [WIP] tag though - I haven't done any additional prioritization to the list.

[Half-Shot]

EDIT: based on below

I'd like to see these solved before r0:

• Does appservice timestamp massaging also apply to /kick, /ban, etc? #1394 > became > Timestamp massaging for application services #1585
• AS traffic rate-limiting #1323 (looks like it can be closed?)
• 'age' field should be in unsigned #1294 (looks like it can be closed?) > is being addressed by > Fix client-server event schemas: move age, dedupe fields #1558

Travis added

• r0.1.0 release of the Push Gateway specification #1521
• Application service spec cleanup; Security definitions; r0 prep #1555

[turt2live]

Just an update: #1394 has been closed in favour of #1585 due to #1586. #1323 has been closed (this was missed previously), and #1294 is being addressed by #1558.

In addition, before an r0 can be cut we need a defined release process (#1521) and the r0 prep to land (#1555).