> ## 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. # Preview Merge > 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 https://api.pierre.code.storage/api/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`. 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. title: code.storage version: 1.0.0 servers: - description: Code Storage tenant cluster url: https://api.{cluster}.code.storage variables: cluster: default: cluster description: >- Tenant cluster identifier (e.g. pierre-dev, pierre-staging, pierre-prod). security: [] tags: - description: Create, inspect, update, delete, and synchronise repositories. 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: >- Trigger upstream synchronisation for repositories backed by an external source. name: Sync - description: Manage generic HTTPS Git credentials for non-GitHub upstreams. name: Credentials 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: preview_merge 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: 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: 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: additionalProperties: false description: >- Inline conflict content for a single conflicted repository path. properties: base: additionalProperties: false description: Base stage blob. 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 ours: additionalProperties: false description: Target branch stage blob. 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 path: description: Repository path for this conflict. examples: - docs/conflict.txt type: string result: additionalProperties: false description: >- Best-effort merged blob content, usually with conflict markers for text conflicts. 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 theirs: additionalProperties: false description: Source branch stage blob. 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 required: - path - result - base - ours - theirs type: object type: array filtered_conflicts: description: >- Conflicts omitted from inline content because of request or server limits. items: 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 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 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: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object application/problem+json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object description: Bad Request '401': content: application/json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object application/problem+json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object description: Unauthorized '403': content: application/json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object application/problem+json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object description: Forbidden '404': content: application/json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object application/problem+json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object description: Not Found '409': content: application/json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object application/problem+json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object description: Conflict '429': content: application/json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object application/problem+json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object description: Too Many Requests '500': content: application/json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object application/problem+json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object description: Internal Server Error '503': content: application/json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object application/problem+json: schema: additionalProperties: false description: >- RFC 9457-compatible problem details payload describing the error response. properties: 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 type: object description: Service Unavailable security: - bearerAuth: [] components: securitySchemes: bearerAuth: bearerFormat: JWT scheme: bearer type: http ````