api

package
v1.0.2 Latest Latest
Warning

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

 Go to latest Published: Aug 12, 2024 License: GPL-3.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterCardServer 

func RegisterCardServer(route *mux.Router, srv ICardServer)

func RegisterCollectionServer 

func RegisterCollectionServer(route *mux.Router, srv ICollectionServer)

func RegisterDeckServer 

func RegisterDeckServer(route *mux.Router, srv IDeckServer)

func RegisterGameServer 

func RegisterGameServer(route *mux.Router, srv IGameServer)

func RegisterGeneratorServer 

func RegisterGeneratorServer(route *mux.Router, srv IGeneratorServer)

func RegisterImageServer 

func RegisterImageServer(route *mux.Router, srv IImageServer)

func RegisterReplaceServer added in v0.2.3 

func RegisterReplaceServer(route *mux.Router, srv IReplaceServer)

func RegisterSearchServer added in v0.2.3 

func RegisterSearchServer(route *mux.Router, srv ISearchServer)

func RegisterStaticServer 

func RegisterStaticServer(route *mux.Router)

func RegisterSystemServer 

func RegisterSystemServer(route *mux.Router, srv ISystemServer)

func RegisterTTSServer added in v0.2.3 

func RegisterTTSServer(route *mux.Router, srv ITTSServer)

Types

type ICardServer 

type ICardServer interface {
	CreateHandler(w http.ResponseWriter, r *http.Request)
	DeleteHandler(w http.ResponseWriter, r *http.Request)
	ItemHandler(w http.ResponseWriter, r *http.Request)
	ListHandler(w http.ResponseWriter, r *http.Request)
	UpdateHandler(w http.ResponseWriter, r *http.Request)
}

type ICollectionServer 

type ICollectionServer interface {
	CreateHandler(w http.ResponseWriter, r *http.Request)
	DeleteHandler(w http.ResponseWriter, r *http.Request)
	ItemHandler(w http.ResponseWriter, r *http.Request)
	ListHandler(w http.ResponseWriter, r *http.Request)
	UpdateHandler(w http.ResponseWriter, r *http.Request)
}

type IDeckServer 

type IDeckServer interface {
	AllDecksHandler(w http.ResponseWriter, r *http.Request)
	CreateHandler(w http.ResponseWriter, r *http.Request)
	DeleteHandler(w http.ResponseWriter, r *http.Request)
	ItemHandler(w http.ResponseWriter, r *http.Request)
	ListHandler(w http.ResponseWriter, r *http.Request)
	UpdateHandler(w http.ResponseWriter, r *http.Request)
}

type IGameServer 

type IGameServer interface {
	CreateHandler(w http.ResponseWriter, r *http.Request)
	DeleteHandler(w http.ResponseWriter, r *http.Request)
	DuplicateHandler(w http.ResponseWriter, r *http.Request)
	ExportHandler(w http.ResponseWriter, r *http.Request)
	ImportHandler(w http.ResponseWriter, r *http.Request)
	ItemHandler(w http.ResponseWriter, r *http.Request)
	ListHandler(w http.ResponseWriter, r *http.Request)
	UpdateHandler(w http.ResponseWriter, r *http.Request)
}

type IGeneratorServer 

type IGeneratorServer interface {
	GameHandler(w http.ResponseWriter, r *http.Request)
}

type IImageServer 

type IImageServer interface {
	CardHandler(w http.ResponseWriter, r *http.Request)
	CollectionHandler(w http.ResponseWriter, r *http.Request)
	DeckHandler(w http.ResponseWriter, r *http.Request)
	GameHandler(w http.ResponseWriter, r *http.Request)
}

type IReplaceServer added in v0.2.3 

type IReplaceServer interface {
	PrepareHandler(w http.ResponseWriter, r *http.Request)
	ReplaceHandler(w http.ResponseWriter, r *http.Request)
}

type ISearchServer added in v0.2.3 

type ISearchServer interface {
	RootHandler(w http.ResponseWriter, r *http.Request)
	GameHandler(w http.ResponseWriter, r *http.Request)
	CollectionHandler(w http.ResponseWriter, r *http.Request)
}

type ISystemServer 

type ISystemServer interface {
	QuitHandler(w http.ResponseWriter, r *http.Request)
	GetSettingsHandler(w http.ResponseWriter, r *http.Request)
	UpdateSettingsHandler(w http.ResponseWriter, r *http.Request)
	StatusHandler(w http.ResponseWriter, r *http.Request)
	GetVersionHandler(w http.ResponseWriter, r *http.Request)
}

type ITTSServer added in v0.2.3 

type ITTSServer interface {
	DataHandler(w http.ResponseWriter, r *http.Request)
}

type RequestArchiveGame 

type RequestArchiveGame struct {
	// In: path
	// Required: true
	Game string `json:"game"`
}

Requesting an existing game archive

swagger:parameters RequestArchiveGame

type RequestCard 

type RequestCard struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: path
	// Required: true
	Deck string `json:"deck"`
	// In: path
	// Required: true
	Card int64 `json:"card"`
}

Requesting an existing card

swagger:parameters RequestCard

type RequestCardImage 

type RequestCardImage struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: path
	// Required: true
	Deck string `json:"deck"`
	// In: path
	// Required: true
	Card string `json:"card"`
}

Requesting an image of existing card

swagger:parameters RequestCardImage

type RequestCollection 

type RequestCollection struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
}

Requesting an existing collection

swagger:parameters RequestCollection

type RequestCollectionImage 

type RequestCollectionImage struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
}

Requesting an image of existing collection

swagger:parameters RequestCollectionImage

type RequestCollectionSearch added in v0.2.3 

type RequestCollectionSearch struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: query
	// Required: false
	Sort string `json:"sort"`
	// In: query
	// Required: false
	Search string `json:"search"`
}

Recursive search for all types of objects in the specified game and collection

swagger:parameters RequestCollectionSearch

type RequestCreateCard 

type RequestCreateCard struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: path
	// Required: true
	Deck string `json:"deck"`
	// In: formData
	// Required: true
	Name string `json:"name"`
	// In: formData
	// Required: true
	Description string `json:"description"`
	// In: formData
	// Required: false
	Image string `json:"image"`
	// In: formData
	// Required: false
	Variables string `json:"variables"`
	// In: formData
	// Required: true
	Count int `json:"count"`
	// In: formData
	// Required: false
	ImageFile []byte `json:"imageFile"`
}

Request to create a card

swagger:parameters RequestCreateCard

type RequestCreateCollection 

type RequestCreateCollection struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: formData
	// Required: true
	Name string `json:"name"`
	// In: formData
	// Required: true
	Description string `json:"description"`
	// In: formData
	// Required: false
	Image string `json:"image"`
	// In: formData
	// Required: false
	ImageFile []byte `json:"imageFile"`
}

Request to create a collection

swagger:parameters RequestCreateCollection

type RequestCreateDeck 

type RequestCreateDeck struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: formData
	// Required: true
	Name string `json:"name"`
	// In: formData
	// Required: true
	Description string `json:"description"`
	// In: formData
	// Required: false
	Image string `json:"image"`
	// In: formData
	// Required: false
	ImageFile []byte `json:"imageFile"`
}

Request to create a deck

swagger:parameters RequestCreateDeck

type RequestCreateGame 

type RequestCreateGame struct {
	// In: formData
	// Required: true
	Name string `json:"name"`
	// In: formData
	// Required: true
	Description string `json:"description"`
	// In: formData
	// Required: false
	Image string `json:"image"`
	// In: formData
	// Required: false
	ImageFile []byte `json:"imageFile"`
}

Request to create a game

swagger:parameters RequestCreateGame

type RequestDataTTS added in v0.2.3 

type RequestDataTTS struct {
}

swagger:parameters RequestDataTTS

type RequestDeck 

type RequestDeck struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: path
	// Required: true
	Deck string `json:"deck"`
}

Requesting an existing deck

swagger:parameters RequestDeck

type RequestDeckImage 

type RequestDeckImage struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: path
	// Required: true
	Deck string `json:"deck"`
}

Requesting an image of existing deck

swagger:parameters RequestDeckImage

type RequestDeleteCard 

type RequestDeleteCard struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: path
	// Required: true
	Deck string `json:"deck"`
	// In: path
	// Required: true
	Card string `json:"card"`
}

Request to delete a card

swagger:parameters RequestDeleteCard

type RequestDeleteCollection 

type RequestDeleteCollection struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
}

Request to delete a collection

swagger:parameters RequestDeleteCollection

type RequestDeleteDeck 

type RequestDeleteDeck struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: path
	// Required: true
	Deck string `json:"deck"`
}

Request to delete a deck

swagger:parameters RequestDeleteDeck

type RequestDeleteGame 

type RequestDeleteGame struct {
	// In: path
	// Required: true
	Game string `json:"game"`
}

Request to delete a game

swagger:parameters RequestDeleteGame

type RequestDuplicateGame 

type RequestDuplicateGame struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: body
	// Required: true
	Body struct {
		// Required: true
		dto.DuplicateGameDTO
	}
}

Request to duplicate a game

swagger:parameters RequestDuplicateGame

type RequestGame 

type RequestGame struct {
	// In: path
	// Required: true
	Game string `json:"game"`
}

Requesting an existing game

swagger:parameters RequestGame

type RequestGameGenerate 

type RequestGameGenerate struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: body
	// Required: false
	Body struct {
		dto.GenerateGameDTO
	}
}

