Compare
Commits

List commits between two revisions

List commits between a 'base' and 'head' commit. Two dots list what head added; three dots list the commits on either side but not both, each tagged with the side it came from.

get/api/repos/{namespace}/{repo_name}/compare/{base_head}/commits

Request

Path parameters

namespacestring required

Namespace of the repository

repo_namestring required

Name of the repository

base_headstring required

The base and head revisions separated by '..', or '...' for the commits on either side but not both

Query parameters

pageinteger

Page number for pagination (starts at 1)

page_sizeinteger

Page size for pagination

Response

Commits found successfully

oxen_versionstring nullable
statusstring required
status_messagestring required
page_numberinteger required
page_sizeinteger required
total_entriesinteger required
total_pagesinteger required

Example response

{
  "compare": {
    "base_commit": {
      "author": "ox",
      "email": "ox@example.com",
      "id": "a1b2c3d4e5f67890abcdef1234567890",
      "message": "Refactor data loading pipeline.",
      "parent_ids": [
        "f1e2d3c4b5a67890fedcba9876543210"
      ],
      "timestamp": "2025-01-01T10:00:00Z"
    },
    "commits": [
      {
        "author": "ox",
        "email": "ox@example.com",
        "id": "a1b2c3d4e5f67890abcdef1234567890",
        "message": "Refactor data loading pipeline.",
        "parent_ids": [
          "f1e2d3c4b5a67890fedcba9876543210"
        ],
        "timestamp": "2025-01-01T10:00:00Z"
      }
    ],
    "head_commit": {
      "author": "ox",
      "email": "ox@example.com",
      "id": "a1b2c3d4e5f67890abcdef1234567890",
      "message": "Refactor data loading pipeline.",
      "parent_ids": [
        "f1e2d3c4b5a67890fedcba9876543210"
      ],
      "timestamp": "2025-01-01T10:00:00Z"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.