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.
Get Repositories for an owner or an organization
Authorizations:
path Parameters
hosting required | string Enum: "github" "gitlab" Git Hosting Provider |
owner required | string Organization or individual user owner of repositories |
Responses
Response samples
- 200
- 400
[- {
- "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"
}
]
Get Repository informations by name
Authorizations:
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
- 200
- 400
{- "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"
}
Get Repository branches
Authorizations:
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
- 200
- 400
[- {
- "ref": "string",
- "sha": "string",
- "branch": "string"
}
]
Create Repository branch
Authorizations:
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/jsonrequired
Create branch for a repository
name required | string |
Responses
Request samples
- Payload
{- "name": "string"
}
Response samples
- 200
- 400
[- {
- "ref": "string",
- "sha": "string",
- "branch": "string"
}
]
Delete Repository branch by branch name
Authorizations:
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
- 400
{- "title": "Bad Request",
- "status": 400,
- "detail": "Property foo is required but is missing."
}
Get Repository commits
Authorizations:
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
- 200
- 400
[- {
- "sha": "string",
- "tree": {
- "sha": "string"
}, - "author": {
- "date": "2019-08-24T14:15:22Z",
- "name": "string",
- "email": "user@example.com"
}, - "committer": {
- "date": "2019-08-24T14:15:22Z",
- "name": "string",
- "email": "user@example.com"
}, - "message": "string",
- "date": "2019-08-24T14:15:22Z"
}
]
Get Repository files
Authorizations:
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
- 200
- 400
[- {
- "id": "string",
- "type": "string",
- "content": "string",
- "encoding": "string",
- "size": 0,
- "name": "string",
- "path": "string"
}
]
Get Repository file by path
Authorizations:
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
- 200
- 400
[- {
- "id": "string",
- "type": "string",
- "content": "string",
- "encoding": "string",
- "size": 0,
- "name": "string",
- "path": "string"
}
]
Create a new file and commit.
Authorizations:
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
- Payload
{- "encoding": "text",
- "content": "string",
- "commit": {
- "message": "string"
}
}
Response samples
- 200
- 400
[- {
- "id": "string",
- "type": "string",
- "content": "string",
- "encoding": "string",
- "size": 0,
- "name": "string",
- "path": "string"
}
]
Update an existing file and create a new commit.
Authorizations:
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
- Payload
{- "encoding": "text",
- "content": "string",
- "commit": {
- "message": "string"
}
}
Response samples
- 200
- 400
[- {
- "id": "string",
- "type": "string",
- "content": "string",
- "encoding": "string",
- "size": 0,
- "name": "string",
- "path": "string"
}
]
Delete an existing file and create a new commit.
Authorizations:
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
- 400
{- "title": "Bad Request",
- "status": 400,
- "detail": "Property foo is required but is missing."
}