-
Notifications
You must be signed in to change notification settings - Fork 356
/
_update.md.erb
43 lines (33 loc) · 1.14 KB
/
_update.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
### Update a package
```
Example Request
```
```shell
curl "https://api.example.org/v3/packages/[guid]" \
-X PATCH \
-H "Authorization: bearer [token]" \
-H "Content-Type: application/json" \
-d '{ "metadata": { "labels": { "key": "value" }, "annotations": {"note": "detailed information"}}}'
```
```
Example Response
```
```http
HTTP/1.1 200 OK
Content-Type: application/json
<%= yield_content :single_bits_package, metadata: { labels: { "key" => "value" }, "annotations": {"note" => "detailed information"} } %>
```
#### Definition
`PATCH /v3/packages/:guid`
#### Optional parameters
Name | Type | Description
---- |-------------------------------------| -----------
**metadata.labels** | [_label object_](#labels) | Labels applied to the package
**metadata.annotations** | [_annotation object_](#annotations) | Annotations applied to the package
**username** | string | The username for the image’s registry. Only possible for Docker package.
**password** | string | The password for the image’s registry. Only possible for Docker package.
#### Permitted roles
|
--- | ---
Admin |
Space Developer |