Skip to main content

Giteway (0.2.0)

Download OpenAPI specification:Download

Giteway is an HTTP Gateway for Git services, providing a standardized interface for fetching Git information and commits from various service providers including GitHub and GitLab.

admin

Admin APIs

Get Repositories for an owner or an organization

Authorizations:
gitlabgithub
path Parameters
hosting
required
string
Enum: "github" "gitlab"

Git Hosting Provider

owner
required
string

Organization or individual user owner of repositories

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Repository informations by name

Authorizations:
gitlabgithub
path Parameters
hosting
required
string
Enum: "github" "gitlab"

Git Hosting Provider

owner
required
string

Organization or individual user owner of repositories

repository
required
string

Repository name

Responses

Response samples

Content type
application/json
{
  • "owner": "string",
  • "name": "string",
  • "default_branch": "string",
  • "clone_url": "string",
  • "git_url": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

repo

Repository APIs

Get Repository branches

Authorizations:
gitlabgithub
path Parameters
hosting
required
string
Enum: "github" "gitlab"

Git Hosting Provider

owner
required
string

Organization or individual user owner of repositories

repository
required
string

Repository name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Repository branch

Authorizations:
gitlabgithub
path Parameters
hosting
required
string
Enum: "github" "gitlab"

Git Hosting Provider

owner
required
string

Organization or individual user owner of repositories

repository
required
string

Repository name

Request Body schema: application/json
required

Create branch for a repository

name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete Repository branch by branch name

Authorizations:
gitlabgithub
path Parameters
hosting
required
string
Enum: "github" "gitlab"

Git Hosting Provider

owner
required
string

Organization or individual user owner of repositories

repository
required
string

Repository name

branch
required
string

Branch name

Responses

Response samples

Content type
application/json
{
  • "title": "Bad Request",
  • "status": 400,
  • "detail": "Property foo is required but is missing."
}

Get Repository commits

Authorizations:
gitlabgithub
path Parameters
hosting
required
string
Enum: "github" "gitlab"

Git Hosting Provider

owner
required
string

Organization or individual user owner of repositories

repository
required
string

Repository name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Repository files

Authorizations:
gitlabgithub
path Parameters
hosting
required
string
Enum: "github" "gitlab"

Git Hosting Provider

owner
required
string

Organization or individual user owner of repositories

repository
required
string

Repository name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

file

Repository files APIs

Get Repository file by path

Authorizations:
gitlabgithub
path Parameters
hosting
required
string
Enum: "github" "gitlab"

Git Hosting Provider

owner
required
string

Organization or individual user owner of repositories

repository
required
string

Repository name

path
required
Array of strings

File path

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new file and commit.

Authorizations:
gitlabgithub
path Parameters
hosting
required
string
Enum: "github" "gitlab"

Git Hosting Provider

owner
required
string

Organization or individual user owner of repositories

repository
required
string

Repository name

path
required
Array of strings

File path

Request Body schema: application/json

New or existing file to be uploaded and commit

encoding
string
Default: "text"
content
required
string
object

Responses

Request samples

Content type
application/json
{
  • "encoding": "text",
  • "content": "string",
  • "commit": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Update an existing file and create a new commit.

Authorizations:
gitlabgithub
path Parameters
hosting
required
string
Enum: "github" "gitlab"

Git Hosting Provider

owner
required
string

Organization or individual user owner of repositories

repository
required
string

Repository name

path
required
Array of strings

File path

Request Body schema: application/json

New or existing file to be uploaded and commit

encoding
string
Default: "text"
content
required
string
object

Responses

Request samples

Content type
application/json
{
  • "encoding": "text",
  • "content": "string",
  • "commit": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete an existing file and create a new commit.

Authorizations:
gitlabgithub
path Parameters
hosting
required
string
Enum: "github" "gitlab"

Git Hosting Provider

owner
required
string

Organization or individual user owner of repositories

repository
required
string

Repository name

path
required
Array of strings

File path

Responses

Response samples

Content type
application/json
{
  • "title": "Bad Request",
  • "status": 400,
  • "detail": "Property foo is required but is missing."
}