Skip to content

Document generated plugin user names - #13

Merged
gabek merged 3 commits into
mainfrom
gek/allow-null-displayname
Aug 5, 2026
Merged

Document generated plugin user names#13
gabek merged 3 commits into
mainfrom
gek/allow-null-displayname

Conversation

@gabek

@gabek gabek commented Aug 5, 2026

Copy link
Copy Markdown
Member

The SDK already omits displayName for its shorthand registration call, but its JavaScript type rejected an explicit null.

  • Allow displayName: null in the JavaScript request type.
  • Document that omitted or null names are generated by Owncast in both SDK references.
  • Clarify the equivalent Python display_name=None behavior.
  • Update the host runtime dependency so example CI can build against the matching Owncast branch.

Requires owncast/owncast#5112 for the host behavior.

$ node --check sdks/js/index.js
$ python3 -m py_compile sdks/python/owncast_plugin/__init__.py
$ GOTOOLCHAIN=go1.26.2 GOPROXY=off go test ./...
go test: 3 packages ok, 2 no tests

Copilot AI lite review requested due to automatic review settings August 5, 2026 01:29

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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: null in the JavaScript UserRegisterRequest type.
  • Document in the wire protocol and author guide that omitted/null displayName causes Owncast to generate a name.
  • Update the Python SDK docstring for users.register to describe generated-name behavior when display_name is 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.

Comment thread docs/PLUGIN_AUTHOR_GUIDE.md
Comment thread sdks/python/owncast_plugin/__init__.py Outdated
@gabek
gabek merged commit 5704a8c into main Aug 5, 2026
73 checks passed
@gabek
gabek deleted the gek/allow-null-displayname branch August 5, 2026 06:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants