Categorygithub.com/ipfs/go-pinning-service-http-client

# README

go-pinning-service-http-client

This repo is contains a reference implementation of a client for the IPFS Pinning Services API Spec

ā— This repo is no longer maintained.

šŸ‘‰ We highly recommend switching to the maintained version at https://github.com/ipfs/boxo/tree/main/pinning/remote. šŸŽļø Good news! There is tooling and documentation to expedite a switch in your repo.

āš ļø If you continue using this repo, please note that security fixes will not be provided (unless someone steps in to maintain it).

šŸ“š Learn more, including how to take the maintainership mantle or ask questions, here.

Updating Pinning Service Spec

Download the openapi-generator from https://github.com/OpenAPITools/openapi-generator and generate the code using:

Current code generated with: openapi-generator 5.0.0-beta

openapi-generator generate -g go-experimental -i https://raw.githubusercontent.com/ipfs/pinning-services-api-spec/master/ipfs-pinning-service.yaml -o openapi
rm openapi/go.mod openapi/go.sum

Notes: Due to https://github.com/OpenAPITools/openapi-generator/issues/7473 the code generator the http error codes processing may need some manual editing.

go-experimental is becoming mainstream and so in later versions will be replaced with go

License

SPDX-License-Identifier: Apache-2.0 OR MIT

# Packages

No description provided by the author
No description provided by the author

# Functions

Deprecated: use github.com/ipfs/boxo/pinning/remote/client.NewClient.

# Constants

Deprecated: use github.com/ipfs/boxo/pinning/remote/client.StatusFailed.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client.StatusPinned.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client.StatusPinning.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client.StatusQueued.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client.StatusUnknown.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client.UserAgent.

# Variables

Deprecated: use github.com/ipfs/boxo/pinning/remote/client.PinOpts.

# Structs

Deprecated: use github.com/ipfs/boxo/pinning/remote/client.Client.

# Interfaces

PinGetter Getter for Pin object Deprecated: use github.com/ipfs/boxo/pinning/remote/client.PinGetter.
PinStatusGetter Getter for Pin object with status Deprecated: use github.com/ipfs/boxo/pinning/remote/client.PinStatusGetter.

# Type aliases

Deprecated: use github.com/ipfs/boxo/pinning/remote/client.AddOption.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client.LsOption.
Deprecated: use github.com/ipfs/boxo/pinning/remote/client.Status.