Skip to main content
GET
/
v1
/
shelves
/
{id}
/
diff
Compare two versions
curl --request GET \
  --url https://api.shelv.dev/v1/shelves/{id}/diff \
  --header 'Authorization: Bearer <token>'
{
  "files": [
    {
      "patch": "<string>",
      "path": "<string>",
      "status": "added",
      "truncated": true
    }
  ],
  "from": 123,
  "shelfPublicId": "<string>",
  "summary": {
    "added": 1,
    "modified": 1,
    "removed": 1,
    "totalFiles": 1,
    "unchanged": 1
  },
  "to": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Pattern: ^shf_[0-9a-f]{24}$

Query Parameters

from
integer
required
to
integer
required
context
integer | null
default:3
Required range: 0 <= x <= 10

Response

Version diff

files
object[]
required
from
integer
required
shelfPublicId
string
required
Pattern: ^shf_[0-9a-f]{24}$
summary
object
required
to
integer
required