Bookmark

A Bookmark represents a bookmark in Mercurial version control Repository.

Note

Slash characters in :repository_id must be encoded with %2F

Attributes

id

A name of the bookmark, e.g. default.

  • Type: string

uuid

A universally unique identifier.

  • Type: string

commit

Currently bookmarked commit

  • Type: string

Operations

GET /projects/:project_id/repositories/:repository_id/bookmarks

Returns the bookmarks in a repository, with optional limit and offset, as a metadata-results object.

Example Request

curl -X GET \
  -H "Accept: application/vnd.hth.v1" \
  -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
  https://helixteamhub.cloud/api/projects/luotsi/repositories/chef/bookmarks

Example Response

{
  "metadata": {
    "more_results": true,
    "next_offset": 2,
    "count": 2
  },
  "results": [
    {
      "api_status": 200,
      "api_timestamp": "2016-06-01T11:06:10Z",
      "id": "default",
      "uuid": "5a801da3-c208-4ccd-876c-4acfb39eda2a-default",
      "commit": "856b72272ad451b86f419d120360b1d8caa4b0c2"
    },
    {
      "api_status": 200,
      "api_timestamp": "2016-06-01T11:06:10Z",
      "id": "feature1",
      "uuid": "5a801da3-c208-4ccd-876c-4acfb39eda2a-feature1",
      "commit": "a810df9f2805d53c4bc0bf886029527e71fe8411"
    }
  ]
}