Copyright	(c) 2020 Jens Petersen
License	GPL-2.0-only
Maintainer	Jens Petersen <petersen@redhat.com>
Safe Haskell	None
Language	Haskell2010

Fedora.Pagure

Description

Pagure REST client library

Synopsis

pagureProjectInfo :: String -> String -> IO (Either String Value)
pagureListProjects :: String -> Query -> IO Value
pagureListProjectIssues :: String -> String -> Query -> IO (Either String Value)
data IssueTitleStatus = IssueTitleStatus {
- pagureIssueId :: Integer
- pagureIssueTitle :: String
- pagureIssueStatus :: Text
- pagureIssueCloseStatus :: Maybe Text
}
pagureListProjectIssueTitlesStatus :: String -> String -> Query -> IO (Either String [IssueTitleStatus])
pagureProjectIssueInfo :: String -> String -> Int -> IO (Either String Object)
pagureListGitBranches :: String -> String -> IO (Either String [String])
pagureListGitBranchesWithCommits :: String -> String -> IO (Either String Object)
pagureListUsers :: String -> String -> IO Value
pagureUserForks :: String -> String -> IO [Text]
pagureUserInfo :: String -> String -> Query -> IO (Either String Value)
pagureUserRepos :: String -> String -> IO [Text]
pagureListGroups :: String -> Maybe String -> Query -> IO Value
pagureProjectGitURLs :: String -> String -> IO (Either String Value)
queryPagure :: String -> String -> Query -> IO Value
queryPagureSingle :: String -> String -> Query -> IO (Either String Value)
queryPagurePaged :: String -> String -> Query -> (String, String) -> IO [Value]
queryPagureCount :: String -> String -> Query -> String -> IO (Maybe Integer)
makeKey :: String -> String -> Query
makeItem :: String -> String -> QueryItem
maybeKey :: String -> Maybe String -> Query
type Query = [QueryItem]
type QueryItem = (ByteString, Maybe ByteString)
lookupKey :: FromJSON a => Text -> Object -> Maybe a
lookupKey' :: FromJSON a => Text -> Object -> a

Documentation

pagureProjectInfo :: String -> String -> IO (Either String Value) Source #

Project info

`pagureProjectInfo server "repo"` `pagureProjectInfo server "namespace/repo"`

https://pagure.io/api/0/#projects-tab

pagureListProjects :: String -> Query -> IO Value Source #

List projects

https://pagure.io/api/0/#projects-tab

pagureListProjectIssues :: String -> String -> Query -> IO (Either String Value) Source #

List project issues

https://pagure.io/api/0/#issues-tab

data IssueTitleStatus Source #

Constructors

IssueTitleStatus
Fields pagureIssueId :: Integer pagureIssueTitle :: String pagureIssueStatus :: Text pagureIssueCloseStatus :: Maybe Text

pagureListProjectIssueTitlesStatus :: String -> String -> Query -> IO (Either String [IssueTitleStatus]) Source #

List project issue titles

https://pagure.io/api/0/#issues-tab

pagureProjectIssueInfo :: String -> String -> Int -> IO (Either String Object) Source #

Issue information

https://pagure.io/api/0/#issues-tab

pagureListGitBranches :: String -> String -> IO (Either String [String]) Source #

List repo branches

https://pagure.io/api/0/#projects-tab

pagureListGitBranchesWithCommits :: String -> String -> IO (Either String Object) Source #

List repo branches with commits

https://pagure.io/api/0/#projects-tab

pagureListUsers :: String -> String -> IO Value Source #

List users

https://pagure.io/api/0/#users-tab

pagureUserForks :: String -> String -> IO [Text] Source #

list user's forks

pagureUserInfo :: String -> String -> Query -> IO (Either String Value) Source #

User information

https://pagure.io/api/0/#users-tab

pagureUserRepos :: String -> String -> IO [Text] Source #

list user's repos

pagureListGroups :: String -> Maybe String -> Query -> IO Value Source #

List groups

https://pagure.io/api/0/#groups-tab

pagureProjectGitURLs :: String -> String -> IO (Either String Value) Source #

Project Git URLs

https://pagure.io/api/0/#projects-tab

queryPagure :: String -> String -> Query -> IO Value Source #

low-level query

queryPagureSingle :: String -> String -> Query -> IO (Either String Value) Source #

single query

queryPagurePaged :: String -> String -> Query -> (String, String) -> IO [Value] Source #

get all pages of results

Note this can potentially download very large amount of data. For potentially large queries, it is a good idea to queryPagureCount first.

queryPagureCount :: String -> String -> Query -> String -> IO (Maybe Integer) Source #

count total number of hits

makeKey :: String -> String -> Query #

Make a singleton key-value Query

makeItem :: String -> String -> QueryItem #

Make a key-value QueryItem

maybeKey :: String -> Maybe String -> Query #

Maybe create a query key

type Query = [QueryItem] #

Query.

General form: a=b&c=d, but if the value is Nothing, it becomes a&c=d.

type QueryItem = (ByteString, Maybe ByteString) #

Query item

lookupKey :: FromJSON a => Text -> Object -> Maybe a #

Look up key in object

lookupKey' :: FromJSON a => Text -> Object -> a #

Like lookupKey but raises an error if no key found