Request to start generating result objects

swagger:parameters RequestGameGenerate

type RequestGameImage 

type RequestGameImage struct {
	// In: path
	// Required: true
	Game string `json:"game"`
}

Requesting an image of existing game

swagger:parameters RequestGameImage

type RequestGameSearch added in v0.2.3 

type RequestGameSearch struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: query
	// Required: false
	Sort string `json:"sort"`
	// In: query
	// Required: false
	Search string `json:"search"`
}

Recursive search for all types of objects in the specified game

swagger:parameters RequestGameSearch

type RequestImportGame 

type RequestImportGame struct {
	// Specify a name for the imported game
	// In: formData
	// Required: false
	Name string `json:"name"`
	// Binary data of the imported file
	// In: formData
	// Required: true
	File []byte `json:"file"`
}

Creating game from archive

swagger:parameters RequestImportGame

type RequestListOfAllDecks 

type RequestListOfAllDecks struct {
	// In: path
	// Required: true
	Game string `json:"game"`
}

Requesting a list of all decks in game

swagger:parameters RequestListOfAllDecks

type RequestListOfCard 

type RequestListOfCard struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: path
	// Required: true
	Deck string `json:"deck"`
	// In: query
	// Required: false
	Sort string `json:"sort"`
	// In: query
	// Required: false
	Search string `json:"search"`
}

Requesting a list of existing cards

swagger:parameters RequestListOfCard

type RequestListOfCollections 

type RequestListOfCollections struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: query
	// Required: false
	Sort string `json:"sort"`
	// In: query
	// Required: false
	Search string `json:"search"`
}

Requesting a list of existing collections

swagger:parameters RequestListOfCollections

type RequestListOfDecks 

type RequestListOfDecks struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: query
	// Required: false
	Sort string `json:"sort"`
	// In: query
	// Required: false
	Search string `json:"search"`
}

Requesting a list of existing decks

swagger:parameters RequestListOfDecks

type RequestListOfGames 

type RequestListOfGames struct {
	// In: query
	// Required: false
	Sort string `json:"sort"`
	// In: query
	// Required: false
	Search string `json:"search"`
}

Requesting a list of existing games

swagger:parameters RequestListOfGames

type RequestPrepareReplace added in v0.2.3 

type RequestPrepareReplace struct {
	// Json file
	// In: formData
	// Required: true
	File []byte `json:"file"`
}

swagger:parameters RequestPrepareReplace

type RequestQuit 

type RequestQuit struct {
}

swagger:parameters RequestQuit

type RequestReplaceReplace added in v0.2.3 

type RequestReplaceReplace struct {
	// Json file
	// In: formData
	// Required: true
	File []byte `json:"file"`
	// Json file
	// In: formData
	// Required: true
	Mapping []byte `json:"mapping"`
}

swagger:parameters RequestReplaceReplace

type RequestRootSearch added in v0.2.3 

type RequestRootSearch struct {
	// In: query
	// Required: false
	Sort string `json:"sort"`
	// In: query
	// Required: false
	Search string `json:"search"`
}

Recursive search for all object types

swagger:parameters RequestRootSearch

type RequestSettings 

type RequestSettings struct {
}

swagger:parameters RequestSettings

type RequestStatus 

type RequestStatus struct {
}

swagger:parameters RequestStatus

type RequestUpdateCard 

type RequestUpdateCard struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: path
	// Required: true
	Deck string `json:"deck"`
	// In: path
	// Required: true
	Card string `json:"card"`
	// In: formData
	// Required: true
	Name string `json:"name"`
	// In: formData
	// Required: true
	Description string `json:"description"`
	// In: formData
	// Required: false
	Image string `json:"image"`
	// In: formData
	// Required: false
	Variables string `json:"variables"`
	// In: formData
	// Required: true
	Count int `json:"count"`
	// In: formData
	// Required: false
	ImageFile []byte `json:"imageFile"`
}

Request to update a card

swagger:parameters RequestUpdateCard

type RequestUpdateCollection 

type RequestUpdateCollection struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: formData
	// Required: true
	Name string `json:"name"`
	// In: formData
	// Required: true
	Description string `json:"description"`
	// In: formData
	// Required: false
	Image string `json:"image"`
	// In: formData
	// Required: false
	ImageFile []byte `json:"imageFile"`
}

Request to update a collection

swagger:parameters RequestUpdateCollection

type RequestUpdateDeck 

type RequestUpdateDeck struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: path
	// Required: true
	Collection string `json:"collection"`
	// In: path
	// Required: true
	Deck string `json:"deck"`
	// In: formData
	// Required: true
	Name string `json:"name"`
	// In: formData
	// Required: true
	Description string `json:"description"`
	// In: formData
	// Required: false
	Image string `json:"image"`
	// In: formData
	// Required: false
	ImageFile []byte `json:"imageFile"`
}

Request to update a deck

swagger:parameters RequestUpdateDeck

type RequestUpdateGame 

type RequestUpdateGame struct {
	// In: path
	// Required: true
	Game string `json:"game"`
	// In: formData
	// Required: true
	Name string `json:"name"`
	// In: formData
	// Required: true
	Description string `json:"description"`
	// In: formData
	// Required: false
	Image string `json:"image"`
	// In: formData
	// Required: false
	ImageFile []byte `json:"imageFile"`
}

Request to update a game

swagger:parameters RequestUpdateGame

type RequestUpdateSettings 

type RequestUpdateSettings struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		dto.UpdateSettingsDTO
	}
}

Request to update a settings

swagger:parameters RequestUpdateSettings

type RequestVersion 

type RequestVersion struct {
}

swagger:parameters RequestVersion

type ResponseCard 

type ResponseCard struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data entity.CardInfo `json:"data"`
	}
}

Card

swagger:response ResponseCard

type ResponseCardImage 

type ResponseCardImage struct {
	// In: body
	Body []byte
}

Card image

swagger:response ResponseCardImage

type ResponseCollection 

type ResponseCollection struct {
	// In: body
	Body struct {
		// Required: true
		Data entity.CollectionInfo `json:"data"`
	}
}

Collection

swagger:response ResponseCollection

type ResponseCollectionImage 

type ResponseCollectionImage struct {
	// In: body
	Body []byte
}

Collection image

swagger:response ResponseCollectionImage

type ResponseCollectionSearch added in v0.2.3 

type ResponseCollectionSearch struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data []byte `json:"data"`
		// Required: true
		Meta *network.Meta `json:"meta"`
	}
}

List of found objects

swagger:response ResponseCollectionSearch

type ResponseCreateCard 

type ResponseCreateCard struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data entity.CardInfo `json:"data"`
	}
}

Status of card creation

swagger:response ResponseCreateCard

type ResponseCreateCollection 

type ResponseCreateCollection struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data entity.CollectionInfo `json:"data"`
	}
}

Status of collection creation

swagger:response ResponseCreateCollection

type ResponseCreateDeck 

type ResponseCreateDeck struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data entity.DeckInfo `json:"data"`
	}
}

Status of deck creation

swagger:response ResponseCreateDeck

type ResponseCreateGame 

type ResponseCreateGame struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data entity.GameInfo `json:"data"`
	}
}

Status of game creation

swagger:response ResponseCreateGame

type ResponseDataTTS added in v0.2.3 

type ResponseDataTTS struct {
	// In: body
	Body []byte
}

swagger:response ResponseDataTTS

type ResponseDeck 

type ResponseDeck struct {
	// In: body
	Body struct {
		// Required: true
		Data entity.DeckInfo `json:"data"`
	}
}

Deck

swagger:response ResponseDeck

type ResponseDeckImage 

type ResponseDeckImage struct {
	// In: body
	Body []byte
}

Deck image

swagger:response ResponseDeckImage

type ResponseDeleteCard 

type ResponseDeleteCard struct {
}

Card deletion status

swagger:response ResponseDeleteCard

type ResponseDeleteCollection 

type ResponseDeleteCollection struct {
}

Collection deletion status

swagger:response ResponseDeleteCollection

type ResponseDeleteDeck 

type ResponseDeleteDeck struct {
}

Deck deletion status

swagger:response ResponseDeleteDeck

type ResponseDeleteGame 

type ResponseDeleteGame struct {
}

Game deletion status

swagger:response ResponseDeleteGame

type ResponseDuplicateGame 

type ResponseDuplicateGame struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data entity.GameInfo `json:"data"`
	}
}

Status of game duplicate

swagger:response ResponseDuplicateGame

type ResponseGame 

type ResponseGame struct {
	// In: body
	Body struct {
		// Required: true
		Data entity.GameInfo `json:"data"`
	}
}

Game

swagger:response ResponseGame

type ResponseGameArchive 

type ResponseGameArchive struct {
	// In: body
	Body []byte
}

Game archive

swagger:response ResponseGameArchive

type ResponseGameGenerate 

type ResponseGameGenerate struct {
}

Generating game objects

swagger:response ResponseGameGenerate

type ResponseGameImage 

type ResponseGameImage struct {
	// In: body
	Body []byte
}

Game image

swagger:response ResponseGameImage

type ResponseGameImport 

type ResponseGameImport struct {
	// In: body
	Body struct {
		// Required: true
		Data entity.GameInfo `json:"data"`
	}
}

Import game

swagger:response ResponseGameImport

type ResponseGameSearch added in v0.2.3 

type ResponseGameSearch struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data []byte `json:"data"`
		// Required: true
		Meta *network.Meta `json:"meta"`
	}
}

List of found objects

swagger:response ResponseGameSearch

type ResponseListOfAllDecks 

type ResponseListOfAllDecks struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data []*entity.DeckInfo `json:"data"`
	}
}

List of decks

swagger:response ResponseListOfAllDecks

type ResponseListOfCard 

type ResponseListOfCard struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data []*entity.CardInfo `json:"data"`
		// Required: true
		Meta *network.Meta `json:"meta"`
	}
}

List of cards

swagger:response ResponseListOfCard

type ResponseListOfCollections 

type ResponseListOfCollections struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data []*entity.CollectionInfo `json:"data"`
		// Required: true
		Meta *network.Meta `json:"meta"`
	}
}

List of collections

swagger:response ResponseListOfCollections

type ResponseListOfDecks 

type ResponseListOfDecks struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data []*entity.DeckInfo `json:"data"`
		// Required: true
		Meta *network.Meta `json:"meta"`
	}
}

List of decks

swagger:response ResponseListOfDecks

type ResponseListOfGames 

type ResponseListOfGames struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data []*entity.GameInfo `json:"data"`
		// Required: true
		Meta *network.Meta `json:"meta"`
	}
}

List of games

swagger:response ResponseListOfGames

type ResponsePrepareReplace added in v0.2.3 

type ResponsePrepareReplace struct {
	// In: body
	Body struct {
		// Required: true
		Data []byte `json:"data"`
	}
}

swagger:response ResponsePrepareReplace

type ResponseQuit 

type ResponseQuit struct {
}

Quit

swagger:response ResponseQuit

type ResponseReplaceReplace added in v0.2.3 

type ResponseReplaceReplace struct {
	// In: body
	Body struct {
		// Required: true
		Data []byte `json:"data"`
	}
}

swagger:response ResponseReplaceReplace

type ResponseRootSearch added in v0.2.3 

type ResponseRootSearch struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data []byte `json:"data"`
		// Required: true
		Meta *network.Meta `json:"meta"`
	}
}

List of found objects

swagger:response ResponseRootSearch

type ResponseSettings 

type ResponseSettings struct {
	// In: body
	Body struct {
		// Required: true
		Data entity.SettingInfo `json:"data"`
	}
}

Settings

swagger:response ResponseSettings

type ResponseStatus 

type ResponseStatus struct {
	// In: body
	Body struct {
		// Required: true
		Data entity.Status `json:"data"`
	}
}

Status

swagger:response ResponseStatus

type ResponseUpdateCard 

type ResponseUpdateCard struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data entity.CardInfo `json:"data"`
	}
}

Status of card update

swagger:response ResponseUpdateCard

type ResponseUpdateCollection 

type ResponseUpdateCollection struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data entity.CollectionInfo `json:"data"`
	}
}

Status of collection update

swagger:response ResponseUpdateCollection

type ResponseUpdateDeck 

type ResponseUpdateDeck struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data entity.DeckInfo `json:"data"`
	}
}

Status of deck update

swagger:response ResponseUpdateDeck

type ResponseUpdateGame 

type ResponseUpdateGame struct {
	// In: body
	// Required: true
	Body struct {
		// Required: true
		Data entity.GameInfo `json:"data"`
	}
}

Status of game update

swagger:response ResponseUpdateGame

type ResponseUpdateSettings 

type ResponseUpdateSettings struct {
	// In: body
	Body struct {
		// Required: true
		Data entity.SettingInfo `json:"data"`
	}
}

Settings

swagger:response ResponseUpdateSettings

type ResponseVersion 

type ResponseVersion struct {
	// In: body
	Body struct {
		// Required: true
		Data string `json:"data"`
	}
}

Version

swagger:response ResponseVersion

type UnimplementedCardServer 

type UnimplementedCardServer struct {
}

func (*UnimplementedCardServer) CreateHandler 

func (s *UnimplementedCardServer) CreateHandler(w http.ResponseWriter, r *http.Request)

swagger:route POST /api/games/{game}/collections/{collection}/decks/{deck}/cards Cards RequestCreateCard

Create card

Allows you to create a new card 

Consumes:
- multipart/form-data

Responses:
  200: ResponseCreateCard
  default: ResponseError

func (*UnimplementedCardServer) DeleteHandler 

func (s *UnimplementedCardServer) DeleteHandler(w http.ResponseWriter, r *http.Request)

swagger:route DELETE /api/games/{game}/collections/{collection}/decks/{deck}/cards/{card} Cards RequestDeleteCard

Delete card

Allows you to delete an existing card 

Responses:
  200: ResponseDeleteCard
  default: ResponseError

func (*UnimplementedCardServer) ItemHandler 

