RepositoryResource
Application REST endpoint to access and manipulate specific Repository data.
The following resources are part of this group:
- /repository
- /repository/deleteRepository
- /repository/search
- /repository/setHead
- /repository/{repositoryId}
- /repository/{repositoryId}/consistencycheck
- /repository/{repositoryId}/git-gc
- /repository/{repositoryId}/history
- /repository/{repositoryId}/nodeCount
- /repository/{repositoryId}/removeSkipThreshold
- /repository/{repositoryId}/replicationGroup
- /repository/{repositoryId}/skipThreshold
- /repository/{repositoryId}/startinput
- /repository/{repositoryId}/startoutput
- /repository/{repositoryId}/stats
- /repository/{repositoryId}/stopoutput
- /repository/{repositoryId}/uncoordinated-stopoutput
- /repository/{repositoryId}/globalReadOnly/{readOnly}
- /repository/{repositoryId}/lastdelivered/{nodeName}
- /repository/{repositoryId}/lastkey/{nodeName}
- /repository/{repositoryId}/lastoutput/{nodeName}
- /repository/{repositoryId}/localReadOnly/{readOnly}
- /repository/{repositoryId}/replicationGroup/{replicationGroupId}
- /repository/{repositoryId}/skipThreshold/{key}
/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 |
| gitLabRepo | - Whether this repo is being created via GitLab. If so, extra hook scripts need placed inside the repo after it is created. Default: false | 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 |
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/{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}/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}/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}/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}/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}/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 |