Module gitlab::api

API endpoint structures

The types in this module are meant to aid in constructing the appropriate calls using type-safe Rust idioms.

All endpoints use the builder pattern and have their members as private so that there are no API implications of adding new members for additional query parameters in future GitLab releases.

Modules

common	API types common to many endpoints.
endpoint_prelude	Endpoint prelude
groups	Group-related API endpoints
projects	Project-related API endpoints
users	User-related API endpoints

Structs

Ignore	A query modifier that ignores the data returned from an endpoint.
Paged	A query modifier that paginates an endpoint.
Raw	A query modifier that returns the raw data from the endpoint.
Sudo	Query information about the API calling user.
SudoContext	A sudo modifier that can be applied to any endpoint.

Enums

ApiError	Errors which may occur when using API endpoints.
LinkHeaderParseError	An error which can occur when parsing a link header.
Pagination	Pagination options for GitLab.
PaginationError	Errors which may occur with pagination.

Traits

Client	A trait representing a client which can communicate with a GitLab instance.
Endpoint	A trait for providing the necessary information for a single REST API endpoint.
Pageable	A trait to indicate that an endpoint is pageable.
Query	A trait which represents a query which may be made to a GitLab client.

Functions

ignore	Ignore the resulting data from an endpoint.
paged	Collect data from a paged endpoint.
raw	Return the raw data from the endpoint.
sudo	Create a sudo-elevated version of an endpoint.

Type Definitions

Pairs

A type for managing query parameters.