gitlab-org--gitlab-foss/doc/api/graphql/sample_issue_boards.md

1.5 KiB

stage group info
none unassigned To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

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:

  1. Copy the following code excerpt:

    query {
      project(fullPath: "gitlab-org/gitlab-docs") {
        name
        forksCount
        statistics {
          wikiSize
        }
        issuesEnabled
        boards {
          nodes {
            id
            name
          }
        }
      }
    }
    
  2. Open the GraphiQL Explorer page.

  3. Paste the query listed above into the left window of your GraphiQL explorer tool.

  4. Click Play to get the result shown here:

GraphiQL explorer search for boards

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:

https://gitlab.com/gitlab-org/gitlab-docs/-/boards/105011

For more information on each attribute, see the GraphQL API Resources.