Skip to main content

topics

Gets or lists a topics resource.

Overview​

Nametopics
TypeResource
Idgitlab.projects.topics

Fields​

The following fields are returned by SELECT queries:

GraphQL response envelope

NameDatatypeDescription
idstringID of the topic.
namestringName of the topic.
avatar_urlstringURL to avatar image file of the topic.
descriptionstringDescription of the topic.
titlestringTitle of the topic.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselecthostsearchFind 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.

NameDatatypeDescription
hoststringGitLab 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)

SELECT examples​

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 }}'
;