API Tara: reviewing
Review resources (platform staff for the official catalog; organization owner or admin for the organization's private store)
This page is generated from
openapi.yamlbynpm run gen, so do not edit it by hand. Authentication is described on the overview page.
/v1/versions/{id}/deprecateAdminDeprecate a released version (reviewer of that store, or the creator of a community resource; via the Portal)
Hidden from the newest channel and default search; existing locks can still download it.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
reason | string | Reason (required when yanking); shown to users on the Portal and in Phillip |
Responses
| Code | Description | Type |
|---|---|---|
| 204 | Status changed | |
| 400 | Invalid input | application/problem+json · object |
| 401 | Not signed in | application/problem+json · object |
| 403 | Forbidden | application/problem+json · object |
| 404 | Not found | application/problem+json · object |
| 409 | Invalid state transition | application/problem+json · object |
Call with curl
bash
curl -X POST "https://tara.phillipcli.cloud/v1/versions/<id>/deprecate" \
-H "Authorization: Bearer $TARA_TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"string"}'/v1/versions/{id}/undeprecateAdminRestore a deprecated version
Moves a deprecated version back to published.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
reason | string | Reason (required when yanking); shown to users on the Portal and in Phillip |
Responses
| Code | Description | Type |
|---|---|---|
| 204 | Status changed | |
| 400 | Invalid input | application/problem+json · object |
| 401 | Not signed in | application/problem+json · object |
| 403 | Forbidden | application/problem+json · object |
| 404 | Not found | application/problem+json · object |
| 409 | Invalid state transition | application/problem+json · object |
Call with curl
bash
curl -X POST "https://tara.phillipcli.cloud/v1/versions/<id>/undeprecate" \
-H "Authorization: Bearer $TARA_TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"string"}'/v1/versions/{id}/yankAdminYank a version with a serious defect (reason required)
Still downloadable so existing locks do not break, but Phillip and the Portal show a warning. Cannot be restored; fix it with a new version.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
reason | string | Reason (required when yanking); shown to users on the Portal and in Phillip |
Responses
| Code | Description | Type |
|---|---|---|
| 204 | Status changed | |
| 400 | Invalid input | application/problem+json · object |
| 401 | Not signed in | application/problem+json · object |
| 403 | Forbidden | application/problem+json · object |
| 404 | Not found | application/problem+json · object |
| 409 | Invalid state transition | application/problem+json · object |
Call with curl
bash
curl -X POST "https://tara.phillipcli.cloud/v1/versions/<id>/yank" \
-H "Authorization: Bearer $TARA_TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"string"}'