chore: remove GraphQL API documentation, redirect user to API console#1386
Merged
chore: remove GraphQL API documentation, redirect user to API console#1386
Conversation
- Merge API Console and Documentation sections for better clarity - Improve text formatting with proper line breaks - Simplify documentation access instructions Amp-Thread-ID: https://ampcode.com/threads/T-f15773dd-bae2-4f44-8ced-0227fd2eb907
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
mmanela
approved these changes
Oct 22, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Our GraphQL API docs are severely outdated. They were originally introduced in https://github.com/sourcegraph/sourcegraph/commit/f97e8587f9eb8e4e56809e4ac372703a1124e1bd. Since then there have been only very minor changes.
The original HTML was generated using spectaql which does look cool but cannot be nicely integrated with this project's infrastructure. It would seem our options are:
I tried very hard to work on option (1) so that we may have something maintainable but to no luck. I did consider using some other tool or suggesting using separate web endpoint for GraphQL documentation but then I noticed another problem. The original documentation was only generated for
schema.graphql. When it's generated for all of our API the output is just humongous. It's not very easy to navigate using a sidebar like in case of the current UX.Therefore, I suggest we just go with option (2). As a follow-up I recommend we upgrade
graphiqldependency insourcegraph/sourcegraph.