| Copyright | (c) Rob Stewart Heriot-Watt University 2019 |
|---|---|
| License | BSD3 |
| Maintainer | robstewart57@gmail.com |
| Stability | stable |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GitLab.API.RepositoryFiles
Description
Synopsis
- repositoryFile :: Project -> Text -> Text -> GitLab (Either (Response ByteString) (Maybe RepositoryFile))
- repositoryFileBlame :: Project -> Text -> Text -> GitLab (Either (Response ByteString) (Maybe RepositoryFileBlame))
- repositoryFileRawFile :: Project -> Text -> Text -> GitLab (Either (Response ByteString) (Maybe Text))
- repositoryFileBlob :: Int -> Text -> GitLab (Either (Response ByteString) String)
- createRepositoryFile :: Project -> Text -> Text -> Text -> Text -> GitLab (Either (Response ByteString) (Maybe RepositoryFileSimple))
- updateRepositoryFile :: Project -> Text -> Text -> Text -> Text -> GitLab (Either (Response ByteString) (Maybe RepositoryFileSimple))
- deleteRepositoryFile :: Project -> Text -> Text -> Text -> GitLab (Either (Response ByteString) (Maybe ()))
Documentation
Arguments
| :: Project | the project |
| -> Text | the file path |
| -> Text | name of the branch, tag or commit |
| -> GitLab (Either (Response ByteString) (Maybe RepositoryFile)) |
Allows you to receive information about file in repository like name, size, content. File content is Base64 encoded.
Arguments
| :: Project | the project |
| -> Text | the file path |
| -> Text | name of the branch, tag or commit |
| -> GitLab (Either (Response ByteString) (Maybe RepositoryFileBlame)) |
Allows you to receive blame information. Each blame range contains lines and corresponding commit information.
repositoryFileRawFile Source #
Arguments
| :: Project | the project |
| -> Text | the file path |
| -> Text | The name of branch, tag or commit. Default is the HEAD of the project. |
| -> GitLab (Either (Response ByteString) (Maybe Text)) |
Get a raw file from a repository.
Allows you to receive information about blob in repository like size and content. Blob content is Base64 encoded.
Arguments
| :: Project | the project |
| -> Text | the file path |
| -> Text | Name of the new branch to create. The commit is added to this branch. |
| -> Text | The file’s content |
| -> Text | The commit message |
| -> GitLab (Either (Response ByteString) (Maybe RepositoryFileSimple)) |
This allows you to create a single file. For creating multiple files with a single request see the commits API.
Arguments
| :: Project | the project |
| -> Text | the file path |
| -> Text | Name of the new branch to create. The commit is added to this branch. |
| -> Text | The file’s content |
| -> Text | The commit message |
| -> GitLab (Either (Response ByteString) (Maybe RepositoryFileSimple)) |
This allows you to update a single file. For updating multiple files with a single request see the commits API.
Arguments
| :: Project | the project |
| -> Text | the file path |
| -> Text | Name of the new branch to create. The commit is added to this branch. |
| -> Text | The commit message |
| -> GitLab (Either (Response ByteString) (Maybe ())) |
This allows you to delete a single file. For deleting multiple files with a single request, see the commits API.