> ## Documentation Index > Fetch the complete documentation index at: https://code.storage/docs/llms.txt > Use this file to discover all available pages before exploring further. # Branches: Diff > Compare a feature branch to its base branch and return every change that would be reviewed before a merge. Repeated `path` filters limit the diff to selected files and bypass the usual large-file filtering for those requested paths. #### JWT claims Required scopes: `git:read` Requires per repo scope: Yes ## OpenAPI ````yaml openapi.json GET /api/repos/{repo_name}/branches/diff openapi: 3.1.0 info: description: >- The Code Storage HTTP API exposes repository management, Git reads, and write workflows over plain HTTPS. ## Authentication Send a signed JWT in the `Authorization: Bearer ` header on every request. - Organisation-scoped endpoints such as `GET /api/repos` require organisation scopes like `org:read` - Repository-scoped endpoints require a JWT whose `repo` claim names the target repository - Write operations require the relevant scope such as `git:write` or `repo:write` ## Pagination List endpoints use cursor-based pagination. - `cursor` is an opaque token returned by the previous response - `limit` defaults to `20` and is capped per endpoint - `has_more` tells you whether another request is available - `next_cursor` becomes the next `cursor` value ## Paths Preferred routes use the shorter `/api/...` form. Legacy `/api/v1/...` aliases remain documented where they are still supported and are marked as deprecated when a preferred route exists. ## Repository names in paths - Names containing `/` (or any other character that is not safe in a URL path segment) **must** be URL encoded so the value occupies a single path segment. For example, `pierre/example` becomes `pierre%2Fexample` and the request URL is `/api/repos/pierre%2Fexample/...`. - Plain names that contain only URL-safe characters can be sent as-is: `/api/repos/dotfiles/...`. - The server URL-decodes the value before resolving the repository, so double-encoding is not required. ## Errors Most endpoints return RFC 9457-compatible problem details under `application/problem+json`, with a legacy `error` field mirrored from `detail`. Each problem body has a stable, snake_case `code`. Branch on `code`, not on `detail`. The Error codes section lists the values. A `429 Too Many Requests` response carries the current IETF `RateLimit` service-limit field and `Retry-After`. `RateLimit` reports immediately available quota (`r`) and its effective window in seconds (`t`); `Retry-After` is the minimum delay and takes precedence. The gateway's capacity is dynamic, so it does not advertise a fixed `RateLimit-Policy` on successful responses. Streaming commit and note workflows may return operation-specific failure bodies so callers can inspect partial results, branch state, or workflow status without parsing generic error strings. ## Error codes Each problem body has a stable `code`. Each status has a generic code. A specific code replaces it when the caller must take a different action. New codes can be added. Treat an unknown code as the generic code for its status. Generic codes: `bad_request` (400), `unauthorized` (401), `forbidden` (403), `not_found` (404), `method_not_allowed` (405), `request_timeout` (408), `conflict` (409), `precondition_failed` (412), `payload_too_large` (413), `unprocessable_entity` (422), `rate_limited` (429), `request_canceled` (499), `internal_error` (500), `not_implemented` (501), `bad_gateway` (502), `service_unavailable` (503), `gateway_timeout` (504). Any other status uses its status text in snake_case. Specific codes: - `authentication_unavailable` (403): the server cannot verify credentials now; retry. - `insufficient_scope` (403): the token does not have a scope that the operation requires. - `repo_claim_missing` (400): the token has no `repo` claim. - `repo_name_mismatch` (400): the request `repo_name` does not match the token `repo` claim. - `route_not_found` (404): no API route matches the path. - `repository_not_found` (404): the repository does not exist or the token cannot access it. - `repository_deleted` (409): the repository is already deleted. - `repository_thawing` (409): the repository is being restored from cold storage; retry after `Retry-After`. - `sync_in_progress` (409): an upstream sync is in progress; retry. - `upstream_already_configured` (409): the repository already has an upstream. - `branch_not_found` (404): the branch does not exist. - `ref_not_found` (404): the ref or revision does not exist. - `merge_conflict` (409): the merge has file conflicts. - `credential_not_found` (404): the Git credential does not exist. - `credential_exists` (409): the repository already has a Git credential. - `github_app_not_configured` (412): the organization does not have exactly one GitHub App. - `github_repository_inaccessible` (412, or the 4xx status from the upstream): GitHub does not give access to the upstream repository. - `hosting_not_enabled` (403): hosting is not enabled for the organization. - `hosting_project_not_found` (404): the repository has no hosting project. - `deployment_not_found` (404): the deployment does not exist. - `deployment_project_name_in_use` (409): another repository uses the hosting project name. - `idempotency_key_reused` (422): the idempotency key belongs to a different request. title: code.storage version: 1.0.0 servers: - description: Code Storage API host for your organization url: https://api.{org}.code.storage variables: org: default: your-org description: >- The subdomain of your API host. It is usually your organization name. The organization settings page in the dashboard shows your exact API host. security: [] tags: - description: >- Create, inspect, update, delete, and synchronise repositories, including upstream pull-sync and generic HTTPS Git credentials for non-GitHub upstreams. name: Repositories - description: Create, delete, list, and compare branches. name: Branches - description: >- Read commit metadata and diffs, or create commits without a local Git client. name: Commits - description: >- Read repository trees, file contents, archives, and server-side search results. name: Files - description: List, create, and delete Git tags. name: Tags - description: Attach and retrieve Git notes for commits or other Git objects. name: Notes - description: >- Read metadata about the Code Storage deployment that serves your organisation, such as its cloud location and inbound IP addresses. name: Organization paths: /api/repos/{repo_name}/branches/diff: get: tags: - Commits summary: Get Branch Diff description: >- Compare a feature branch to its base branch and return every change that would be reviewed before a merge. Repeated `path` filters limit the diff to selected files and bypass the usual large-file filtering for those requested paths. #### JWT claims Required scopes: `git:read` Requires per repo scope: Yes operationId: get_branch_diff parameters: - description: >- Repository name. Names that contain `/` or any other character that is not safe in a URL path segment must be URL encoded so the value occupies a single path segment. For example `pierre/example` is sent as `pierre%2Fexample`. Plain names such as `example` can be sent as-is. The server URL-decodes the value before resolving the repository. example: my-demo-repository in: path name: repo_name required: true schema: type: string - description: Branch name to diff. example: feature/new-auth in: query name: branch required: true schema: type: string - description: Optional base branch or ref to diff against. example: main in: query name: base schema: type: string - description: Whether `branch` should be resolved from the ephemeral namespace. example: true in: query name: ephemeral schema: type: boolean - description: Whether `base` should be resolved from the ephemeral namespace. example: false in: query name: ephemeral_base schema: type: boolean - description: >- Optional repeated path filter. Provide multiple `path` query values to restrict the diff to specific files or directories. example: - src/main.go - README.md in: query name: path schema: items: type: string type: array responses: '200': content: application/json: example: base: main branch: feature/new-feature files: - bytes: 2048 is_eof: true path: src/main.go raw: |- diff --git a/src/main.go b/src/main.go ... state: M filtered_files: - bytes: 50000 is_eof: true path: package-lock.json state: M merge_base_sha: a2d127e6a4d54bb7390de828a99e36411f0c84df stats: additions: 50 changes: 60 deletions: 10 files: 3 schema: $ref: '#/components/schemas/GetBranchDiffResponse' description: >- Diff between a source branch and its base, including the merge base used for the three-dot comparison. '400': content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Not Found '409': content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Conflict '429': content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Too Many Requests headers: RateLimit: description: >- Current IETF service-limit field. `r=0` means no request is immediately available; `t` is the effective window in seconds before capacity is expected to return. schema: type: string Retry-After: description: >- Minimum delay before retrying, expressed as seconds or an HTTP date. This value takes precedence over the `RateLimit` effective window. schema: type: string '500': content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Internal Server Error '503': content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: Service Unavailable security: - bearerAuth: - git:read components: schemas: GetBranchDiffResponse: additionalProperties: false description: >- Diff between a branch and its base, including merge base, aggregate stats, and per-file changes. properties: base: description: The base branch or ref used for comparison. examples: - main type: string branch: description: The branch name being diffed. examples: - feature/new-feature type: string files: description: Files returned with inline diff content. items: $ref: '#/components/schemas/FileDiff' type: array filtered_files: description: >- Files filtered out of inline diff output because of size or file-type rules. items: $ref: '#/components/schemas/FilteredFile' type: array merge_base_sha: description: Merge base SHA used for the three-dot branch diff. examples: - a2d127e6a4d54bb7390de828a99e36411f0c84df type: string stats: $ref: '#/components/schemas/DiffStats' description: Aggregate diff statistics. required: - branch - base - merge_base_sha - stats - files - filtered_files type: object ProblemDetails: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: code: description: >- A stable, machine-readable error code in snake_case. Branch on `code`, not on `detail`. The API description lists the codes. type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. type: string error: description: Legacy compatibility field mirroring `detail` for older clients. type: string instance: description: >- A URI reference that identifies the specific occurrence of the problem. type: string status: description: >- The HTTP status code generated by the origin server for this occurrence of the problem. format: int64 type: integer title: description: A short, human-readable summary of the problem type. type: string type: description: >- A URI reference that identifies the problem type. `about:blank` indicates the generic HTTP status semantics apply. type: string required: - type - title - status - code type: object FileDiff: additionalProperties: false description: Per-file diff entry including the raw unified diff text. properties: additions: description: Added lines in this file. format: int64 type: integer bytes: description: File size in bytes. examples: - 2048 format: int64 type: integer deletions: description: Deleted lines in this file. format: int64 type: integer is_eof: description: Whether the file ends with a newline. examples: - true type: boolean old_path: description: Previous file path for renamed files. type: string path: description: Repository-relative file path (new location for renames). examples: - src/main.go type: string raw: description: Raw unified diff content. examples: - |- diff --git a/src/main.go b/src/main.go ... type: string state: description: >- Git status code: A (added), M (modified), D (deleted), R (renamed), C (copied), or T (type changed). examples: - M type: string required: - path - state - raw - bytes - is_eof - additions - deletions type: object FilteredFile: additionalProperties: false description: >- Per-file diff entry that was excluded from inline diff output because of size or file-type rules. properties: bytes: description: File size in bytes. examples: - 50000 format: int64 type: integer is_eof: description: Whether the file ends with a newline. examples: - true type: boolean old_path: description: Previous file path for renamed files. type: string path: description: >- Repository-relative file path (new location for renames). Excluded from inline diff content because of size or file-type rules. examples: - package-lock.json type: string state: description: >- Git status code: A (added), M (modified), D (deleted), R (renamed), C (copied), or T (type changed). examples: - M type: string required: - path - state - bytes - is_eof type: object DiffStats: additionalProperties: false description: Aggregate diff statistics across all files. properties: additions: description: Total added lines across the diff. examples: - 50 format: int64 type: integer changes: description: Total line changes (additions plus deletions). examples: - 60 format: int64 type: integer deletions: description: Total deleted lines across the diff. examples: - 10 format: int64 type: integer files: description: Number of files changed. examples: - 3 format: int64 type: integer required: - files - additions - deletions - changes type: object securitySchemes: bearerAuth: bearerFormat: JWT description: >- JWT bearer token signed with your organization's registered signing key. There is no OAuth authorization server; you mint tokens yourself and the token's `scopes` claim carries the granted permission scopes. Public scopes: `git:read` (read repository contents), `git:write` (write branches, commits, tags, and notes), `repo:write` (create and manage repositories), `org:read` (list an organization's repositories). Each operation's security requirement names the scopes it requires. See https://code.storage/docs/getting-started/authentication for how to mint tokens. scheme: bearer type: http ````