Categorygithub.com/kenzo0107/backlog
modulepackage
0.0.0-20250402025348-4c98493f900f
Repository: https://github.com/kenzo0107/backlog.git
Documentation: pkg.go.dev

# README

Backlog API in Go GoDoc test lint codecov

This library supports most if not all of the backlog REST calls.

Installing

go get

$ go get -u github.com/kenzo0107/backlog

Example

Get my user information

package main

import (
	"fmt"
	"os"

	"github.com/kenzo0107/backlog"
)

func main() {
	c := backlog.New("YOUR API KEY", "YOUR BASE URL")

	user, err := c.GetUserMySelf()
	if err != nil {
		fmt.Printf("%s\n", err)
		return
	}
	fmt.Printf("user ID: %d, Name %s\n", user.ID, user.Name)
}

Download space icon

func main() {
	file, err := os.Create("icon.png")
	if err != nil {
		fmt.Println(err)
		return
	}
	defer file.Close()

	c := backlog.New("YOUR API KEY", "YOUR BASE URL")

	if err := c.GetSpaceIcon(file); err != nil {
		fmt.Println(err)
		return
	}
}

Contributing

You are more than welcome to contribute to this project. Fork and make a Pull Request, or create an Issue if you see any problem.

Before making any Pull Request please run the following:

make pr-prep

This will check/update code formatting, linting and then run all tests

License

MIT License

# Packages

No description provided by the author

# Functions

Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.
Int is a helper routine that allocates a new int value to store v and returns a pointer to it.
Int64 is a helper routine that allocates a new int64 value to store v and returns a pointer to it.
New builds a backlog client from the provided token, baseURL and options.
OptionDebug enable debugging for the client.
OptionHTTPClient - provide a custom http client to the backlog client.
OptionLog set logging for client.
String is a helper routine that allocates a new string value to store v and returns a pointer to it.

# Constants

Order by asc, desc.
Order by asc, desc.
RoleType.
RoleType.
RoleType.
RoleType.
RoleType.
RoleType.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.
IssueType is used in sort type.

# Structs

