> ## 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. # Merge: Preview > Preview merge conflicts without creating commits, updating refs, or touching a working tree. When requested, conflict content is rendered from Git objects produced in request-local scratch storage. #### JWT claims Required scopes: `git:read` Requires per repo scope: Yes ## OpenAPI ````yaml openapi.json GET /api/repos/{repo_name}/merge/preview 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}/merge/preview: get: tags: - Branches summary: Preview Merge description: >- Preview merge conflicts without creating commits, updating refs, or touching a working tree. When requested, conflict content is rendered from Git objects produced in request-local scratch storage. #### JWT claims Required scopes: `git:read` Requires per repo scope: Yes operationId: repos-previewMerge 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: Source branch to merge from. example: feature/preview in: query name: source_branch required: true schema: type: string - description: Destination branch to preview merging into. example: main in: query name: target_branch required: true schema: type: string - description: >- Whether `source_branch` should be resolved from the ephemeral namespace. in: query name: source_is_ephemeral schema: type: boolean - description: >- Whether `target_branch` should be resolved from the ephemeral namespace. in: query name: target_is_ephemeral schema: type: boolean - description: When true, include bounded conflict content in the response. example: true in: query name: include_content schema: type: boolean responses: '200': content: application/json: example: conflicts: - base: binary: false oid: '1111111111111111111111111111111111111111' truncated: false ours: binary: false oid: '1111111111111111111111111111111111111111' truncated: false path: docs/conflict.txt result: binary: false oid: '1111111111111111111111111111111111111111' truncated: false theirs: binary: false oid: '1111111111111111111111111111111111111111' truncated: false filtered_conflicts: - path: src/app.ts reason: max_conflict_files_exceeded merge_base_sha: a2d127e6a4d54bb7390de828a99e36411f0c84df result: merge_commit source_branch: feature/preview source_tip_sha: 9eb378bdb5bf1944f6ba0bd5a2c4df3ce32f4df1 status: conflicted target_branch: main target_tip_sha: c4f0fdfc41adab56630b34f5f4fd4e84a2c5b4d2 schema: $ref: '#/components/schemas/ReposPreviewMergeResponse' description: >- Merge preview result. Conflicted previews return HTTP 200 with `status=conflicted`; request and storage failures use normal HTTP errors. '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: ReposPreviewMergeResponse: additionalProperties: false description: >- Read-only merge preview result, including clean or conflicted status and optional inline conflict content. properties: conflict_paths: description: Repository paths that conflicted during the merge preview. items: type: string type: array conflicts: description: Inline conflict content, populated only when include_content=true. items: $ref: '#/components/schemas/PreviewMergeConflict' type: array filtered_conflicts: description: >- Conflicts omitted from inline content because of request or server limits. items: $ref: '#/components/schemas/PreviewMergeFilteredConflict' type: array merge_base_sha: description: Merge base SHA used for the preview. examples: - a2d127e6a4d54bb7390de828a99e36411f0c84df type: string result: description: 'Operation result if applied: merge_commit, fast_forward, or no_op.' enum: - merge_commit - fast_forward - no_op examples: - merge_commit type: string source_branch: description: Source branch requested by the caller. examples: - feature/preview type: string source_tip_sha: description: Resolved source branch tip SHA. examples: - 9eb378bdb5bf1944f6ba0bd5a2c4df3ce32f4df1 type: string status: description: 'Preview status: clean or conflicted.' enum: - clean - conflicted examples: - conflicted type: string target_branch: description: Target branch requested by the caller. examples: - main type: string target_tip_sha: description: Resolved target branch tip SHA. examples: - c4f0fdfc41adab56630b34f5f4fd4e84a2c5b4d2 type: string required: - status - result - source_branch - target_branch - source_tip_sha - target_tip_sha - conflict_paths - conflicts 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 PreviewMergeConflict: additionalProperties: false description: Inline conflict content for a single conflicted repository path. properties: base: $ref: '#/components/schemas/PreviewMergeBlob' description: Base stage blob. ours: $ref: '#/components/schemas/PreviewMergeBlob' description: Target branch stage blob. path: description: Repository path for this conflict. examples: - docs/conflict.txt type: string result: $ref: '#/components/schemas/PreviewMergeBlob' description: >- Best-effort merged blob content, usually with conflict markers for text conflicts. theirs: $ref: '#/components/schemas/PreviewMergeBlob' description: Source branch stage blob. required: - path - result - base - ours - theirs type: object PreviewMergeFilteredConflict: additionalProperties: false description: >- Conflict omitted from inline content because of request or server limits. properties: path: description: Repository path omitted from inline conflict content. examples: - src/app.ts type: string reason: description: Reason the conflict content was omitted. examples: - max_conflict_files_exceeded type: string required: - path - reason type: object PreviewMergeBlob: additionalProperties: false description: Single Git blob rendered as part of a merge conflict preview. properties: binary: description: Whether the blob appears to be binary content. examples: - false type: boolean content: description: UTF-8 text content when available and not binary. type: string oid: description: Git object ID for this blob. examples: - '1111111111111111111111111111111111111111' type: string truncated: description: Whether content was truncated by server-side limits. examples: - false type: boolean required: - truncated - binary 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 ````