Skip to content

Commit e61e4b3

Browse files
authored
chore: remove GraphQL API documentation, redirect user to API console (#1386)
Our GraphQL API docs are severely outdated and there is no clear way of generating them.
1 parent e67d163 commit e61e4b3

File tree

2 files changed

+11
-78123
lines changed

2 files changed

+11
-78123
lines changed

docs/api/graphql/index.mdx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,21 @@ For automated scripts, CI/CD pipelines, and production integrations, use [servic
4848

4949
## Documentation & tooling
5050

51-
### API Console
51+
### API Console and documentation
5252

53-
Sourcegraph includes a built-in API console that lets you write queries and view API documentation in your browser.
53+
Sourcegraph includes a built-in API console that lets you write queries and
54+
view API documentation in your browser.
5455

55-
You can find the API console at any time by going to **Settings**, and then clicking **API console** from the left sidebar, or by visiting it directly at `https://sourcegraph.example.com/api/console`.
56+
You can find the API console at any time by going to **Settings**, and then
57+
clicking **API console** from the left sidebar, or by visiting it directly at
58+
`https://sourcegraph.example.com/api/console`.
5659

57-
If you have not yet set up a Sourcegraph server, you can also test out the API on the [Sourcegraph.com API console](https://sourcegraph.com/api/console) (which always uses the latest version of the API).
60+
If you have not yet set up a Sourcegraph server, you can also test out the API
61+
on the [Sourcegraph.com API console](https://sourcegraph.com/api/console) (which
62+
always uses the latest version of the API).
5863

59-
### Documentation
60-
61-
Sourcegraph's GraphQL API documentation is available on the [API Docs](/api/graphql/api-docs) page, as well as directly in the API console itself. To access the documentation, click **Docs** on the right-hand side of the API console page.
64+
To access the documentation, click **Docs** on the right-hand side of the API
65+
console page.
6266

6367
### Search
6468

0 commit comments

Comments
 (0)