RepositoryResource

Application REST endpoint to access and manipulate specific Repository data.

The following resources are part of this group:

/repository

Mount Point: /api/repository

POST

Deploy a repository to a replication group.

Parameters

name description type default
replicationGroupId (no documentation provided) query
createEmptyRepo (no documentation provided) query false
gerritRepo - Whether this repo has been added through Gerrit. query false
timeout - if defined, the number of seconds before a deploy operation will abort. query
denyNonFastForwards (no documentation provided) query

Request Body

element: git-repository
media types: */*
application/xml

(no documentation provided)

Response Body

element: (custom)
media types: application/xml

(no documentation provided)

Status Codes

code description
202 Accepted
400 Bad Request - see Exception
404 Replication Group not found
409 Conflict - see Exception
401 Authentication required.
403 Authorization required - access forbidden

Response Headers

name description
Content Location Path to relevant Task

/repository/deleteRepository

Mount Point: /api/repository/deleteRepository

DELETE

Remove a repository by the FS Path

Parameters

name description type default
fsPath (no documentation provided) query

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

Status Codes

code description
200 Ok
202 Accepted
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

Response Headers

name description
Content Location Path to relevant Task

/repository/search

Mount Point: /api/repository/search

GET

Find the repository with the specified parameter(s)

Parameters

name description type default
filesystemPath (no documentation provided) query
withPendingTransactions true/false query false
withPendingTransactionsForAllNodes (no documentation provided) query false

Response Body

element: git-repository
media types: application/xml

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

/repository/setHead

Mount Point: /api/repository/setHead

PUT

Parameters

name description type default
repositoryId (no documentation provided) query
repositoryPath (no documentation provided) query
newHead (no documentation provided) query

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

Status Codes

code description
200 OK
400 Bad Request - see Exception
404 Repository not found
401 Authentication required.
403 Authorization required - access forbidden

/repository/update-config

Mount Point: /api/repository/update-config

PUT

Updates the git repository with the specified file path, given the XML for the properties to update. Notes on usage:

    • ADD/UPDATE: To add or update a property, provide all of the details [section, subsection (optional), property, value]
      NO-CHANGE: Properties which do not need to be updated do not need to be provided.
      DELETE-SECTION: Where a section is to be deleted, the section name should be specified, with no other details.
      DELETE-SUB-SECTION: Where a sub-section is to be deleted, the section name and subSection should be specified, with no other details.
      DELETE-PROPERTY: Where a property is to be deleted, the section name, subSection, and property should be specified, and no value set.

    • Parameters

    name description type default
    path - path to repository on the file system. query

    Request Body

    element: git-config-properties
    media types: application/xml

    Config Properties DTO.

    Response Body

    element: (custom)
    media types: */*
    application/xml

    HTTP Response

    Status Codes

    code description
    202 Accepted
    400 Bad Request - see Exception
    404 Repository not found
    500 Internal Server Error
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}

    Mount Point: /api/repository/{repositoryId}

    GET

    Get the specified Repository by Id

    Parameters

    name description type default
    repositoryId (no documentation provided) path
    withPendingTransactions true/false query false
    withPendingTransactionsForAllNodes (no documentation provided) query false

    Response Body

    element: git-repository
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    200 Ok
    400 Bad Request - see Exception
    404 Repository not found
    401 Authentication required.
    403 Authorization required - access forbidden

    DELETE

    Remove repository by id

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Response Body

    element: (custom)
    media types: */*
    application/xml

    (no documentation provided)

    Status Codes

    code description
    200 Ok
    202 Accepted
    400 Bad Request - see Exception
    404 Repository not found
    401 Authentication required.
    403 Authorization required - access forbidden

    Response Headers

    name description
    Content Location Path to relevant Task

    /repository/{repositoryId}/config

    Mount Point: /api/repository/{repositoryId}/config

    GET

    Get the configuration details for the specified git repository as it appears on the local node.

    Parameters

    name description type default
    repositoryId ID of repository for which config should be made available. path

    Response Body

    element: (custom)
    media types: application/xml

    XML representation of git configuration.

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/consistencycheck

    Mount Point: /api/repository/{repositoryId}/consistencycheck

    POST

    Kick of a global repository check.

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Response Body

    element: (custom)
    media types: */*
    application/xml

    (no documentation provided)

    Status Codes

    code description
    202 Accepted
    400 Bad Request - see Exception
    404 Repository not found
    401 Authentication required.
    403 Authorization required - access forbidden

    GET

    get the consistency check result for the specified repo

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Response Body

    element: checkpoints
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    200 Ok
    400 Bad Request - see Exception
    404 Repository not found
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/git-gc

    Mount Point: /api/repository/{repositoryId}/git-gc

    POST

    Kick of a global Git-GC

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Response Body

    element: (custom)
    media types: */*
    application/xml

    (no documentation provided)

    Status Codes

    code description
    202 Accepted
    400 Bad Request - see Exception
    404 Repository not found
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/history

    Mount Point: /api/repository/{repositoryId}/history

    GET

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/nodeCount

    Mount Point: /api/repository/{repositoryId}/nodeCount

    GET

    Finds the number of nodes that the specified repository is deployed to.

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Response Body

    element: (custom)
    media types: text/plain

    (no documentation provided)

    Status Codes

    code description
    200 Ok
    400 Bad Request - see Exception
    404 Repository not found
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/prepareToUnsideline

    Mount Point: /api/repository/{repositoryId}/prepareToUnsideline

    PUT

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Response Body

    element: (custom)
    media types: application/xml
    text/plain
    application/json

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/removeSkipThreshold

    Mount Point: /api/repository/{repositoryId}/removeSkipThreshold

    PUT

    Advanced use only. See User Manual for usage.

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Request Body

    element: nodes
    media types: application/xml

    (no documentation provided)

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/replicationGroup

    Mount Point: /api/repository/{repositoryId}/replicationGroup

    GET

    Get the replicationGroup associated with the given Repository Id.

    Parameters

    name description type default
    repositoryId (no documentation provided) path
    withPendingTransactions (no documentation provided) query false

    Response Body

    element: replicationGroup
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    200 Ok
    400 Bad Request - see Exception
    404 Repository/ReplicationGroup not found
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/size

    Mount Point: /api/repository/{repositoryId}/size

    GET

    Get the size of the given Repository Id.

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Response Body

    element: size
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    200 Ok
    400 Bad Request - see Exception
    404 Repository not found
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/skipThreshold

    Mount Point: /api/repository/{repositoryId}/skipThreshold

    GET

    Advanced use only. See User Manual for usage.

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/startinput

    Mount Point: /api/repository/{repositoryId}/startinput

    PUT

    Advanced use only. See User Manual for usage.

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Request Body

    element: nodes
    media types: application/xml

    (no documentation provided)

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/startoutput

    Mount Point: /api/repository/{repositoryId}/startoutput

    PUT

    Advanced use only. See User Manual for usage.

    Parameters

    name description type default
    repositoryId (no documentation provided) path
    consistencyCheck (no documentation provided) query false

    Request Body

    element: nodes
    media types: application/xml

    (no documentation provided)

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    400 Bad Request - see Exception
    404 Repository not found
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/stats

    Mount Point: /api/repository/{repositoryId}/stats

    GET

    Get the Repository Statistics associated with the given Repository Id.

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Response Body

    element: stats
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    200 Ok
    400 Bad Request - see Exception
    404 Repository not found
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/stophelper

    Mount Point: /api/repository/{repositoryId}/stophelper

    PUT

    Advanced use only. See User Manual for usage.

    Parameters

    name description type default
    repositoryId (no documentation provided) path
    threshold (no documentation provided) query
    helperNodeId (no documentation provided) query

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/stopoutput

    Mount Point: /api/repository/{repositoryId}/stopoutput

    PUT

    Advanced use only. See User Manual for usage.

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Request Body

    element: nodes
    media types: application/xml

    (no documentation provided)

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/uncoordinated-stopoutput

    Mount Point: /api/repository/{repositoryId}/uncoordinated-stopoutput

    PUT

    Advanced use only. See User Manual for usage.

    Parameters

    name description type default
    repositoryId (no documentation provided) path

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/unsideline

    Mount Point: /api/repository/{repositoryId}/unsideline

    PUT

    Parameters

    name description type default
    repositoryId (no documentation provided) path
    resumeFrom (no documentation provided) query
    membershipId (no documentation provided) query

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/globalReadOnly/{readOnly}

    Mount Point: /api/repository/{repositoryId}/globalReadOnly/{readOnly}

    PUT

    Set the globalReadOnly flag of specified repository

    Parameters

    name description type default
    repositoryId (no documentation provided) path
    readOnly true/false path

    Response Body

    element: (custom)
    media types: */*
    application/xml

    (no documentation provided)

    Status Codes

    code description
    202 Accepted
    400 Bad Request - see Exception
    404 Repository not found
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/lastdelivered/{nodeName}

    Mount Point: /api/repository/{repositoryId}/lastdelivered/{nodeName}

    GET

    Advanced use only. See User Manual for usage.

    Parameters

    name description type default
    repositoryId (no documentation provided) path
    nodeName (no documentation provided) path

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/lastkey/{nodeName}

    Mount Point: /api/repository/{repositoryId}/lastkey/{nodeName}

    GET

    Advanced use only. See User Manual for usage.

    Parameters

    name description type default
    repositoryId (no documentation provided) path
    nodeName (no documentation provided) path

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/lastoutput/{nodeName}

    Mount Point: /api/repository/{repositoryId}/lastoutput/{nodeName}

    GET

    Advanced use only. See User Manual for usage.

    Parameters

    name description type default
    repositoryId (no documentation provided) path
    nodeName (no documentation provided) path

    Response Body

    element: (custom)
    media types: application/xml
    text/plain

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/localReadOnly/{readOnly}

    Mount Point: /api/repository/{repositoryId}/localReadOnly/{readOnly}

    PUT

    Set/Reset the local read-only on the repository. Calling this method will result in any pending proposals to be retried.

    If readOnly flag is 'true', then the repository will be sent into read-only mode.

    Parameters

    name description type default
    repositoryId (no documentation provided) path
    readOnly (no documentation provided) path

    Response Body

    element: (custom)
    media types: */*
    application/xml

    (no documentation provided)

    Status Codes

    code description
    202 Accepted
    400 Bad Request - see Exception
    404 Repository not found
    401 Authentication required.
    403 Authorization required - access forbidden

    Response Headers

    name description
    TODO Path to relevant Task

    /repository/{repositoryId}/replicationGroup/{replicationGroupId}

    Mount Point: /api/repository/{repositoryId}/replicationGroup/{replicationGroupId}

    PUT

    Change the replication group associated with a repository.

    Parameters

    name description type default
    repositoryId (no documentation provided) path
    replicationGroupId (no documentation provided) path

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    202 Accepted
    400 Bad Request - see Exception
    404 Repository not found
    401 Authentication required.
    403 Authorization required - access forbidden

    /repository/{repositoryId}/skipThreshold/{key}

    Mount Point: /api/repository/{repositoryId}/skipThreshold/{key}

    PUT

    Advanced use only. See User Manual for usage.

    Parameters

    name description type default
    repositoryId (no documentation provided) path
    key (no documentation provided) path

    Request Body

    element: nodes
    media types: application/xml

    (no documentation provided)

    Response Body

    element: (custom)
    media types: application/xml

    (no documentation provided)

    Status Codes

    code description
    401 Authentication required.
    403 Authorization required - access forbidden