Skip to content
forgit api docs

Get file conflicts for a commit spec

GET
/repositories/{workspace}/{repo_slug}/file-conflicts/{spec}

Get file conflicts for a commit spec

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
repo_slug
required
string

This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

spec
required
string

A commit SHA (e.g. 3a8b42) or a commit range using double dot notation (e.g. 3a8b42..9ff173).

workspace
required
string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

A paginated list of file conflicts

Media type application/json
Paginated File Conflicts

A paginated list of file conflicts.

object
size

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

integer
page

Page number of the current results. This is an optional element that is not provided in all responses.

integer
>= 1
pagelen

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

integer
>= 1
next

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
previous

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
values
Array<object>
0 unique items
File Conflict

A file conflict object.

object
type
required
string
path
string
scenario
string
Allowed values: delete_modify modify_delete content binary flags mode type symlink directory_file file_directory add_rename rename_add delete_rename rename_delete rename subrepo unknown
message
string
key
additional properties
any
Examples
Example response 
{
  "pagelen": 500,
  "page": 1,
  "size": 2,
  "values": [
    {
      "path": "src/main/App.java",
      "scenario": "content",
      "message": "File modified in both source and destination"
    },
    {
      "path": "README.md",
      "scenario": "content",
      "message": "File modified in both source and destination"
    }
  ]
}

404

Section titled “ 404 ”

If the spec cannot be resolved, which may be due to an invalid spec, or commits/refs not present in the repository

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}