func (s *UnimplementedCardServer) ItemHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game}/collections/{collection}/decks/{deck}/cards/{card} Cards RequestCard

Get card

Get an existing card 

Responses:
  200: ResponseCard
  default: ResponseError

func (*UnimplementedCardServer) ListHandler 

func (s *UnimplementedCardServer) ListHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game}/collections/{collection}/decks/{deck}/cards Cards RequestListOfCard

Get cards list

Get a list of existing cards Sort values: name, name_desc, created, created_desc 

Responses:
  200: ResponseListOfCard
  default: ResponseError

func (*UnimplementedCardServer) UpdateHandler 

func (s *UnimplementedCardServer) UpdateHandler(w http.ResponseWriter, r *http.Request)

swagger:route PATCH /api/games/{game}/collections/{collection}/decks/{deck}/cards/{card} Cards RequestUpdateCard

Update card

Allows you to update an existing card 

Consumes:
- multipart/form-data

Responses:
  200: ResponseUpdateCard
  default: ResponseError

type UnimplementedCollectionServer 

type UnimplementedCollectionServer struct {
}

func (*UnimplementedCollectionServer) CreateHandler 

func (s *UnimplementedCollectionServer) CreateHandler(w http.ResponseWriter, r *http.Request)

swagger:route POST /api/games/{game}/collections Collections RequestCreateCollection

Create collection

Allows you to create a new collection 

Consumes:
- multipart/form-data

Responses:
  200: ResponseCreateCollection
  default: ResponseError

func (*UnimplementedCollectionServer) DeleteHandler 

func (s *UnimplementedCollectionServer) DeleteHandler(w http.ResponseWriter, r *http.Request)

swagger:route DELETE /api/games/{game}/collections/{collection} Collections RequestDeleteCollection

Delete collection

Allows you to delete an existing collection 

Responses:
  200: ResponseDeleteCollection
  default: ResponseError

func (*UnimplementedCollectionServer) ItemHandler 

func (s *UnimplementedCollectionServer) ItemHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game}/collections/{collection} Collections RequestCollection

Get collection

Get an existing collection 

Responses:
  200: ResponseCollection
  default: ResponseError

func (*UnimplementedCollectionServer) ListHandler 

func (s *UnimplementedCollectionServer) ListHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game}/collections Collections RequestListOfCollections

Get collections list

Get a list of existing collections Sort values: name, name_desc, created, created_desc 

Responses:
  200: ResponseListOfCollections
  default: ResponseError

func (*UnimplementedCollectionServer) UpdateHandler 

func (s *UnimplementedCollectionServer) UpdateHandler(w http.ResponseWriter, r *http.Request)

swagger:route PATCH /api/games/{game}/collections/{collection} Collections RequestUpdateCollection

Update collection

Allows you to update an existing collection 

Consumes:
- multipart/form-data

Responses:
  200: ResponseUpdateCollection
  default: ResponseError

type UnimplementedDeckServer 

type UnimplementedDeckServer struct {
}

func (*UnimplementedDeckServer) AllDecksHandler 

func (s *UnimplementedDeckServer) AllDecksHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game}/decks Decks RequestListOfAllDecks

Get list of all decks in game

Get a list of all existing decks in game 

Responses:
  200: ResponseListOfAllDecks
  default: ResponseError

func (*UnimplementedDeckServer) CreateHandler 

func (s *UnimplementedDeckServer) CreateHandler(w http.ResponseWriter, r *http.Request)

swagger:route POST /api/games/{game}/collections/{collection}/decks Decks RequestCreateDeck

Create deck

Allows you to create a new deck 

Consumes:
- multipart/form-data

Responses:
  200: ResponseCreateDeck
  default: ResponseError

func (*UnimplementedDeckServer) DeleteHandler 

func (s *UnimplementedDeckServer) DeleteHandler(w http.ResponseWriter, r *http.Request)

swagger:route DELETE /api/games/{game}/collections/{collection}/decks/{deck} Decks RequestDeleteDeck

Delete deck

Allows you to delete an existing deck 

Responses:
  200: ResponseDeleteDeck
  default: ResponseError

func (*UnimplementedDeckServer) ItemHandler 

func (s *UnimplementedDeckServer) ItemHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game}/collections/{collection}/decks/{deck} Decks RequestDeck

Get deck

Get an existing deck 

Responses:
  200: ResponseDeck
  default: ResponseError

func (*UnimplementedDeckServer) ListHandler 

func (s *UnimplementedDeckServer) ListHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game}/collections/{collection}/decks Decks RequestListOfDecks

Get decks list

Get a list of existing decks Sort values: name, name_desc, created, created_desc 

Responses:
  200: ResponseListOfDecks
  default: ResponseError

func (*UnimplementedDeckServer) UpdateHandler 

