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

Document the notification API. #3309

Open
endlisnis opened this issue Dec 31, 2024 · 0 comments
Open

Document the notification API. #3309

endlisnis opened this issue Dec 31, 2024 · 0 comments

Comments

@endlisnis
Copy link

Is your feature request related to a problem? Please describe.

I'm an experienced software developer, with prior experience implementing and using REST APIs, but I found it challenging to understand how to request notifications because most of the calls and parameters are effectively undocumented.

For example, https://atproto.blue/en/latest/atproto/atproto_client.models.app.bsky.notification.list_notifications.html#atproto_client.models.app.bsky.notification.list_notifications.Params
The "priority" parameter is just documented with the word "Priority". That explanation gives me no idea what it does.
The "seen_at" parameter is just documented with the words "Seen at". Does that filter the returned notifications? Or does that mark them as seen? Some explanation would be nice.

Describe the solution you'd like
All parameters to all functions should have an explanation that describes what it does, not just repeating it's name.

Describe alternatives you've considered
I tried asking on Reddit about the meanings, and someone suggested that "priority" was just a shortcut for specifying a list of "reasons" as filters, but even they didn't know what "seen_at" meant.

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

No branches or pull requests

1 participant