Overview

Version information

Version : 6.4.0-SNAPSHOT

URI scheme

BasePath : /api/rest

Tags

  • Git : Manage git repositories

Resources

Git

Manage git repositories

Get zipped repository content

GET /git/repositories/{code}
Description

If no branch are provided, will export the current branch

Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

Query

branch
optional

Branch to export

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/octet-stream

Upload a repository

PUT /git/repositories/{code}
Parameters
Type Name Description Schema

Body

body
optional

Upload form

Path

code
required

Code of the repository

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • multipart/form-data

Produces
  • application/json

  • application/xml

  • text/csv

Update an existing repository

POST /git/repositories/{code}
Parameters
Type Name Description Schema

Body

body
optional

Repository information

Path

code
required

Code of the repository

string

Responses
HTTP Code Description Schema

200

If update is ok

No Content

404

If specified repository does not exists

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Remove a repository by code

DELETE /git/repositories/{code}
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Push the commit to remote origin

POST /git/repositories/{code}/push
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

FormData

username
optional

Username to use during push

string

FormData

password
optional

Password to use during push

string

Responses
HTTP Code Description Schema

200

If push is successful

No Content

400

If repository has no remote

No Content

Consumes
  • application/x-www-form-urlencoded

Produces
  • application/json

  • application/xml

  • text/csv

List all existing repositories

GET /git/repositories
Responses
HTTP Code Description Schema

200

successful operation

< GitRepositoryDto > array

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Upload a new repository

POST /git/repositories
Parameters
Type Name Description Schema

Body

body
optional

Upload form

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • multipart/form-data

Produces
  • application/json

  • application/xml

  • text/csv

Merge one branch into another

POST /git/repositories/{code}/branches/merge
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

FormData

source
required

Source branch of the merge

string

FormData

target
required

Target branch of the merge

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Commit content of a repository

POST /git/repositories/{code}/commit
Description

Will commit every file if patterns is empty

Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

FormData

message
optional

Commit message

string

FormData

pattern
optional

Patterns of the files to commit

< string > array(multi)

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/x-www-form-urlencoded

Produces
  • application/json

  • application/xml

  • text/csv

Create a branch

POST /git/repositories/{code}/branches/{branch}
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

Path

branch
required

Name of the branch to create

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Delete a branch

DELETE /git/repositories/{code}/branches/{branch}
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

Path

branch
required

Name of the branch to delte

string

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Checkout a branch

POST /git/repositories/{code}/branches/{branch}/checkout
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

Path

branch
required

Name of the branch to checkout

string

Query

create
optional

Whether to create branch if it does not exist

boolean

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • application/json

  • application/xml

  • text/csv

Pull changes from remote origin

POST /git/repositories/{code}/pull
Parameters
Type Name Description Schema

Path

code
required

Code of the repository

string

FormData

username
optional

Username to use during pull

string

FormData

password
optional

Password to use during pull

string

Responses
HTTP Code Description Schema

200

If pull is successful

No Content

400

If repository has no remote

No Content

Consumes
  • application/x-www-form-urlencoded

Produces
  • application/json

  • application/xml

  • text/csv

Export to a file

POST /git/export
Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

file

Consumes
  • application/json

  • application/xml

  • multipart/form-data

  • text/csv

Produces
  • text/csv

  • application/xml

  • application/json

Import from multiple files

POST /git/import
Parameters
Type Name Description Schema

Query

overwrite
optional

Whether to overwrite existing data

boolean

FormData

file
required

File contained serialized data

< file > array(multi)

Responses
HTTP Code Description Schema

default

successful operation

No Content

Consumes
  • multipart/form-data

Produces
  • application/json

  • application/xml

  • text/csv

Definitions

GitRepositoryDto

Name Schema

active
optional

boolean

code
optional

string

description
optional

string

updatedCode
optional

string

readingRoles
optional

< string > array

writingRoles
optional

< string > array

remoteOrigin
optional

string

remoteUsername
optional

string

remotePassword
optional

string

meveoRepository
optional

boolean

currentBranch
optional
read-only

string

branches
optional
read-only

< string > array

remote
optional

boolean

GitRepositoryUploadForm

Name Description Schema

data
optional

Zipped repository content

repository
optional

Repository information

InputStream

Type : object

PagingAndFiltering

Name Schema

fullTextFilter
optional

string

filters
optional

< string, object > map

fields
optional

string

offset
optional

integer (int32)

limit
optional

integer (int32)

sortBy
optional

string

sortOrder
optional

enum (ASCENDING, DESCENDING)

totalNumberOfRecords
optional

integer (int32)