Gitlab API

This library implements an interface to communicate with a Gitlab instance. Not all API endpoints are implemented, but patches are welcome.

The API is based off of the GitLab 17.5 API v4 and will likely aggressively track new API additions, so not all available parameters or types will support arbitrarily old GitLab instances (usually query parameters will be ignored and type fields cause deserialization errors).

For guidelines on contributions, see CONTRIBUTING.md.

The endpoints that are supported all live under the api module. Each endpoint may be constructed using a "builder" pattern to provide supported fields. To use an endpoint, you may query it using the Query trait. There are additional helpers to handle different cases:

• api::ignore: Ignore the GitLab response (useful for POST or PUT endpoints).
• api::paged: Fetch results that are paginated.
• api::raw: Return the raw data from GitLab instead of deserializing into a structure.
• api::sudo: Modify an endpoint using GitLab's sudo parameter for masquerading as another user (requires an administrator token).

All endpoints return data types of the caller's choosing that implement serde's Deserialize trait. Callers should define their own structures for obtaining data from the API. This allows the structure to be more easily changeable for different GitLab versions (rather than this crate being pinned to a given version).

Versioning

Since this crate follows Gitlab upstream, semantic versioning may not be possible. Instead, the crate uses the following versioning scheme:

• Gitlab 17.5 support → 0.1705.x
• Gitlab 17.4 support → 0.1704.x
• Gitlab 17.3 support → 0.1703.x
• Gitlab 17.2 support → 0.1702.x
• Gitlab 17.1 support → 0.1701.x
• Gitlab 17.0 support → 0.1700.x
• Gitlab 16.11 support → 0.1611.x
• Gitlab 16.10 support → 0.1610.x
• Gitlab 16.9 support → 0.1609.x
• Gitlab 16.8 support → 0.1608.x
• Gitlab 16.7 support → 0.1607.x
• Gitlab 16.6 support → 0.1606.x
• Gitlab 16.5 support → 0.1605.x
• Gitlab 16.4 support → 0.1604.x
• Gitlab 16.3 support → 0.1603.x
• Gitlab 16.2 support → 0.1602.x
• Gitlab 16.1 support → 0.1601.x
• Gitlab 16.0 support → 0.1600.x
• Gitlab 15.11 support → 0.1511.x
• Gitlab 15.10 support → 0.1510.x
• Gitlab 15.9 support → 0.1509.x
• Gitlab 15.8 support → 0.1508.x
• Gitlab 15.7 support → 0.1507.x
• Gitlab 15.6 support → 0.1506.x
• Gitlab 15.5 support → 0.1505.x
• Gitlab 15.4 support → 0.1504.x
• Gitlab 15.3 support → 0.1503.x
• Gitlab 15.2 support → 0.1502.x
• Gitlab 15.1 support → 0.1501.x
• Gitlab 15.0 support → 0.1500.x
• Gitlab 14.10 support → 0.1410.x
• Gitlab 14.9 support → 0.1409.x
• Gitlab 14.8 support → 0.1408.x
• Gitlab 14.7 support → 0.1407.x
• Gitlab 14.6 support → 0.1406.x
• Gitlab 14.5 support → 0.1405.x
• Gitlab 14.4 support → 0.1404.x
• Gitlab 14.3 support → 0.1403.x
• Gitlab 14.2 support → 0.1402.x
• Gitlab 14.1 support → 0.1401.x
• Gitlab 14.0 support → 0.1400.x
• Gitlab 13.12 support → 0.1312.x
• Gitlab 13.11 support → 0.1311.x
• Gitlab 13.10 support → 0.1310.x
• Gitlab 13.9 support → 0.1309.x
• Gitlab 13.8 support → 0.1308.x
• Gitlab 13.7 support → 0.1307.x
• Gitlab 13.6 support → 0.1306.x
• Gitlab 13.5 support → 0.1305.x
• Gitlab 13.4 support → 0.1304.x
• Gitlab 13.3 support → 0.1303.x
• Gitlab 13.2 support → 0.1302.x
• Gitlab 13.1 support → 0.1301.x
• Gitlab 13.0 support → 0.1300.x
• Gitlab 12.10 support → 0.1210.x
• Gitlab 12.9 support → 0.1209.x
• Gitlab 12.8 support → 0.1208.x
• Gitlab 12.7 support → 0.1207.x
• Gitlab 12.6 support → 0.1206.x
• Gitlab 12.5 support → 0.1205.x
• Gitlab 12.4 support → 0.1204.x
• Gitlab 12.3 support → 0.1203.x
• Gitlab 12.2 support → 0.1202.x
• Gitlab 12.1 support → 0.1201.x
• Gitlab 12.0 support → 0.1200.x
• Gitlab 11.11 support → 0.1111.x
• Gitlab 11.10 support → 0.1110.x
• Gitlab 11.9 support → 0.1109.x
• Gitlab 11.8 support → 0.1108.x
• Gitlab 11.7 support → 0.1107.x
• Gitlab 11.6 support → 0.1106.x
• Gitlab 11.5 support → 0.1105.x
• Gitlab 11.4 support → 0.1104.x
• Gitlab 11.3 support → 0.1103.x
• Gitlab 11.2 support → 0.1102.x
• Gitlab 11.1 support → 0.1101.x
• Gitlab 11.0 support → 0.1100.x
• Gitlab 10.8 support → 0.1008.x
• Gitlab 10.7 support → 0.1007.x
• Gitlab 10.6 support → 0.1006.x
• Gitlab 10.5 support → 0.1005.x
• Gitlab 10.4 support → 0.1004.x
• Gitlab 10.3 support → 0.1003.x
• Gitlab 10.2 support → 0.1002.x
• Gitlab 10.1 support → 0.1001.x
• Gitlab 10.0 support → 0.1000.x
• Gitlab 9.5 support → 0.905.x
• Gitlab 9.4 support → 0.904.x
• Gitlab 9.3 support → 0.903.x
• Gitlab 9.2 support → 0.902.x
• Gitlab 9.1 support → 0.901.x
• Gitlab 9.0 support → 0.900.x
• Gitlab 8.17 support → 0.817.x
• Gitlab 8.16 support → 0.816.x

Minor versions may fix bugs, add API endpoint bindings, or improve webhook coverage. It is recommended to depend on the full version of the crate since types may change in patch-level updates in order to match Gitlab's interface:

gitlab = "=0.1705.0"

API bugs

Sometimes, the API will return null for fields that have been added after the entry was created. In these cases, mark the field as an Option with a comment describing why it is so.