Document generated plugin user names - #13
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the SDK documentation and JavaScript typings to explicitly support generated user display names when displayName/display_name is omitted (and, for JS/wire protocol, when it is null). This aligns SDK references with the host behavior described in the PR description.
Changes:
- Allow
displayName: nullin the JavaScriptUserRegisterRequesttype. - Document in the wire protocol and author guide that omitted/
nulldisplayNamecauses Owncast to generate a name. - Update the Python SDK docstring for
users.registerto describe generated-name behavior whendisplay_nameis omitted.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
sdks/python/owncast_plugin/__init__.py |
Updates users.register docstring to describe generated names when display_name is omitted. |
sdks/js/index.d.ts |
Expands UserRegisterRequest.displayName to `string |
docs/WIRE_PROTOCOL.md |
Documents displayName as optional+nullable and updates UserRegisterRequest type accordingly. |
docs/PLUGIN_AUTHOR_GUIDE.md |
Adds narrative documentation that displayName may be omitted or null to generate a name. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The SDK already omits
displayNamefor its shorthand registration call, but its JavaScript type rejected an explicitnull.displayName: nullin the JavaScript request type.display_name=Nonebehavior.Requires owncast/owncast#5112 for the host behavior.