debian-mirror-gitlab/doc/api/project_badges.md

208 lines
6.8 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
stage: Create
group: Source Code
2022-03-02 08:16:31 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-10-24 23:57:45 +05:30
---
2021-03-11 19:13:27 +05:30
# Project badges API **(FREE)**
2018-03-27 19:54:05 +05:30
## Placeholder tokens
2022-01-26 12:08:38 +05:30
Badges support placeholders that are replaced in real-time in both the link and image URL. The allowed placeholders are:
2018-03-27 19:54:05 +05:30
2021-03-11 19:13:27 +05:30
<!-- vale gitlab.Spelling = NO -->
2021-04-17 20:07:23 +05:30
- **%{project_path}**: Replaced by the project path.
- **%{project_id}**: Replaced by the project ID.
- **%{default_branch}**: Replaced by the project default branch.
- **%{commit_sha}**: Replaced by the last project's commit SHA.
2018-03-27 19:54:05 +05:30
2021-03-11 19:13:27 +05:30
<!-- vale gitlab.Spelling = YES -->
2021-10-27 15:23:28 +05:30
2018-03-27 19:54:05 +05:30
## List all badges of a project
Gets a list of a project's badges and its group badges.
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-27 19:54:05 +05:30
GET /projects/:id/badges
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2020-01-01 13:55:28 +05:30
| `name` | string | no | Name of the badges to return (case-sensitive). |
2018-03-27 19:54:05 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges"
2018-03-27 19:54:05 +05:30
```
Example response:
```json
[
{
2020-01-01 13:55:28 +05:30
"name": "Coverage",
2018-03-27 19:54:05 +05:30
"id": 1,
"link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
"image_url": "https://shields.io/my/badge",
"rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
"rendered_image_url": "https://shields.io/my/badge",
"kind": "project"
},
{
2020-01-01 13:55:28 +05:30
"name": "Pipeline",
2018-03-27 19:54:05 +05:30
"id": 2,
"link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
"image_url": "https://shields.io/my/badge",
"rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
"rendered_image_url": "https://shields.io/my/badge",
"kind": "group"
2021-06-08 01:23:25 +05:30
}
2018-03-27 19:54:05 +05:30
]
```
## Get a badge of a project
Gets a badge of a project.
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-27 19:54:05 +05:30
GET /projects/:id/badges/:badge_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2018-03-27 19:54:05 +05:30
| `badge_id` | integer | yes | The badge ID |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"
2018-03-27 19:54:05 +05:30
```
Example response:
```json
{
"id": 1,
"link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
"image_url": "https://shields.io/my/badge",
"rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
"rendered_image_url": "https://shields.io/my/badge",
"kind": "project"
}
```
## Add a badge to a project
Adds a badge to a project.
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-27 19:54:05 +05:30
POST /projects/:id/badges
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2018-03-27 19:54:05 +05:30
| `link_url` | string | yes | URL of the badge link |
| `image_url` | string | yes | URL of the badge image |
2021-03-11 19:13:27 +05:30
| `name` | string | no | Name of the badge |
2018-03-27 19:54:05 +05:30
2020-03-13 15:44:24 +05:30
```shell
2021-09-04 01:27:46 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--data "link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&name=mybadge" \
"https://gitlab.example.com/api/v4/projects/:id/badges"
2018-03-27 19:54:05 +05:30
```
Example response:
```json
{
"id": 1,
2021-03-11 19:13:27 +05:30
"name": "mybadge",
2019-12-04 20:38:33 +05:30
"link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",
2018-03-27 19:54:05 +05:30
"image_url": "https://shields.io/my/badge1",
2019-12-04 20:38:33 +05:30
"rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",
2018-03-27 19:54:05 +05:30
"rendered_image_url": "https://shields.io/my/badge1",
"kind": "project"
}
```
## Edit a badge of a project
Updates a badge of a project.
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-27 19:54:05 +05:30
PUT /projects/:id/badges/:badge_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2018-03-27 19:54:05 +05:30
| `badge_id` | integer | yes | The badge ID |
| `link_url` | string | no | URL of the badge link |
| `image_url` | string | no | URL of the badge image |
2021-03-11 19:13:27 +05:30
| `name` | string | no | Name of the badge |
2018-03-27 19:54:05 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"
2018-03-27 19:54:05 +05:30
```
Example response:
```json
{
"id": 1,
2021-03-11 19:13:27 +05:30
"name": "mybadge",
2019-12-04 20:38:33 +05:30
"link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",
2018-03-27 19:54:05 +05:30
"image_url": "https://shields.io/my/badge",
2019-12-04 20:38:33 +05:30
"rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",
2018-03-27 19:54:05 +05:30
"rendered_image_url": "https://shields.io/my/badge",
"kind": "project"
}
```
## Remove a badge from a project
2021-04-17 20:07:23 +05:30
Removes a badge from a project. Only project badges are removed by using this endpoint.
2018-03-27 19:54:05 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-27 19:54:05 +05:30
DELETE /projects/:id/badges/:badge_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2018-03-27 19:54:05 +05:30
| `badge_id` | integer | yes | The badge ID |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"
2018-03-27 19:54:05 +05:30
```
## Preview a badge from a project
Returns how the `link_url` and `image_url` final URLs would be after resolving the placeholder interpolation.
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-27 19:54:05 +05:30
GET /projects/:id/badges/render
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2018-03-27 19:54:05 +05:30
| `link_url` | string | yes | URL of the badge link|
| `image_url` | string | yes | URL of the badge image |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/render?link_url=http%3A%2F%2Fexample.com%2Fci_status.svg%3Fproject%3D%25%7Bproject_path%7D%26ref%3D%25%7Bdefault_branch%7D&image_url=https%3A%2F%2Fshields.io%2Fmy%2Fbadge"
2018-03-27 19:54:05 +05:30
```
Example response:
```json
2018-05-09 12:01:36 +05:30
{
2018-03-27 19:54:05 +05:30
"link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
"image_url": "https://shields.io/my/badge",
"rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
2021-06-08 01:23:25 +05:30
"rendered_image_url": "https://shields.io/my/badge"
2018-03-27 19:54:05 +05:30
}
```