Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ItemInfo ¶
type ItemInfo struct {
Path string `json:"path"` // Path to the new item, relative to the source
}
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
func (Server) GetMetadataHandler ¶
GetMetadataHandler godoc @Summary Get metadata for a piece @Description Get metadata for a piece for how it may be reassembled from the data source @Tags Piece Metadata @Produce json @Param piece path string true "Piece CID" @Success 200 {object} store.PieceReader @Failure 400 {string} string "Bad Request" @Failure 404 {string} string "Not Found" @Failure 500 {string} string "Internal Server Error" @Router /piece/{id}/metadata [get]
func (Server) HandlePostSource ¶
func (Server) PushItem ¶
PushItem godoc @Summary Push an item to be queued @Description Tells Singularity that something is ready to be grabbed for data preparation @Tags Data Source @Accept json @Produce json @Param item body ItemInfo true "Item" @Success 201 {object} model.Item @Failure 400 {string} string "Bad Request" @Failure 409 {string} string "Item already exists" @Failure 500 {string} string "Internal Server Error" @Router /source/{id}/push [post]