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

Fedora.Pagure

Description

Pagure REST client library

Synopsis

pagureProjectInfo :: String -> String -> IO (Either String Object)
pagureListProjects :: String -> Query -> IO Object
pagureListProjectIssues :: String -> String -> Query -> IO (Either String Object)
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 Object
pagureUserForks :: String -> String -> IO [Text]
pagureUserInfo :: String -> String -> Query -> IO (Either String Object)
pagureUserRepos :: String -> String -> IO [Text]
pagureListGroups :: String -> Maybe String -> Query -> IO Object
pagureGroupInfo :: String -> String -> Query -> IO (Either String Object)
pagureProjectGitURLs :: String -> String -> IO (Either String Object)
queryPagure :: String -> String -> Query -> IO Object
queryPagure' :: String -> String -> Query -> IO Object
queryPagureSingle :: String -> String -> Query -> IO (Either String Object)
queryPagurePaged :: String -> String -> Query -> (String, String) -> IO [Object]
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 Object) Source #

Project info

@pagureProjectInfo server "repo" pagureProjectInfo server "namespace/repo"@

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

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

List projects

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

pagureListProjectIssues :: String -> String -> Query -> IO (Either String Object) 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 Object 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 Object) 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 Object Source #

List groups

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

pagureGroupInfo :: String -> String -> Query -> IO (Either String Object) Source #

Group information

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

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

Project Git URLs

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

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

low-level query

queryPagure' :: String -> String -> Query -> IO Object Source #

low-level query Like queryPagure but errors if JSON has "error" field: eg for a non-existent API query path

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

single query

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

get all pages of results

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

Errors for a non-existent API path

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

count total number of hits FIXME: errors if the query fails

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] #

A sequence of QueryItems.

type QueryItem = (ByteString, Maybe ByteString) #

An item from the query string, split up into two parts.

The second part should be Nothing if there was no key-value separator after the query item name.

Since: http-types-0.2.0

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