GitLab repository and access

Defines the setup and access settings for GitLab integration, including installation details and collaborator permissions.

Properties

Name	Type	Description	Required
setup	object	Initial setup details for GitLab integration, including installation URL, authentication, and default repository settings.	yes
access (Default Collaborators)	object	Defines the default access levels for collaborators within repositories.	no

Additional Properties: not allowed
Example

{
    "setup": {
        "topics": [
            "web",
            "api",
            "backend"
        ],
        "group_path": "my-organization/my-group",
        "access_token": "glpat-XXXXXXXXXXXXXXXXXXXXX",
        "installation_url": "https://gitlab.com"
    },
    "access": {
        "default_collaborators": [
            {
                "id": "np-pilundain",
                "role": "developer",
                "type": "user"
            },
            {
                "id": "wallet",
                "role": "developer",
                "type": "group"
            }
        ]
    }
}

setup: Setup

Initial setup details for GitLab integration, including installation URL, authentication, and default repository settings.

Properties

Name	Type	Description	Required
topics (Default Topics)	string[]	Default list of topics/tags that will be automatically applied to new repositories.	no
group_path	string	The complete path to your GitLab group, including any parent groups. Minimal Length: 1 Pattern: ^[\w.-]+(?:/[\w.-]+)*$	no
access_token	string	The GitLab personal access token or project access token with appropriate permissions. Minimal Length: 20	yes
installation_url	string	The base URL of your GitLab installation. Defaults to GitLab SaaS (gitlab.com). Minimal Length: 1 Pattern: ^https?://[\w.-]+(?::\d+)?$	yes

Additional Properties: not allowed
Example

{
    "topics": [
        "web",
        "api",
        "backend"
    ],
    "group_path": "my-organization/my-group",
    "access_token": "glpat-XXXXXXXXXXXXXXXXXXXXX",
    "installation_url": "https://gitlab.com"
}

setup.topics[]: Default Topics

Default list of topics/tags that will be automatically applied to new repositories.

Items

Item Type: string
Item Maximal Length: 100
Item Pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
Example

[
    "web",
    "api",
    "backend"
]

access: Default Collaborators

Defines the default access levels for collaborators within repositories.

Properties

Name	Type	Description	Required
default_collaborators (Collaborators)	object[]	List of collaborators and their corresponding access levels.	no

Additional Properties: not allowed
Example

{
    "default_collaborators": [
        {
            "id": "np-pilundain",
            "role": "developer",
            "type": "user"
        },
        {
            "id": "wallet",
            "role": "developer",
            "type": "group"
        }
    ]
}

access.default_collaborators[]: Collaborators

List of collaborators and their corresponding access levels.

Items

Item Properties

Name	Type	Description	Required
id (Name)	string	GitLab username or group name Minimal Length: 1 Pattern: ^[a-zA-Z][a-zA-Z0-9_.-]*$	yes
role (Permission Level)	string	Access level for the member or group Enum: "no access", "minimal access", "guest", "reporter", "developer", "maintainer", "owner"	yes
type (Collaborator Type)	string	Type of collaborator Enum: "user", "group"	yes

Item Additional Properties: not allowed
Example

[
    {
        "id": "np-pilundain",
        "role": "developer",
        "type": "user"
    },
    {
        "id": "wallet",
        "role": "developer",
        "type": "group"
    }
]