Documentation
¶
Index ¶
- Constants
- Variables
- func DownloadPageContent(ctx context.Context, url string, outputDir string, ...) error
- func GetBodyStorageRawApiResponse(ctx context.Context, url string) (string, error)
- func GetChildPageIds(ctx context.Context, url string, options *GetChildPageOptions) ([]string, error)
- func GetCookieFromEnvVar(ctx context.Context) (string, error)
- func GetPageContent(ctx context.Context, url string, options *GetContentOptions) (string, error)
- func GetPageIdFromUrl(ctx context.Context, url string) (string, error)
- func GetRequest(ctx context.Context, url string) (string, error)
- func GetToken(ctx context.Context) (string, error)
- type DownloadPageContentOptions
- type GetChildPageOptions
- type GetContentOptions
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 GetBodyStorageRawApiResponse ¶ added in v0.470.0
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 GetPageContent ¶
Get the content of a wiki page
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
}
Click to show internal directories.
Click to hide internal directories.