diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-08-05 21:09:40 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-08-05 21:09:40 +0000 |
| commit | ad9eb72915f1be40da3ebe287274fe2bae62e46b (patch) | |
| tree | e5a029b2edbce0e84a54b6ff4d18e8240680c4c4 /doc/api/graphql/sample_issue_boards.md | |
| parent | f8d20b20be74c283fe8bfe81abfd2d132a500968 (diff) | |
| download | gitlab-ce-ad9eb72915f1be40da3ebe287274fe2bae62e46b.tar.gz | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/graphql/sample_issue_boards.md')
| -rw-r--r-- | doc/api/graphql/sample_issue_boards.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/api/graphql/sample_issue_boards.md b/doc/api/graphql/sample_issue_boards.md new file mode 100644 index 00000000000..4ac9317b01a --- /dev/null +++ b/doc/api/graphql/sample_issue_boards.md @@ -0,0 +1,44 @@ +# Identify issue boards with GraphQL + +This page describes how you can use the GraphiQL explorer to identify +existing issue boards in the `gitlab-docs` documentation repository. + +## Set up the GraphiQL explorer + +This procedure presents a substantive example that you can copy and paste into your own +instance of the [GraphiQL explorer](https://gitlab.com/-/graphql-explorer): + +1. Copy the following code excerpt: + + ```graphql + query { + project(fullPath: "gitlab-org/gitlab-docs") { + name + forksCount + statistics { + wikiSize + } + issuesEnabled + boards { + nodes { + id + name + } + } + } + } + ``` + +1. Open the [GraphiQL Explorer](https://gitlab.com/-/graphql-explorer) page. +1. Paste the `query` listed above into the left window of your GraphiQL explorer tool. +1. Click Play to get the result shown here: + + + +If you want to view one of these boards, take one of the numeric identifiers shown in the output. From the screenshot, the first identifier is `105011`. Navigate to the following URL, which includes the identifier: + +```markdown +https://gitlab.com/gitlab-org/gitlab-docs/-/boards/105011 +``` + +For more information on each attribute, see the [GraphQL API Resources](reference/index.md). |