graphql to search for all components

Question

Hi All,

I am looking for some examples on using the graphql api to search for components. I probably can push my way through, but if there are examples available, it would accelerate my efforts.

I am specifically looking to create the following queries:

* Return all components
* Return component by name

Thank you

Forged Apps · Answer

To retrieve all components you can use an empty object as the query, so `query: {}` as in:

query example {
  compass {
    searchComponents(cloudId: "", query:{}) {
      ... on CompassSearchComponentConnection {
        nodes {
          link
          component {
            name
            description
            typeId
            ownerId
            links {
              id
              type
              name
              url
            }
            labels {
              name
            }
          }
        }
        pageInfo {
          hasNextPage
          endCursor
        }
      }
      ... on QueryError {
        message
        extensions {
          statusCode
          errorType
        }
      }
    }
  }
}

Pavel Shkleinik · Answer

There is a series of articles describing in detail how to authenticate and query Compass GQL API:

* https://community.atlassian.com/t5/Compass-articles/Using-the-Compass-API-Authentication/ba-p/2283266
* https://community.atlassian.com/t5/Compass-articles/Using-the-Compass-API-GraphQL-Samples/ba-p/2290599
* https://community.atlassian.com/t5/Compass-articles/Using-the-Compass-API-Customize-GraphQL-samples/ba-p/2298895

once you read/watch these articles you should be able to run queries like: https://github.com/atlassian-labs/compass-examples/tree/main/snippets/graphql/search-components.