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

no record schema in the docs #120

Open
yamarten opened this issue Apr 14, 2024 · 2 comments
Open

no record schema in the docs #120

yamarten opened this issue Apr 14, 2024 · 2 comments

Comments

@yamarten
Copy link

Since there is no type definition for record in the API reference, important usage of the API is unclear.
In particular, there is a concern that developers who do not use the official SDK will not be able to find a way to follow or like.

@bnewbold
Copy link
Contributor

If I understand correctly, you are pointing out that record schemas don't end up in the docs.bsky.app HTTP reference: https://docs.bsky.app/docs/category/http-reference

The current location for those schemas, in machine-readable Lexicon language format (JSON) is in git: https://github.com/bluesky-social/atproto/tree/main/lexicons

at least for the app.bsky, tools.ozone, and com.atproto namespaces.

We'd love to get these included in docs.bsky.app, but haven't figured out a way to get the lexicon-to-openapi-to-docusaurus pipeline to get them to render.

@yamarten
Copy link
Author

Yes, your understanding is correct.

Developers who have not read the atproto specification do not know enough about the concept of record and how to read lexicon, so they try to look for follow API in the HTTP reference.

Unfortunately, I don't have a solution to the pipeline problem. How about manually adding a list of links to the main record definitions on github as a first aid?

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

2 participants