-
Notifications
You must be signed in to change notification settings - Fork 86
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.
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
Add initial metadata registry #244
Merged
+103
−1
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
b27667d
Add initial metadata registry
DanielOaks f2372c1
Mark User Metadata as user metadata
DanielOaks f9ca3f2
Remove size requirement
DanielOaks db237bc
Review fixes
DanielOaks c0754bf
Update metadata registry a bit
DanielOaks 26e88e9
Update metadata_registry.yml
DanielOaks c883731
Fix the registry page header width
DanielOaks File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# User Metadata | ||
- name: User Metadata | ||
values: | ||
- key: avatar | ||
description: Avatar that graphical clients can show alongside the user's name | ||
format: URL with an optional `{size}` substitution denoting the size to load in pixels | ||
examples: https://example.com/avatar/16/asdf.jpg | ||
- key: bot | ||
description: >- | ||
Lets bot runners provide the name of their bot software. Setting this key | ||
identifies the client as a bot. | ||
format: Any string | ||
examples: |- | ||
PacketBot v1.2 | ||
JitiBot | ||
melo3 | ||
- key: display-name | ||
description: >- | ||
Alternative name to use instead of a nick for display purposes. Useful for gateways | ||
to chat services that allow spaces and other characters in nicks. A nick is | ||
required for standard protocol level stuff but can be less prominent in the UI. | ||
May contain emoji. | ||
format: Any string | ||
examples: |- | ||
James Wheare | ||
DanielOaks marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Posiden | ||
ダニエル | ||
Борис | ||
- key: homepage | ||
description: >- | ||
URL of a webpage that contains more information about the user/bot themselves, | ||
or bot software in use. | ||
format: Valid URL | ||
examples: |- | ||
https://example.com/bot-info.html | ||
- key: status | ||
description: Status text that can be shown for users without making them 'away' | ||
format: Any string | ||
examples: |- | ||
Working from home |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
root: | ||
type: listofdicts | ||
kids: | ||
name: | ||
type: string | ||
values: | ||
type: listofdicts | ||
kids: | ||
key: | ||
type: string | ||
format: | ||
type: string | ||
description: | ||
type: string | ||
examples: | ||
type: string | ||
specs: | ||
type: listofstrings | ||
required: false |
This file contains 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
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it height or width?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Original issue stated "square dimension" so both.