func (s *UnimplementedDeckServer) UpdateHandler(w http.ResponseWriter, r *http.Request)

swagger:route PATCH /api/games/{game}/collections/{collection}/decks/{deck} Decks RequestUpdateDeck

Update deck

Allows you to update an existing deck 

Consumes:
- multipart/form-data

Responses:
  200: ResponseUpdateDeck
  default: ResponseError

type UnimplementedGameServer 

type UnimplementedGameServer struct {
}

func (*UnimplementedGameServer) CreateHandler 

func (s *UnimplementedGameServer) CreateHandler(w http.ResponseWriter, r *http.Request)

swagger:route POST /api/games Games RequestCreateGame

Create game

Allows you to create a new game 

Consumes:
- multipart/form-data

Responses:
  200: ResponseCreateGame
  default: ResponseError

func (*UnimplementedGameServer) DeleteHandler 

func (s *UnimplementedGameServer) DeleteHandler(w http.ResponseWriter, r *http.Request)

swagger:route DELETE /api/games/{game} Games RequestDeleteGame

Delete game

Allows you to delete an existing game 

Responses:
  200: ResponseDeleteGame
  default: ResponseError

func (*UnimplementedGameServer) DuplicateHandler 

func (s *UnimplementedGameServer) DuplicateHandler(w http.ResponseWriter, r *http.Request)

swagger:route POST /api/games/{game}/duplicate Games RequestDuplicateGame

Duplicate game

Allows you to create a copy of an existing game 

Responses:
  200: ResponseDuplicateGame
  default: ResponseError

func (*UnimplementedGameServer) ExportHandler 

func (s *UnimplementedGameServer) ExportHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game}/export Games RequestArchiveGame

Export game to archive

Get an existing game archive 

Produces:
- application/json
- application/zip

Responses:
  200: ResponseGameArchive
  default: ResponseError

func (*UnimplementedGameServer) ImportHandler 

func (s *UnimplementedGameServer) ImportHandler(w http.ResponseWriter, r *http.Request)

swagger:route POST /api/games/import Games RequestImportGame

Import game from archive

Creat game from archive 

Consumes:
- multipart/form-data

Responses:
  200: ResponseGameImport
  default: ResponseError

func (*UnimplementedGameServer) ItemHandler 

func (s *UnimplementedGameServer) ItemHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game} Games RequestGame

Get game

Get an existing game 

Responses:
  200: ResponseGame
  default: ResponseError

func (*UnimplementedGameServer) ListHandler 

func (s *UnimplementedGameServer) ListHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games Games RequestListOfGames

Get games list

Get a list of existing games Sort values: name, name_desc, created, created_desc 

Responses:
  200: ResponseListOfGames
  default: ResponseError

func (*UnimplementedGameServer) UpdateHandler 

func (s *UnimplementedGameServer) UpdateHandler(w http.ResponseWriter, r *http.Request)

swagger:route PATCH /api/games/{game} Games RequestUpdateGame

Update game

Allows you to update an existing game 

Consumes:
- multipart/form-data

Responses:
  200: ResponseUpdateGame
  default: ResponseError

type UnimplementedGeneratorServer 

type UnimplementedGeneratorServer struct {
}

func (*UnimplementedGeneratorServer) GameHandler 

func (s *UnimplementedGeneratorServer) GameHandler(w http.ResponseWriter, r *http.Request)

swagger:route POST /api/games/{game}/generate Generator RequestGameGenerate

Start generating items for TTS

Allow to run the background process of generating images and json item for the game 

Responses:
  200: ResponseGameGenerate
  default: ResponseError

type UnimplementedImageServer 

type UnimplementedImageServer struct {
}

func (*UnimplementedImageServer) CardHandler 

func (s *UnimplementedImageServer) CardHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game}/collections/{collection}/decks/{deck}/cards/{card}/image Images RequestCardImage

Get card image

Get an image of existing card 

Produces:
- application/json
- image/png
- image/jpeg
- image/gif

Responses:
  200: ResponseCardImage
  default: ResponseError

func (*UnimplementedImageServer) CollectionHandler 

func (s *UnimplementedImageServer) CollectionHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game}/collections/{collection}/image Images RequestCollectionImage

Get collection image

Get an image of existing collection 

Produces:
- application/json
- image/png
- image/jpeg
- image/gif

Responses:
  200: ResponseCollectionImage
  default: ResponseError

func (*UnimplementedImageServer) DeckHandler 

func (s *UnimplementedImageServer) DeckHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game}/collections/{collection}/decks/{deck}/image Images RequestDeckImage

Get deck image

Get an image of existing deck 

Produces:
- application/json
- image/png
- image/jpeg
- image/gif

Responses:
  200: ResponseDeckImage
  default: ResponseError

func (*UnimplementedImageServer) GameHandler 

