confluence

package module
v0.0.0-...-5e71247 Latest Latest
Warning

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

Go to latest
Published: Aug 7, 2017 License: MIT Imports: 6 Imported by: 0

README

go-confluence

Go library wrapping the confluence REST API.

Currently implemented

  • Authentication:
    • Basic Authentication
    • Token Key authentication
  • Manipulating existing wiki content, i.e:
    • DeleteContent
    • GetContent
    • UpdateContent

This is everything I needed for my project. I might add some more functionality when I find the time. Feel free to send pull requests.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthMethod

type AuthMethod interface {
	// contains filtered or unexported methods
}

func BasicAuth

func BasicAuth(username, password string) AuthMethod

func TokenAuth

func TokenAuth(tokenkey string) AuthMethod

type Content

type Content struct {
	Id     string `json:"id"`
	Type   string `json:"type"`
	Status string `json:"status"`
	Title  string `json:"title"`
	Body   struct {
		Storage struct {
			Value          string `json:"value"`
			Representation string `json:"representation"`
		} `json:"storage"`
	} `json:"body"`
	Version struct {
		Number int `json:"number"`
	} `json:"version"`
}

type Wiki

type Wiki struct {
	// contains filtered or unexported fields
}

func NewWiki

func NewWiki(location string, authMethod AuthMethod) (*Wiki, error)

func (*Wiki) DeleteContent

func (w *Wiki) DeleteContent(contentID string) error

func (*Wiki) GetContent

func (w *Wiki) GetContent(contentID string, expand []string) (*Content, error)

func (*Wiki) UpdateContent

func (w *Wiki) UpdateContent(content *Content) (*Content, error)

Jump to

Keyboard shortcuts

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