API documentation #13
Conversation
|
This pull request has been linked to Shortcut Story #28389: The Python SDK documentation should be easily accessible. |
rtxm
force-pushed
the
feature/sc-28389/documentation
branch
from
2cbe418 to
d49d8a2
Compare
✅ Deploy Preview for python-uhlive-sdk ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -3,14 +3,20 @@ | |||
| The Uh!live Python SDK provides convenient access to the Uh!live API from | |||
| applications written in the Python language. | |||
|
|
|||
| Read the [documentation for the Conversation API](https://docs.allo-media.net/live-api/) and [for the Recognition API (vocal bot toolkit)](https://docs.allo-media.net/stream-api-bots/). | |||
| Read the [full documentation](https://python-uhlive-sdk.netlify.app/). | |||
There was a problem hiding this comment.
you're just reviewing it as a netlify preview before deployment 😉 but I already put the definitive link in anticipation.
There was a problem hiding this comment.
We should create a DNS entry for this documentation. Something like https://docs.uh.live/sdk/python.
@shostelet I let you think about a proper structure for the URL
There was a problem hiding this comment.
Of course, I was not yet fully awake 😅
https://docs.uh.live/sdk/python suits me
There was a problem hiding this comment.
It must be a subdomain to work with Netlify, not a path @merwan
There was a problem hiding this comment.
Something like python-sdk-docs.uh.live ou python-sdk.uh.live
There was a problem hiding this comment.
We can use Netlify rewrite rules to setup such URL: https://docs.netlify.com/routing/redirects/rewrites-proxies/#proxy-to-another-netlify-site
I will try to setup https://docs.allo-media.net/sdk/python like this
| # user_password = "…" | ||
|
|
||
| auth_url, auth_params = build_authentication_request(uhlive_client, uhlive_secret) | ||
| # or auth_url, auth_params = build_authentication_request(uhlive_client, user_id=user_id, user_pwd=user_password) |
There was a problem hiding this comment.
this is the old auth way? shouldn't we get rid of it as it is deprecated?
There was a problem hiding this comment.
Why old? I'm not aware of any deprecation of letting users connect through a client in Keycloak. Did we abandon this way?
There was a problem hiding this comment.
both line 30 and 31 are KC connection? If so, ignore my comment
There was a problem hiding this comment.
both are KC connections indeed.
See Netlify preview.