Clean up user and alias querying for application services #1537
Conversation
Fixes matrix-org#1325 Addresses some of matrix-org#1532
The bulk of these APIs were copied from OpenMarket's work - we should preserve the copyright header.
| @@ -39,7 +40,7 @@ paths: | |||
| - in: path | |||
| name: roomAlias | |||
| type: string | |||
| description: The room alias being queried. | |||
| description: The URL encoded room alias being queried. | |||
There was a problem hiding this comment.
erm, of course it's url-encoded - it's in a URL. we don't say this anywhere else, so specifying it here is confusing imho
| {{query_user_as_http_api}} | ||
|
|
||
| {{query_room_as_http_api}} | ||
|
|
||
|
|
||
| HTTP APIs |
There was a problem hiding this comment.
I think this needs a bit more tidying up. In particular, it's odd that the "HTTP APIs" section - which explains that these are APIs which are hit by the homeserver and that the AS must provide them - comes after the "querying" section which of course is a subset of the above.
There was a problem hiding this comment.
Sorry, I failed to mention the plan here: All the APIs are being moved out of this section to more relevant areas, making the section blink out of existence. This is the same approach that was used for the server spec to get rid of a similarly named section.
|
|
||
| Application services wishing to use ``/sync`` or ``/events`` from the Client-Server | ||
| API MUST do so with a virtual user (provide a ``user_id`` via the query string). It | ||
| is expectected that the application service use the transactions pushed to it to |
There was a problem hiding this comment.
looks like this has come from master, but I've just noticed it says "expectected" :/
Rendered: see 'docs' status check.
It may be best to review these changes one by one to see the progression.
Split the query user and room APIs out to their own files
Move query APIs to the right heading
Fixes #1325
Take out the false third party network endpoints
Fixes #800
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.