Rename a shelf

Renames an existing shelf by updating its name.

Parameters:

• shelf_name (required) - will be stripped of whitespace

Requirements: Requires WRITE access to the repository.

Returns:

• 400 Bad Request if the name is empty after stripping
• 409 Conflict if a shelf with the new name already exists
• 204 No Content on success

PATCH /repos/{repo_id}/shelves/{shelf_id}

Rename a shelf

cURL

curl --request PATCH \
  --url https://api.diversion.dev/v0/repos/{repo_id}/shelves/{shelf_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shelf_name": "<string>"
}
'

400

{
  "status": 123,
  "detail": "<string>",
  "title": "<string>",
  "type": "<string>"
}

Authorizations

Authorization · string · header · required

This API uses OAuth 2 with the implicit grant flow

Path Parameters

repo_id · string · required

The repo ID of the repository. Repo name can be used instead of the ID, but usage of ID for permanent linking and API requests is preferred.

Required string length: 3 - 128

Example:

"example_id"

shelf_id · string · required

Shelf identifier

Required string length: 3 - 128

Example:

"dv.shelf.12a37e91-bfc4-4e03-a330-13b5b84ab7cb"

Body

application/json

shelf_name · string · required

Required string length: 1 - 60

Response

204

Request completed successfully