gitlabnet package - gitlab.com/gitlab-org/gitlab-shell/v14/internal/gitlabnet

Documentation ¶

Overview ¶

Package gitlabnet provides client utilities for interacting with GitLab's internal API.

Index ¶

func GetClient(config *config.Config) (*client.GitlabNetClient, error)
func ParseIP(remoteAddr string) string
func ParseJSON(hr *http.Response, response interface{}) error
type GlID
- func ParseGlID(glID string) (*GlID, error)
- func (g *GlID) DeployTokenID() (int, bool)
- func (g *GlID) UserID() (int, bool)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetClient ¶

func GetClient(config *config.Config) (*client.GitlabNetClient, error)

GetClient creates and returns a new GitlabNetClient configured with the provided settings.

func ParseIP ¶

func ParseIP(remoteAddr string) string

ParseIP extracts and returns the IP address from a remote address string. It handles both plain IP addresses and host:port combinations.

func ParseJSON ¶

func ParseJSON(hr *http.Response, response interface{}) error

ParseJSON decodes JSON from an HTTP response into the provided response interface.

Types ¶

type GlID ¶ added in v14.50.0

type GlID struct {
	// contains filtered or unexported fields
}

GlID represents a parsed GitLab gl_id identifier. Use UserID() or DeployTokenID() to extract the typed value.

func ParseGlID ¶ added in v14.50.0

func ParseGlID(glID string) (*GlID, error)

ParseGlID parses a GitLab gl_id string into its typed representation.

Known gl_id formats (see https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/gl_id.rb):

"user-<N>" → UserID() returns (N, true)
"deploy-token-<N>" → DeployTokenID() returns (N, true)

Returns an error for unrecognized or malformed formats.

func (*GlID) DeployTokenID ¶ added in v14.50.0

func (g *GlID) DeployTokenID() (int, bool)

DeployTokenID returns the numeric deploy token ID and true if the gl_id represents a deploy token.

func (*GlID) UserID ¶ added in v14.50.0

func (g *GlID) UserID() (int, bool)

UserID returns the numeric user ID and true if the gl_id represents a user.

Source Files ¶

View all Source files

client.go

Directories ¶

Path	Synopsis
accessverifier Package accessverifier provides functionality for verifying access to GitLab resources	Package accessverifier provides functionality for verifying access to GitLab resources
authorizedcerts Package authorizedcerts implements functions for authorizing users with ssh certificates	Package authorizedcerts implements functions for authorizing users with ssh certificates
authorizedkeys Package authorizedkeys provides functionality for interacting with authorized keys.	Package authorizedkeys provides functionality for interacting with authorized keys.
discover Package discover provides functionality for discovering GitLab users	Package discover provides functionality for discovering GitLab users
git Package git provides functionality for interacting with Git repositories.	Package git provides functionality for interacting with Git repositories.
gitauditevent Package gitauditevent handles Git audit events for GitLab.	Package gitauditevent handles Git audit events for GitLab.
healthcheck Package healthcheck implements a HTTP client to request healthcheck endpoint	Package healthcheck implements a HTTP client to request healthcheck endpoint
lfsauthenticate Package lfsauthenticate provides functionality for authenticating Large File Storage (LFS) requests	Package lfsauthenticate provides functionality for authenticating Large File Storage (LFS) requests
lfstransfer Package lfstransfer provides functionality for handling LFS (Large File Storage) transfers.	Package lfstransfer provides functionality for handling LFS (Large File Storage) transfers.
personalaccesstoken Package personalaccesstoken provides functionality for managing personal access tokens	Package personalaccesstoken provides functionality for managing personal access tokens
twofactorrecover Package twofactorrecover provides functionality for interacting with GitLab Two-Factor Authentication recovery codes	Package twofactorrecover provides functionality for interacting with GitLab Two-Factor Authentication recovery codes
twofactorverify Package twofactorverify provides functionality for verifying two-factor authentication in GitLab.	Package twofactorverify provides functionality for verifying two-factor authentication in GitLab.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL