project_path_locks

Gets or lists a project_path_locks resource.

Overview

Name	project_path_locks
Type	Resource
Id	gitlab.projects.project_path_locks

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the path lock.
path	string	Locked path.
user	object	UserCore identity (id, username, name)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host		The project's path locks. Generated from the GitLab GraphQL schema field Project.pathLocks (connection of PathLock 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
full_path	string	Full path of the project, for example gitlab-org/gitlab
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)

SELECT examples

list

The project's path locks. Generated from the GitLab GraphQL schema field Project.pathLocks (connection of PathLock nodes).

SELECT
id,
path,
user
FROM gitlab.projects.project_path_locks
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;