Activity : activity.
AddAttachmentToWikiInput contains all the parameters necessary (including the optional ones) for a AddAttachmentToWiki() request.
AddProjectAdministratorInput specifies parameters to the AddProjectAdministrator method.
AddProjectTeamInput specifies parameters to the AddProjectTeam method.
AddProjectUserInput specifies parameters to the AddProjectUser method.
Attachment : attachment of wiki.
AttachmentInfo : attachment information.
AttributeInfo : attribute information.
Category : category.
Change : -.
ChangeLog : change log.
Client : backlog client.
Comment : -.
Content : -.
CreateCategoryInput specifies parameters to the CreateCategory method.
CreateIssueCommentInput specifies parameters to the CreateIssueComment method.
CreateIssueCommentsNotificationInput specifies parameters to the CreateIssueCommentsNotification method.
CreateIssueInput specifies parameters to the CreateIssue method.
CreateIssueSharedFilesInput specifies parameters to the CreateIssueSharedFiles method.
CreateIssueTypeInput specifies parameters to the CreateIssueType method.
CreateProjectInput contains all the parameters necessary (including the optional ones) for a CreateProject() request.
CreateStatusInput specifies parameters to the CreateStatus method.
CreateTeamInput specifies parameters to the CreateTeam method.
CreateUserInput contains all the parameters necessary (including the optional ones) for a CreateUser() request.
CreateVersionInput specifies parameters to the CreateVersion method.
CreateWatchingInput specifies parameters to the CreateWatching method.
CreateWebhookInput contains all the parameters necessary (including the optional ones) for a CreateWebhook() request.
CreateWikiInput contains all the parameters necessary (including the optional ones) for a CreateWiki() request.
CustomField : custom field.
DeleteIssueTypeInput specifies parameters to the DeleteIssueType method.
DeleteProjectAdministratorInput specifies parameters to the DeleteProjectAdministrator method.
DeleteProjectTeamInput specifies parameters to the DeleteProjectTeam method.
DeleteProjectUserInput specifies parameters to the DeleteProjectUser method.
DeleteStatusInput specifies parameters to the DeleteStatus method.
Error is backlog error.
ErrorResponse is backlog error response.
FileUploadResponse : response of uploading file.
GetIssueCommentsOptions specifies parameters to the GetIssueComments method.
GetIssuesCountOptions specifies parameters to the GetIssueCount method.
GetIssuesOptions specifies parameters to the GetIssues method.
GetMyRecentlyViewedProjectsOptions specifies parameters to the GetMyRecentlyViewedProject method.
GetMyRecentlyViewedWikisOptions specifies parameters to the GetMyRecentlyViewedWikis method.
GetProjectActivitiesOptions specifies parameters to the GetProjectActivities method.
GetProjectsOptions contains all the parameters necessary (including the optional ones) for a GetProjects() request.
GetProjectUsersOptions specifies parameters to the GetProjectUsers method.
GetTeamsOptions specifies parameters to the GetTeams method.
GetUserActivitiesOptions specifies parameters to the GetUserActivities method.
GetUserMySelfRecentrlyViewedIssuesOptions specifies parameters to the GetUserMySelfRecentrlyViewedIssues method.
GetUserStarCountOptions specifies parameters to the GetUserStarCount method.
GetUserStarsOptions specifies parameters to the GetUserStars method.
GetUserWatchingsCountOptions specifies parameters to the GetUserWatchingsCount method.
GetUserWatchingsOptions specifies parameters to the GetUserWatchings method.
GetWikiCountOptions specifies parameters to the GetWikiCount method.
GetWikisOptions specifies parameters to the GetWikis method.
GetWikiTagsOptions specifies parameters to the GetWikiTags method.
Issue : -.
IssueComment : issue comment.
IssueCustomField : custom field in issue.
IssueType : issue type.
Item : item.
License : license.
LimitStatus : limit status.
Milestone : milestone.
Notification : -.
NotificationInfo : notification information.
Page : wiki page information.
Priority : priority.
Project : project.
ProjectDiskUsage : disk usage of project.
RateLimit : rate limit.
RecentlyViewedProject : recently viewed project.
RecentlyViewedWiki : recently viewed wiki.
Resolution : resolutions.
ResponseIssue : response of issue api.
ResponseRateLimit : rate limit API response.
SharedFile : shared file of wiki.
SortStatusesInput specifies parameters to the SortStatuses method.
Space : backlog space.
SpaceDiskUsage : disk usage of space.
SpaceDiskUsageDetail : the detail of disk usage of a space.
SpaceNotification : backlog space notification.
Star : star of wiki.
Status : the status of project.
Tag : tag.
Team : team.
Timestamp represents a time that can be unmarshalled from a JSON string formatted as either an RFC3339 or Unix timestamp.
UpdateCategoryInput specifies parameters to the UpdateCategory method.
UpdateIssueCommentInput specifies parameters to the UpdateIssueComment method.
UpdateIssueInput specifies parameters to the UpdateIssue method.
UpdateIssueTypeInput specifies parameters to the UpdateIssueType method.
UpdateProjectInput contains all the parameters necessary (including the optional ones) for a UpdateProject() request.
UpdateSpaceNotificationInput contains all the parameters necessary (including the optional ones) for a UpdateSpaceNotification() request.
UpdateStatusInput specifies parameters to the UpdateStatus method.
UpdateTeamInput specifies parameters to the UpdateTeam method.
UpdateUserInput contains all the parameters necessary (including the optional ones) for a UpdateUser() request.
UpdateVersionInput specifies parameters to the UpdateVersion method.
UpdateWatchingInput specifies parameters to the UpdateWatching method.
UpdateWebhookInput contains all the parameters necessary (including the optional ones) for a UpdateWebhook() request.
UpdateWikiInput contains all the parameters necessary (including the optional ones) for a UpdateWiki() request.
User : backlog user.
Version : milestone.
Watching : -.
Webhook : -.
Wiki : wiki.

# Type aliases

Issues : list of issue.
Option defines an option for a Client.
Order : asc or desc.
RoleType : role type.
Sort : sort.