Skip to content

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.yaml by npm run gen, so do not edit it by hand. Authentication is described on the overview page.

POST/v1/versions/{id}/deprecateAdmin

Deprecate 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 ​

NameInTypeRequiredDescription
idpathstringyes

Body (application/json) ​

FieldTypeRequiredDescription
reasonstringReason (required when yanking); shown to users on the Portal and in Phillip

Responses ​

CodeDescriptionType
204Status changed
400Invalid inputapplication/problem+json · object
401Not signed inapplication/problem+json · object
403Forbiddenapplication/problem+json · object
404Not foundapplication/problem+json · object
409Invalid state transitionapplication/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"}'
POST/v1/versions/{id}/undeprecateAdmin

Restore a deprecated version

Moves a deprecated version back to published.

Parameters ​

NameInTypeRequiredDescription
idpathstringyes

Body (application/json) ​

FieldTypeRequiredDescription
reasonstringReason (required when yanking); shown to users on the Portal and in Phillip

Responses ​

CodeDescriptionType
204Status changed
400Invalid inputapplication/problem+json · object
401Not signed inapplication/problem+json · object
403Forbiddenapplication/problem+json · object
404Not foundapplication/problem+json · object
409Invalid state transitionapplication/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"}'
POST/v1/versions/{id}/yankAdmin

Yank 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 ​

NameInTypeRequiredDescription
idpathstringyes

Body (application/json) ​

FieldTypeRequiredDescription
reasonstringReason (required when yanking); shown to users on the Portal and in Phillip

Responses ​

CodeDescriptionType
204Status changed
400Invalid inputapplication/problem+json · object
401Not signed inapplication/problem+json · object
403Forbiddenapplication/problem+json · object
404Not foundapplication/problem+json · object
409Invalid state transitionapplication/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"}'