Skip to content

Commit 4dbe757

Browse files
authored
dbeaver/pro#5700 rewrite the root README
1 parent 4a26d06 commit 4dbe757

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,11 @@
22

33
This repo contains examples of using GraphQL API for [CloudBeaver Enterprise](https://dbeaver.com/cloudbeaver-enterprise/), [CloudBeaver AWS](https://aws.amazon.com/marketplace/pp/prodview-kijugxnqada5i), and [DBeaver Team Edition](https://dbeaver.com/dbeaver-team-edition/).
44

5-
# The repo layout
5+
CloudBeaver and Team Edition communicate with their web browser frontends by exposing a GraphQL API. In some cases, users may want to leverage the same API to enable advanced use cases by automating certain operations usually done using UI. To explore the API, you can [use an embedded GraphiQL console](https://github.com/dbeaver/cloudbeaver/wiki/Server-API-explorer). You can look at the real examples of using the API in this repository.
6+
7+
## The repo layout
68

79
- The [curl](curl) folder contains examples using `curl` command line tool.
810
- The [go](go) folder contains examples for the Go programming language.
911
- The [operations](operations) folder contains raw examples. They are used by projects from other folders.
1012
- The [python3](python3) includes examples for Python 3.
11-
12-
## GraphQL API and prerequsites
13-
14-
- You have to have CloudBeaver or Team Edition server running somewhere in you network
15-
- In order to use examples you need to create API token in you user profile
16-
- Configure environment with the server endpoint and the API token above
17-
- To explore GraphQL API you can use GraphQL console which comes with CloudBeaver server at the endpoint `https://SERVER-ADDRESS/api/gql/console`

0 commit comments

Comments
 (0)