func (s *UnimplementedImageServer) GameHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/games/{game}/image Images RequestGameImage

Get game image

Get an image of existing game 

Produces:
- application/json
- image/png
- image/jpeg
- image/gif

Responses:
  200: ResponseGameImage
  default: ResponseError

type UnimplementedReplaceServer added in v0.2.3 

type UnimplementedReplaceServer struct {
}

func (*UnimplementedReplaceServer) PrepareHandler added in v0.2.3 

func (s *UnimplementedReplaceServer) PrepareHandler(w http.ResponseWriter, r *http.Request)

swagger:route POST /api/replace/prepare Replace RequestPrepareReplace

Map with key image and empty value for URLs

Takes as input the generated resulting json file for a saved TTS object. As a result, it returns a map of the files that should be uploaded to the web repository and allows you to manually map those files to valid URLs. 

Consumes:
- multipart/form-data

Responses:
  200: ResponsePrepareReplace
  default: ResponseError

func (*UnimplementedReplaceServer) ReplaceHandler added in v0.2.3 

func (s *UnimplementedReplaceServer) ReplaceHandler(w http.ResponseWriter, r *http.Request)

swagger:route POST /api/replace Replace RequestReplaceReplace

Replace all image paths with a mapping file

Accepts as input the generated resulting json file for the saved TTS object and the mapped URL files. This returns a saved TTS object json file with local file paths replaced by URLs. And with these cards you can already save your table and share it with other users. 

Consumes:
- multipart/form-data

Responses:
  200: ResponseReplaceReplace
  default: ResponseError

type UnimplementedSearchServer added in v0.2.3 

type UnimplementedSearchServer struct {
}

func (*UnimplementedSearchServer) CollectionHandler added in v0.2.3 

func (s *UnimplementedSearchServer) CollectionHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/search/games/{game}/collections/{collection} Search RequestCollectionSearch

Recursive search in a particular game and collection

Get a list of all objects that match the search mask and are in a particular game and collection Sort values: name, name_desc, created, created_desc 

Responses:
  200: ResponseCollectionSearch
  default: ResponseError

func (*UnimplementedSearchServer) GameHandler added in v0.2.3 

func (s *UnimplementedSearchServer) GameHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/search/games/{game} Search RequestGameSearch

Recursive search in a particular game

Get a list of all objects that match the search mask and are in a particular game Sort values: name, name_desc, created, created_desc 

Responses:
  200: ResponseGameSearch
  default: ResponseError

func (*UnimplementedSearchServer) RootHandler added in v0.2.3 

func (s *UnimplementedSearchServer) RootHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/search Search RequestRootSearch

Recursive search for all games

Get a list of all objects that matched the search mask Sort values: name, name_desc, created, created_desc 

Responses:
  200: ResponseRootSearch
  default: ResponseError

type UnimplementedSystemServer 

type UnimplementedSystemServer struct {
}

func (*UnimplementedSystemServer) GetSettingsHandler 

func (s *UnimplementedSystemServer) GetSettingsHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/system/settings System RequestSettings

Get settings

Get default or changed settings 

Responses:
  200: ResponseSettings
  default: ResponseError

func (*UnimplementedSystemServer) GetVersionHandler 

func (s *UnimplementedSystemServer) GetVersionHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/system/version System RequestVersion

Get app version

API to get version of application 

Responses:
  200: ResponseVersion
  default: ResponseError

func (*UnimplementedSystemServer) QuitHandler 

func (s *UnimplementedSystemServer) QuitHandler(w http.ResponseWriter, r *http.Request)

swagger:route DELETE /api/system/quit System RequestQuit

Close application

Close app on back side 

Responses:
  200: ResponseQuit
  default: ResponseError

func (*UnimplementedSystemServer) StatusHandler 

func (s *UnimplementedSystemServer) StatusHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/system/status System RequestStatus

Get progress status

API to get status of process 

Responses:
  200: ResponseStatus
  default: ResponseError

func (*UnimplementedSystemServer) UpdateSettingsHandler 

func (s *UnimplementedSystemServer) UpdateSettingsHandler(w http.ResponseWriter, r *http.Request)

swagger:route PATCH /api/system/settings System RequestUpdateSettings

Update settings

API to update settings 

Responses:
  200: ResponseUpdateSettings
  default: ResponseError

type UnimplementedTTSServer added in v0.2.3 

type UnimplementedTTSServer struct {
}

func (*UnimplementedTTSServer) DataHandler added in v0.2.3 

func (s *UnimplementedTTSServer) DataHandler(w http.ResponseWriter, r *http.Request)

swagger:route GET /api/tts/data TTS RequestDataTTS

Get json file from last generator

API for TTS for downloading JSON file inside game 

Responses:
  200: ResponseDataTTS
  default: ResponseError

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.