ipfs-cluster/api/rest/client
Hector Sanjuan 7c636061bd
Improve pin/unpin method signatures (#843)
* Improve pin/unpin method signatures:

These changes the following Cluster Go API methods:

* -> Cluster.Pin(ctx, cid, options) (pin, error)
* -> Cluster.Unpin(ctx, cid) (pin, error)
* -> Cluster.PinPath(ctx, path, opts) (pin,error)

Pin and Unpin now return the pinned object.

The signature of the methods now matches that of the API Client, is clearer as
to what options the user can set and is aligned with PinPath, UnpinPath, which
returned pin methods.

The REST API now returns the Pinned/Unpinned object rather than 204-Accepted.

This was necessary for a cleaner pin/update approach, which I'm working on in
another branch.

Most of the changes here are updating tests to the new signatures

* Adapt load-balancing client to new Pin/Unpin signatures

* cluster.go: Fix typo

Co-Authored-By: Kishan Sagathiya <kishansagathiya@gmail.com>

* cluster.go: Fix typo

Co-Authored-By: Kishan Sagathiya <kishansagathiya@gmail.com>
2019-07-22 15:39:11 +02:00
..
.travis.yml Fix #260: Add REST API client and use it in ipfs-cluster-ctl 2017-12-06 20:12:01 +01:00
client_test.go Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02:00
client.go Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02:00
lbclient_test.go Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02:00
lbclient.go Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02:00
methods_test.go Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02:00
methods.go Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02:00
README.md Fix #765 Added needed gx references 2019-07-04 13:57:52 +01:00
request.go add opencensus tracing and metrics 2019-02-04 18:53:21 +10:00
transports.go Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02:00

ipfs-cluster client

Made by Main project IRC channel standard-readme compliant GoDoc Go Report Card Build Status Coverage Status

Go client for ipfs-cluster HTTP API.

This is a Go client library to use the ipfs-cluster REST HTTP API.

Table of Contents

Install

You can import github.com/ipfs/ipfs-cluster/api/rest/client in your code.

The code can be downloaded and tested with:

$ go get -u -d github.com/ipfs/ipfs-cluster
$ cd $GOPATH/src/github.com/ipfs/ipfs-cluster/rest/api/client
$ go test -v

Usage

Documentation can be read at Godoc.

Contribute

PRs accepted.

License

MIT © Protocol Labs