Skip to content
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

Update 2.2 schema to support atprotocol protocol and record usage #100

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ngerakines
Copy link

This PR introduces two changes to the 2.2 schema to support atprotocol nodes.

The atprotocol enum was introduced to allow ATProtocol Data Repositories to announce themselves using GET /.well-known/nodeinfo.

The usage structure was updated to include the records object which is a string to integer key/value pair object for reporting collection statistics. Within ATProtocol, namespaced identifiers are used to identify collections of records. This structure allows personal data server (PDS) instances to self-report the number of records it contains across all repositories (account) across collections.

@snarfed
Copy link

snarfed commented Sep 11, 2024

Yes! Great idea and contribution. Bridgy Fed added bluesky to its nodeinfo protocol list back in Feb, snarfed/bridgy-fed@c68e066#diff-8173c603aa47f9de9ea5c1296ee31a82dcc44d8e7ca16a4b420cfc4517c6503dR283, and then later changed it to atproto. I'll change it to atprotocol now to match this PR.

"minProperties": 0,
"additionalProperties": { "type": "integer", "minimum": 0 },
"properties": {
"app.bsky.feed.post": {
Copy link

Choose a reason for hiding this comment

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

Hmm! This sounds the same as localPosts, right? Seems like it'd maybe be better to keep all of these stats protocol-independent and unified...? I know that means we might not get as much nuance about each specific protocol, but the goal here probably isn't to be comprehensive or exhaustive anyway.

Copy link
Author

Choose a reason for hiding this comment

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

Maybe this denotes a 2.3 change, but I think limiting metrics to just post types should be deprecated. It's time to push for an expanded and more generic record-type container.

Copy link

Choose a reason for hiding this comment

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

Sure! More metrics sounds great, and I'm with you that ideally they should be generic, like you mention, instead of protocol-specific like this.

snarfed added a commit to snarfed/bridgy-fed that referenced this pull request Sep 11, 2024
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