Skip to content

Commit

Permalink
Fix, clarify, add example to raw command help
Browse files Browse the repository at this point in the history
  • Loading branch information
JOJ0 committed Oct 13, 2023
1 parent 530782a commit 1f5cb6d
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions synadm/cli/raw.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,11 @@ def raw_request_cmd(helper, endpoint, method, data, data_file):
""" Issue a custom request to the Synapse Admin API.
The endpoint argument is the part of the URL _after_ the configured base
URL and Matrix path (see `synadm config`). A simple get request would e.g
look like this: `synadm matrix raw client/versions`
"Synapse base URL" and "Synapse Admin API path" (see `synadm config`).
A get request to the "Query User Account API" would look like this:
`synadm raw v2/users/%40testuser%3Aexample.org`. URL encoding must be
handled at this point. Consider enabling debug outputs via synadm's global
flag `-vv`
"""
if data_file:
data = data_file.read()
Expand Down

0 comments on commit 1f5cb6d

Please sign in to comment.