Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

AppServices: Document client-server requests omitting user_id param #1296

Closed
anoadragon453 opened this issue Jun 13, 2018 · 1 comment
Closed

AppServices: Document client-server requests omitting user_id param #1296

anoadragon453 opened this issue Jun 13, 2018 · 1 comment
Assignees
@turt2live
Labels
application services spec-omission implemented but not currently specified
Projects
August 2018 r0

Comments

@anoadragon453
Copy link
Member

The majority of application services and Synapse itself all allow for the behavior of omitting the user_id parameter when calling the Client-Server API with an access_token. This assumes that the application service is acting as its main user, or what it specifies as the sender_localpart user in its registration config.

This behavior is currently not documented anywhere in the spec, and would be useful for homeservers implementing the AS API to know when they get these types of requests from application services :)
@anoadragon453 anoadragon453 added the spec-omission implemented but not currently specified label Jun 13, 2018
@non-Jedi
Copy link
Contributor

For what it's worth, this was the most confusing part when I was trying to implement an application service. The "main AS user" wasn't even mentioned at that time in the AS doc.

@Half-Shot Half-Shot mentioned this issue Jun 22, 2018
Closed
11 tasks
@turt2live turt2live added this to To do: appservices (prioritized) in August 2018 r0 Aug 14, 2018
@turt2live turt2live self-assigned this Aug 17, 2018
turt2live added a commit to turt2live/matrix-doc that referenced this issue Aug 17, 2018
@turt2live
Encourage appservices to use the Authorization header
857bcc0 
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 matrix-org#1296
Fixes matrix-org#1424
@turt2live turt2live mentioned this issue Aug 17, 2018
Merged
@turt2live turt2live moved this from To do: appservices (prioritized) to In review in August 2018 r0 Aug 17, 2018
August 2018 r0 automation moved this from In review to Done (this list will be incomplete) Aug 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@turt2live turt2live

Labels
application services spec-omission implemented but not currently specified
Projects
No open projects
August 2018 r0
  
Done (this list will be incomplete)
Milestone
No milestone
Development

No branches or pull requests
3 participants
@turt2live @anoadragon453 @non-Jedi