rip out API explorer and code snippets #199
Merged
Conversation
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
arcalinea
temporarily deployed
to
bnewbold/remove-api-explorer - bsky-docs PR #199
Render
Destroyed
matthieusieben
approved these changes
Oct 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is the "right hand column" on the HTTP API reference docs.
These snippets are great for devex in theory, but are currently often wrong and misleading for atproto+bsky APIs. Part of the problem is that different API requests need to be routed to different services (or possibly use service proxying headers to the user's PDS), and may require auth. Devs frequently hit "HTTP 405 Method Not Allowed" errors when trying to call endpoints against the wrong service backend. The confusion is not worth the upside for the small number of endpoints which do work correctly (eg, don't require auth, are against the
api.bsky.apphost specifically.The medium-term plan here is to have an atproto-specific Lexicon aggregation and docs site which can provide this kind of code snippet and live exploration functionality in a more protocol-native way, including snippets that use actual SDKs, and possibly even login with OAuth to make authenticated requests.
For now, ripping out this feature should reduce confusion. Pairs with #198, which adds docs about how to make requests.