topics
Gets or lists a topics resource.
Overview​
| Name | topics |
| Type | Resource |
| Id | gitlab.projects.topics |
Fields​
The following fields are returned by SELECT queries:
- list
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
id | string | ID of the topic. |
name | string | Name of the topic. |
avatar_url | string | URL to avatar image file of the topic. |
description | string | Description of the topic. |
title | string | Title of the topic. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | host | search | Find project topics. Generated from the GitLab GraphQL schema field Query.topics (connection of Topic nodes). |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
host | string | GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST) |
search | string | Search query for topic name. |
SELECT examples​
- list
Find project topics. Generated from the GitLab GraphQL schema field Query.topics (connection of Topic nodes).
SELECT
id,
name,
avatar_url,
description,
title
FROM gitlab.projects.topics
WHERE host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND search = '{{ search }}'
;