| Copyright | (c) Rob Stewart Heriot-Watt University 2019 |
|---|---|
| License | BSD3 |
| Maintainer | robstewart57@gmail.com |
| Stability | stable |
| Safe Haskell | None |
| Language | Haskell2010 |
GitLab.API.Repositories
Description
Synopsis
- repositories :: Project -> GitLab [Repository]
- repositories' :: Int -> GitLab (Either Status [Repository])
- getFileArchive :: Project -> ArchiveFormat -> FilePath -> GitLab (Either Status ())
- getFileArchiveBS :: Project -> ArchiveFormat -> GitLab (Either Status ByteString)
- getFileArchive' :: Int -> ArchiveFormat -> FilePath -> GitLab (Either Status ())
- getFileArchiveBS' :: Int -> ArchiveFormat -> GitLab (Either Status ByteString)
Documentation
Arguments
| :: Project | the project |
| -> GitLab [Repository] |
returns a list of repository files and directories in a project.
Arguments
| :: Int | the project ID |
| -> GitLab (Either Status [Repository]) |
returns a list of repository files and directories in a project given its project ID.
Arguments
| :: Project | project |
| -> ArchiveFormat | file format |
| -> FilePath | file path to store the archive |
| -> GitLab (Either Status ()) |
get a file archive of the repository files. For example:
getFileArchive myProject TarGz "/tmp/myProject.tar.gz"
Arguments
| :: Project | project |
| -> ArchiveFormat | file format |
| -> GitLab (Either Status ByteString) |
get a file archive of the repository files as a
ByteString. For example:
getFileArchiveBS myProject TarGz "/tmp/myProject.tar.gz"
Arguments
| :: Int | project ID |
| -> ArchiveFormat | file format |
| -> FilePath | file path to store the archive |
| -> GitLab (Either Status ()) |
get a file archive of the repository files using the project's ID. For example:
getFileArchive' 3453 Zip "/tmp/myProject.zip"
Arguments
| :: Int | project ID |
| -> ArchiveFormat | file format |
| -> GitLab (Either Status ByteString) |
get a file archive of the repository files as a ByteString
using the project's ID. For example:
getFileArchiveBS' 3453 Zip "/tmp/myProject.zip"