api

Documentation

Index

• type Account
  • func (a *Account) Get() (models.Account, error)
• type Author
  • func (a *Author) Get(username string) (models.Author, error)
• type Book
  • func (b *Book) Get(bookId string) (models.Book, error)
• type Books
  • func (b *Books) List() ([]models.Book, error)
• type BuildOptions
• type Builds
  • func (b *Builds) Build(bookId, version, path string, opts BuildOptions) error
  • func (b *Builds) BuildFolder(bookId, version, path string, opts BuildOptions) error
  • func (b *Builds) BuildGit(bookId, version, path, ref string, opts BuildOptions) error
  • func (b *Builds) BuildTarGz(bookId, version, path string, opts BuildOptions) error
  • func (b *Builds) PublishBuildStream(bookId, version string, reader io.Reader, opts BuildOptions) error

Types

type Account

type Account struct {
	Client *client.Client
}

func (*Account) Get

func (a *Account) Get() (models.Account, error)

Get returns a books details for a given "bookId" (for example "gitbookio/javascript")

type Author

type Author struct {
	Client *client.Client
}

func (*Author) Get

func (a *Author) Get(username string) (models.Author, error)

type Book

type Book struct {
	Client *client.Client
}

func (*Book) Get

func (b *Book) Get(bookId string) (models.Book, error)

Get returns a books details for a given "bookId" (for example "gitbookio/javascript")

type Books

type Books struct {
	Client *client.Client
}

func (*Books) List

func (b *Books) List() ([]models.Book, error)

type BuildOptions

type BuildOptions models.Build

BuildOptions are optional data passed along when doing a build (e.g: branch, message, author, ...)

type Builds

type Builds struct {
	Client *client.Client
}

func (*Builds) Build

func (b *Builds) Build(bookId, version, path string, opts BuildOptions) error

Build should only be used by internal clients, Publish by others Build starts a build and will not update the backing git repository

func (*Builds) BuildFolder

func (b *Builds) BuildFolder(bookId, version, path string, opts BuildOptions) error

PublishFolder packages a folder as tar.gz and uploads it to gitbook.io

func (*Builds) BuildGit

func (b *Builds) BuildGit(bookId, version, path, ref string, opts BuildOptions) error

PublishGit packages a git repo as tar.gz and uploads it to gitbook.io

func (*Builds) BuildTarGz

func (b *Builds) BuildTarGz(bookId, version, path string, opts BuildOptions) error

PublishTarGz publishes a book based on a tar.gz file

func (*Builds) PublishBuildStream

func (b *Builds) PublishBuildStream(bookId, version string, reader io.Reader, opts BuildOptions) error