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

RESTCapabilities undocumented #610

Open
m-mohr opened this issue Aug 28, 2024 · 2 comments
Open

RESTCapabilities undocumented #610

m-mohr opened this issue Aug 28, 2024 · 2 comments

Comments

@m-mohr
Copy link
Member

m-mohr commented Aug 28, 2024

I'm looking at the Python client docs (HTML) and found the capabilities() method, which returns RESTCapabilities.
RESTCapabilities is not documented, search doesn't find it.
How can it be used? Documentation should be added.

Looking at the code reveals how to use it, e.g. con.capabilities().get("federation") but it's not clear from the docs.

@soxofaan
Copy link
Member

Indeed RESTCapabilities is not yet included in the docs

In principle it's not hard to add, but I'm bit hesitant to do that at the moment because I'm not really happy with the code architecture around it (and I don't want to over-promise that this is a public API yet).
This is one of the leftovers of the 2018-ish initial design of the package, where you have an abstract Capabilities and a REST-specific implementation RESTCapabilities, but I don't see the point of this inheritance/abstraction.
I'd first want to merge these two classes to a single Capabilities class and make that the public API.

Is this an important/urgent thing for you, or you managed to workaround it and just wanted to signal the bad state of the docs?

@m-mohr
Copy link
Member Author

m-mohr commented Aug 29, 2024

Just a signal for now.
Came across it when evaluating the compliance of the clients with the Federation Extension:
https://docs.google.com/spreadsheets/d/1GWn53_bLivjLnC-qIGk1rm8GEvCzOesMPKh92E99xL4/edit?usp=sharing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants