api

README

view documentation :

Use go-swagger (https://github.com/go-swagger/go-swagger) go get -u github.com/go-swagger/go-swagger/cmd/swagger

Serve documentation from swagger specification swagger server swagger.json

Documentation

Overview

Bitfan API.

the purpose of this api....

This should demonstrate all the possible comment annotations that are available to turn go code into a fully compliant swagger 2.0 spec

Terms Of Service:

there are no TOS

Host: 127.0.0.1:5123 BasePath: /api/v1 Version: 0.0.1 License: Apache 2.0 http://www.apache.org/licenses/LICENSE-2.0.html Contact: Valere JEANTET<valere.jeantet@gmail.com> http://vjeantet.fr Schemes: http

Consumes: - application/json

Produces: - application/json

swagger:meta

Index

• func ServeREST(hostport string, plugs map[string]map[string]core.ProcessorFactory)
• type Error
• type Pipeline
• type RestClient
  • func NewRestClient(bitfanHost string) *RestClient
  • func (r *RestClient) AddPipeline(pipeline *Pipeline) (*Pipeline, error)
  • func (r *RestClient) ListDoc() error
  • func (r *RestClient) ListPipelines() ([]*Pipeline, error)
  • func (r *RestClient) StopPipeline(ID string) error
  • func (r *RestClient) Test()

Functions

func ServeREST

func ServeREST(hostport string, plugs map[string]map[string]core.ProcessorFactory)

Types

type Error

type Error struct {
	Message string `json:"error"`
}

Error represents a error

A Error is ....

A Error can have.....

swagger:model Error

type Pipeline

type Pipeline struct {
	// the id for this pipeline
	ID int `json:"id"`
	// the Label
	// min length: 3
	Label string `json:"label"`
	// the location
	ConfigLocation string `json:"config_location"`
	// the location's host
	ConfigHostLocation string `json:"config_host_location"`

	Content string `json:"config_content"`
}

Pipeline represents a pipeline

A Pipeline is ....

A Pipeline can have.....

swagger:model Pipeline

type RestClient

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

func NewRestClient

func NewRestClient(bitfanHost string) *RestClient

func (*RestClient) AddPipeline

func (r *RestClient) AddPipeline(pipeline *Pipeline) (*Pipeline, error)

func (*RestClient) ListDoc

func (r *RestClient) ListDoc() error

func (*RestClient) ListPipelines

func (r *RestClient) ListPipelines() ([]*Pipeline, error)

func (*RestClient) StopPipeline

func (r *RestClient) StopPipeline(ID string) error

func (*RestClient) Test

func (r *RestClient) Test()