atlassianconfluenceutils

package
v0.470.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 22, 2025 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source
const CookieEnvVarName = "ATLASSIAN_CONFLUENCE_COOKIE"
View Source
const TokenEnvVarName = "ATLASSIAN_CONFLUENCE_TOKEN"

Variables

View Source
var ErrCookieNotSet = errors.New("atlassian Confluence wiki cookie not set in the env var '" + CookieEnvVarName + "'")
View Source
var ErrTokenNotSet = errors.New("atlassian Confluence wiki token not set in the env var '" + TokenEnvVarName + "'")

Functions

func DownloadPageContent added in v0.470.0

func DownloadPageContent(ctx context.Context, url string, outputDir string, options *DownloadPageContentOptions) error

func GetBodyStorageRawApiResponse added in v0.470.0

func GetBodyStorageRawApiResponse(ctx context.Context, url string) (string, error)

Get the raw response of the API for the wiki page body.storage:

func GetChildPageIds added in v0.470.0

func GetChildPageIds(ctx context.Context, url string, options *GetChildPageOptions) ([]string, error)

Returns a slice of the page Id's of all subpages:

func GetCookieFromEnvVar

func GetCookieFromEnvVar(ctx context.Context) (string, error)

func GetPageContent

func GetPageContent(ctx context.Context, url string, options *GetContentOptions) (string, error)

Get the content of a wiki page

func GetPageIdFromUrl

func GetPageIdFromUrl(ctx context.Context, url string) (string, error)

func GetRequest

func GetRequest(ctx context.Context, url string) (string, error)

func GetToken

func GetToken(ctx context.Context) (string, error)

Types

type DownloadPageContentOptions added in v0.470.0

type DownloadPageContentOptions struct {
	// If set to true the child pages are downloaded as well.
	Recursive bool
}

type GetChildPageOptions added in v0.470.0

type GetChildPageOptions struct {
	// Perform a recursive collection of subpages.
	Recursive bool
}

type GetContentOptions

type GetContentOptions struct {
	PrettyPrint bool
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL