Copyright	(c) 2020-2024 Jens Petersen
License	GPL-2.0-or-later
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)
pagureGroupRepos :: String -> Bool -> String -> IO [Text]
pagureProjectGitURLs :: String -> String -> IO (Either String Object)
queryPagure :: String -> String -> Query -> IO Object
queryPagureSingle :: String -> String -> Query -> IO (Either String Object)
queryPagureCount :: String -> String -> Query -> String -> IO (Maybe Integer)
queryPagureCountPaged :: String -> Bool -> String -> Query -> (String, String) -> IO [Object]
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
getRepos :: Text -> Object -> [Text]

Documentation

pagureProjectInfo Source #

Arguments

:: String	server
-> String	project
-> IO (Either String Object)

Project info

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

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

pagureListProjects Source #

Arguments

:: String	server
-> Query	parameters
-> IO Object

List projects

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

pagureListProjectIssues Source #

Arguments

:: String	server
-> String	project repo
-> Query	parameters
-> IO (Either String Object)

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

Arguments

:: String	server
-> String	repo
-> Query	parameters
-> IO (Either String [IssueTitleStatus])

List project issue titles

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

pagureProjectIssueInfo Source #

Arguments

:: String	server
-> String	repo
-> Int	issue number
-> IO (Either String Object)

Issue information

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

pagureListGitBranches Source #

Arguments

:: String	server
-> String	repo
-> IO (Either String [String])

List repo branches

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

pagureListGitBranchesWithCommits Source #

Arguments

:: String	server
-> String	repo
-> IO (Either String Object)

List repo branches with commits

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

pagureListUsers Source #

Arguments

:: String	server
-> String	pattern
-> IO Object

List users

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

pagureUserForks Source #

Arguments

:: String	server
-> String	user
-> IO [Text]

list user's forks

pagureUserInfo Source #

Arguments

:: String	server
-> String	user
-> Query	parameters
-> IO (Either String Object)

User information

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

pagureUserRepos Source #

Arguments

:: String	server
-> String	user
-> IO [Text]

list user's repos

pagureListGroups Source #

Arguments

:: String	server
-> Maybe String	optional pattern
-> Query	parameters
-> IO Object

List groups

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

pagureGroupInfo Source #

Arguments

:: String	server
-> String	group
-> Query	parameters
-> IO (Either String Object)

Group information

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

pagureGroupRepos Source #

Arguments

:: String	server
-> Bool	count
-> String	group
-> IO [Text]

list group's repos

pagureProjectGitURLs Source #

Arguments

:: String	server
-> String	repo
-> IO (Either String Object)

Project Git URLs

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

queryPagure Source #

Arguments

:: String	server
-> String	api path
-> Query	parameters
-> IO Object

low-level query

queryPagureSingle Source #

Arguments

:: String	server
-> String	api path
-> Query	parameters
-> IO (Either String Object)

single query

queryPagureCount Source #

Arguments

:: String	server
-> String	api path
-> Query	parameters
-> String	pagination name
-> IO (Maybe Integer)

count total number of hits

queryPagureCountPaged Source #

Arguments

:: String	server
-> Bool	count
-> String	api path
-> Query	parameters
-> (String, String)	pagination and paging names
-> IO [Object]

Get count (with queryPagureCount) or full results (queryPagurePaged)

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 #

getRepos Source #

Arguments

:: Text	field (eg "repos")
-> Object	results page
-> [Text]

helper to extract fullnames of repos