openapi

package
v0.19.0 Latest Latest
Warning

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

 Go to latest Published: Apr 9, 2024 License: Apache-2.0, MIT Imports: 20 Imported by: 1

README

Go API client for openapi

About this spec

The IPFS Pinning Service API is intended to be an implementation-agnostic API:

  • For use and implementation by pinning service providers
  • For use in client mode by IPFS nodes and GUI-based applications

Note: while ready for implementation, this spec is still a work in progress! 🏗️ Your input and feedback are welcome and valuable as we develop this API spec. Please join the design discussion at github.com/ipfs/pinning-services-api-spec.

Schemas

This section describes the most important object types and conventions.

A full list of fields and schemas can be found in the schemas section of the YAML file.

Identifiers

cid

Content Identifier (CID) points at the root of a DAG that is pinned recursively.

requestid

Unique identifier of a pin request.

When a pin is created, the service responds with unique requestid that can be later used for pin removal. When the same cid is pinned again, a different requestid is returned to differentiate between those pin requests.

Service implementation should use UUID, hash(accessToken,Pin,PinStatus.created), or any other opaque identifier that provides equally strong protection against race conditions.

Objects

Pin object

pin object

The Pin object is a representation of a pin request.

It includes the cid of data to be pinned, as well as optional metadata in name, origins, and meta.

Pin status response

pin status response object

The PinStatus object is a representation of the current state of a pinning operation. It includes the original pin object, along with the current status and globally unique requestid of the entire pinning request, which can be used for future status checks and management. Addresses in the delegates array are peers delegated by the pinning service for facilitating direct file transfers (more details in the provider hints section). Any additional vendor-specific information is returned in optional info.

The pin lifecycle

pinning service objects and lifecycle

Creating a new pin object

The user sends a Pin object to POST /pins and receives a PinStatus response:

  • requestid in PinStatus is the identifier of the pin operation, which can can be used for checking status, and removing the pin in the future
  • status in PinStatus indicates the current state of a pin
Checking status of in-progress pinning

status (in PinStatus) may indicate a pending state (queued or pinning). This means the data behind Pin.cid was not found on the pinning service and is being fetched from the IPFS network at large, which may take time.

In this case, the user can periodically check pinning progress via GET /pins/{requestid} until pinning is successful, or the user decides to remove the pending pin.

Replacing an existing pin object

The user can replace an existing pin object via POST /pins/{requestid}. This is a shortcut for removing a pin object identified by requestid and creating a new one in a single API call that protects against undesired garbage collection of blocks common to both pins. Useful when updating a pin representing a huge dataset where most of blocks did not change. The new pin object requestid is returned in the PinStatus response. The old pin object is deleted automatically.

Removing a pin object

A pin object can be removed via DELETE /pins/{requestid}.

Provider hints

Pinning of new data can be accelerated by providing a list of known data sources in Pin.origins, and connecting at least one of them to pinning service nodes at PinStatus.delegates.

The most common scenario is a client putting its own IPFS node's multiaddrs in Pin.origins, and then directly connecting to every multiaddr returned by a pinning service in PinStatus.delegates to initiate transfer.

This ensures data transfer starts immediately (without waiting for provider discovery over DHT), and direct dial from a client works around peer routing issues in restrictive network topologies such as NATs.

Custom metadata

Pinning services are encouraged to add support for additional features by leveraging the optional Pin.meta and PinStatus.info fields. While these attributes can be application- or vendor-specific, we encourage the community at large to leverage these attributes as a sandbox to come up with conventions that could become part of future revisions of this API.

Pin metadata

String keys and values passed in Pin.meta are persisted with the pin object.

Potential uses:

  • Pin.meta[app_id]: Attaching a unique identifier to pins created by an app enables filtering pins per app via ?meta={\"app_id\":<UUID>}
  • Pin.meta[vendor_policy]: Vendor-specific policy (for example: which region to use, how many copies to keep)

Note that it is OK for a client to omit or ignore these optional attributes; doing so should not impact the basic pinning functionality.

Pin status info

Additional PinStatus.info can be returned by pinning service.

Potential uses:

  • PinStatus.info[status_details]: more info about the current status (queue position, percentage of transferred data, summary of where data is stored, etc); when PinStatus.status=failed, it could provide a reason why a pin operation failed (e.g. lack of funds, DAG too big, etc.)
  • PinStatus.info[dag_size]: the size of pinned data, along with DAG overhead
  • PinStatus.info[raw_size]: the size of data without DAG overhead (eg. unixfs)
  • PinStatus.info[pinned_until]: if vendor supports time-bound pins, this could indicate when the pin will expire

Pagination and filtering

Pin objects can be listed by executing GET /pins with optional parameters:

  • When no filters are provided, the endpoint will return a small batch of the 10 most recently created items, from the latest to the oldest.
  • The number of returned items can be adjusted with the limit parameter (implicit default is 10).
  • If the value in PinResults.count is bigger than the length of PinResults.results, the client can infer there are more results that can be queried.
  • To read more items, pass the before filter with the timestamp from PinStatus.created found in the oldest item in the current batch of results. Repeat to read all results.
  • Returned results can be fine-tuned by applying optional after, cid, name, status, or meta filters.

Note: pagination by the created timestamp requires each value to be globally unique. Any future considerations to add support for bulk creation must account for this.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 0.1.1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./openapi"

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://pinning-service.example.com

Class Method HTTP request Description
PinsApi PinsGet Get /pins List pin objects
PinsApi PinsPost Post /pins Add pin object
PinsApi PinsRequestidDelete Delete /pins/{requestid} Remove pin object
PinsApi PinsRequestidGet Get /pins/{requestid} Get pin object
PinsApi PinsRequestidPost Post /pins/{requestid} Replace pin object

Documentation For Models

Documentation For Authorization

accessToken

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given integer value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	PinsApi *PinsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the IPFS Pinning Service API API v0.1.1 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type Failure 

type Failure struct {
	Error FailureError `json:"error"`
}

Failure Response for a failed request

func NewFailure 

func NewFailure(error_ FailureError) *Failure

NewFailure instantiates a new Failure object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewFailureWithDefaults 

func NewFailureWithDefaults() *Failure

NewFailureWithDefaults instantiates a new Failure object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Failure) GetError 

func (o *Failure) GetError() FailureError

GetError returns the Error field value

func (*Failure) GetErrorOk 

func (o *Failure) GetErrorOk() (*FailureError, bool)

GetErrorOk returns a tuple with the Error field value and a boolean to check if the value has been set.

func (Failure) MarshalJSON 

func (o Failure) MarshalJSON() ([]byte, error)

func (*Failure) SetError 

func (o *Failure) SetError(v FailureError)

SetError sets field value

type FailureError 

type FailureError struct {
	// Mandatory string identifying the type of error
	Reason string `json:"reason"`
	// Optional, longer description of the error; may include UUID of transaction for support, links to documentation etc
	Details *string `json:"details,omitempty"`
}

FailureError struct for FailureError

func NewFailureError 

func NewFailureError(reason string) *FailureError

NewFailureError instantiates a new FailureError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewFailureErrorWithDefaults 

func NewFailureErrorWithDefaults() *FailureError

NewFailureErrorWithDefaults instantiates a new FailureError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*FailureError) GetDetails 

func (o *FailureError) GetDetails() string

GetDetails returns the Details field value if set, zero value otherwise.

func (*FailureError) GetDetailsOk 

func (o *FailureError) GetDetailsOk() (*string, bool)

GetDetailsOk returns a tuple with the Details field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FailureError) GetReason 

func (o *FailureError) GetReason() string

GetReason returns the Reason field value

func (*FailureError) GetReasonOk 

func (o *FailureError) GetReasonOk() (*string, bool)

GetReasonOk returns a tuple with the Reason field value and a boolean to check if the value has been set.

func (*FailureError) HasDetails 

func (o *FailureError) HasDetails() bool

HasDetails returns a boolean if a field has been set.

func (FailureError) MarshalJSON 

func (o FailureError) MarshalJSON() ([]byte, error)

func (*FailureError) SetDetails 

func (o *FailureError) SetDetails(v string)

SetDetails gets a reference to the given string and assigns it to the Details field.

func (*FailureError) SetReason 

func (o *FailureError) SetReason(v string)

SetReason sets field value

type GenericOpenAPIError 

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

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type NullableBool 

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

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableFailure 

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

func NewNullableFailure 

func NewNullableFailure(val *Failure) *NullableFailure

func (NullableFailure) Get 

func (v NullableFailure) Get() *Failure

func (NullableFailure) IsSet 

func (v NullableFailure) IsSet() bool

func (NullableFailure) MarshalJSON 

func (v NullableFailure) MarshalJSON() ([]byte, error)

func (*NullableFailure) Set 

func (v *NullableFailure) Set(val *Failure)

func (*NullableFailure) UnmarshalJSON 

func (v *NullableFailure) UnmarshalJSON(src []byte) error

func (*NullableFailure) Unset 

func (v *NullableFailure) Unset()

type NullableFailureError 

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

func NewNullableFailureError 

func NewNullableFailureError(val *FailureError) *NullableFailureError

func (NullableFailureError) Get 

func (v NullableFailureError) Get() *FailureError

func (NullableFailureError) IsSet 

func (v NullableFailureError) IsSet() bool

func (NullableFailureError) MarshalJSON 

func (v NullableFailureError) MarshalJSON() ([]byte, error)

func (*NullableFailureError) Set 

func (v *NullableFailureError) Set(val *FailureError)

func (*NullableFailureError) UnmarshalJSON 

func (v *NullableFailureError) UnmarshalJSON(src []byte) error

func (*NullableFailureError) Unset 

func (v *NullableFailureError) Unset()

type NullableFloat32 

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

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

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

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableInt 

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

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

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

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

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

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullablePin 

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

func NewNullablePin 

func NewNullablePin(val *Pin) *NullablePin

func (NullablePin) Get 

func (v NullablePin) Get() *Pin

func (NullablePin) IsSet 

func (v NullablePin) IsSet() bool

func (NullablePin) MarshalJSON 

func (v NullablePin) MarshalJSON() ([]byte, error)

func (*NullablePin) Set 

func (v *NullablePin) Set(val *Pin)

func (*NullablePin) UnmarshalJSON 

func (v *NullablePin) UnmarshalJSON(src []byte) error

func (*NullablePin) Unset 

func (v *NullablePin) Unset()

type NullablePinResults 

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

func NewNullablePinResults 

func NewNullablePinResults(val *PinResults) *NullablePinResults

func (NullablePinResults) Get 

func (v NullablePinResults) Get() *PinResults

func (NullablePinResults) IsSet 

func (v NullablePinResults) IsSet() bool

func (NullablePinResults) MarshalJSON 

func (v NullablePinResults) MarshalJSON() ([]byte, error)

func (*NullablePinResults) Set 

func (v *NullablePinResults) Set(val *PinResults)

func (*NullablePinResults) UnmarshalJSON 

func (v *NullablePinResults) UnmarshalJSON(src []byte) error

func (*NullablePinResults) Unset 

func (v *NullablePinResults) Unset()

type NullablePinStatus 

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

func NewNullablePinStatus 

func NewNullablePinStatus(val *PinStatus) *NullablePinStatus

func (NullablePinStatus) Get 

func (v NullablePinStatus) Get() *PinStatus

func (NullablePinStatus) IsSet 

func (v NullablePinStatus) IsSet() bool

func (NullablePinStatus) MarshalJSON 

func (v NullablePinStatus) MarshalJSON() ([]byte, error)

func (*NullablePinStatus) Set 

func (v *NullablePinStatus) Set(val *PinStatus)

func (*NullablePinStatus) UnmarshalJSON 

func (v *NullablePinStatus) UnmarshalJSON(src []byte) error

func (*NullablePinStatus) Unset 

func (v *NullablePinStatus) Unset()

type NullableStatus 

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

func NewNullableStatus 

func NewNullableStatus(val *Status) *NullableStatus

func (NullableStatus) Get 

func (v NullableStatus) Get() *Status

func (NullableStatus) IsSet 

func (v NullableStatus) IsSet() bool

func (NullableStatus) MarshalJSON 

func (v NullableStatus) MarshalJSON() ([]byte, error)

func (*NullableStatus) Set 

func (v *NullableStatus) Set(val *Status)

func (*NullableStatus) UnmarshalJSON 

func (v *NullableStatus) UnmarshalJSON(src []byte) error

func (*NullableStatus) Unset 

func (v *NullableStatus) Unset()

type NullableString 

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

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

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

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type Pin 

type Pin struct {
	// Content Identifier (CID) to be pinned recursively
	Cid string `json:"cid"`
	// Optional name for pinned data; can be used for lookups later
	Name *string `json:"name,omitempty"`
	// Optional list of multiaddrs known to provide the data
	Origins *[]string `json:"origins,omitempty"`
	// Optional metadata for pin object
	Meta *map[string]string `json:"meta,omitempty"`
}

Pin Pin object

func NewPin 

func NewPin(cid string) *Pin

NewPin instantiates a new Pin object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPinWithDefaults 

func NewPinWithDefaults() *Pin

NewPinWithDefaults instantiates a new Pin object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Pin) GetCid 

func (o *Pin) GetCid() string

GetCid returns the Cid field value

func (*Pin) GetCidOk 

func (o *Pin) GetCidOk() (*string, bool)

GetCidOk returns a tuple with the Cid field value and a boolean to check if the value has been set.

func (*Pin) GetMeta 

func (o *Pin) GetMeta() map[string]string

GetMeta returns the Meta field value if set, zero value otherwise.

func (*Pin) GetMetaOk 

func (o *Pin) GetMetaOk() (*map[string]string, bool)

GetMetaOk returns a tuple with the Meta field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Pin) GetName 

func (o *Pin) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*Pin) GetNameOk 

func (o *Pin) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Pin) GetOrigins 

func (o *Pin) GetOrigins() []string

GetOrigins returns the Origins field value if set, zero value otherwise.

func (*Pin) GetOriginsOk 

func (o *Pin) GetOriginsOk() (*[]string, bool)

GetOriginsOk returns a tuple with the Origins field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Pin) HasMeta 

func (o *Pin) HasMeta() bool

HasMeta returns a boolean if a field has been set.

func (*Pin) HasName 

func (o *Pin) HasName() bool

HasName returns a boolean if a field has been set.

func (*Pin) HasOrigins 

func (o *Pin) HasOrigins() bool

HasOrigins returns a boolean if a field has been set.

func (Pin) MarshalJSON 

func (o Pin) MarshalJSON() ([]byte, error)

func (*Pin) SetCid 

func (o *Pin) SetCid(v string)

SetCid sets field value

func (*Pin) SetMeta 

func (o *Pin) SetMeta(v map[string]string)

SetMeta gets a reference to the given map[string]string and assigns it to the Meta field.

func (*Pin) SetName 

func (o *Pin) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*Pin) SetOrigins 

func (o *Pin) SetOrigins(v []string)

SetOrigins gets a reference to the given []string and assigns it to the Origins field.

type PinResults 

type PinResults struct {
	// The total number of pin objects that exist for passed query filters
	Count int32 `json:"count"`
	// An array of PinStatus results
	Results []PinStatus `json:"results"`
}

PinResults Response used for listing pin objects matching request

func NewPinResults 

func NewPinResults(count int32, results []PinStatus) *PinResults

NewPinResults instantiates a new PinResults object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPinResultsWithDefaults 

func NewPinResultsWithDefaults() *PinResults

NewPinResultsWithDefaults instantiates a new PinResults object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PinResults) GetCount 

func (o *PinResults) GetCount() int32

GetCount returns the Count field value

func (*PinResults) GetCountOk 

func (o *PinResults) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*PinResults) GetResults 

func (o *PinResults) GetResults() []PinStatus

GetResults returns the Results field value

func (*PinResults) GetResultsOk 

func (o *PinResults) GetResultsOk() (*[]PinStatus, bool)

GetResultsOk returns a tuple with the Results field value and a boolean to check if the value has been set.

func (PinResults) MarshalJSON 

func (o PinResults) MarshalJSON() ([]byte, error)

func (*PinResults) SetCount 

func (o *PinResults) SetCount(v int32)

SetCount sets field value

func (*PinResults) SetResults 

func (o *PinResults) SetResults(v []PinStatus)

SetResults sets field value

type PinStatus 

type PinStatus struct {
	// Globally unique identifier of the pin request; can be used to check the status of ongoing pinning, or pin removal
	Requestid string `json:"requestid"`
	Status    Status `json:"status"`
	// Immutable timestamp indicating when a pin request entered a pinning service; can be used for filtering results and pagination
	Created time.Time `json:"created"`
	Pin     Pin       `json:"pin"`
	// List of multiaddrs designated by pinning service for transferring any new data from external peers
	Delegates []string `json:"delegates"`
	// Optional info for PinStatus response
	Info *map[string]string `json:"info,omitempty"`
}

PinStatus Pin object with status

func NewPinStatus 

func NewPinStatus(requestid string, status Status, created time.Time, pin Pin, delegates []string) *PinStatus

NewPinStatus instantiates a new PinStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPinStatusWithDefaults 

func NewPinStatusWithDefaults() *PinStatus

NewPinStatusWithDefaults instantiates a new PinStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PinStatus) GetCreated 

func (o *PinStatus) GetCreated() time.Time

GetCreated returns the Created field value

func (*PinStatus) GetCreatedOk 

func (o *PinStatus) GetCreatedOk() (*time.Time, bool)

GetCreatedOk returns a tuple with the Created field value and a boolean to check if the value has been set.

func (*PinStatus) GetDelegates 

func (o *PinStatus) GetDelegates() []string

GetDelegates returns the Delegates field value

func (*PinStatus) GetDelegatesOk 

func (o *PinStatus) GetDelegatesOk() (*[]string, bool)

GetDelegatesOk returns a tuple with the Delegates field value and a boolean to check if the value has been set.

func (*PinStatus) GetInfo 

func (o *PinStatus) GetInfo() map[string]string

GetInfo returns the Info field value if set, zero value otherwise.

func (*PinStatus) GetInfoOk 

func (o *PinStatus) GetInfoOk() (*map[string]string, bool)

GetInfoOk returns a tuple with the Info field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PinStatus) GetPin 

func (o *PinStatus) GetPin() Pin

GetPin returns the Pin field value

func (*PinStatus) GetPinOk 

func (o *PinStatus) GetPinOk() (*Pin, bool)

GetPinOk returns a tuple with the Pin field value and a boolean to check if the value has been set.

func (*PinStatus) GetRequestid 

func (o *PinStatus) GetRequestid() string

GetRequestid returns the Requestid field value

func (*PinStatus) GetRequestidOk 

func (o *PinStatus) GetRequestidOk() (*string, bool)

GetRequestidOk returns a tuple with the Requestid field value and a boolean to check if the value has been set.

func (*PinStatus) GetStatus 

func (o *PinStatus) GetStatus() Status

GetStatus returns the Status field value

func (*PinStatus) GetStatusOk 

func (o *PinStatus) GetStatusOk() (*Status, bool)

GetStatusOk returns a tuple with the Status field value and a boolean to check if the value has been set.

func (*PinStatus) HasInfo 

func (o *PinStatus) HasInfo() bool

HasInfo returns a boolean if a field has been set.

func (PinStatus) MarshalJSON 

func (o PinStatus) MarshalJSON() ([]byte, error)

func (*PinStatus) SetCreated 

func (o *PinStatus) SetCreated(v time.Time)

SetCreated sets field value

func (*PinStatus) SetDelegates 

func (o *PinStatus) SetDelegates(v []string)

SetDelegates sets field value

func (*PinStatus) SetInfo 

func (o *PinStatus) SetInfo(v map[string]string)

SetInfo gets a reference to the given map[string]string and assigns it to the Info field.

func (*PinStatus) SetPin 

func (o *PinStatus) SetPin(v Pin)

SetPin sets field value

func (*PinStatus) SetRequestid 

func (o *PinStatus) SetRequestid(v string)

SetRequestid sets field value

func (*PinStatus) SetStatus 

func (o *PinStatus) SetStatus(v Status)

SetStatus sets field value

type PinsApiService 

type PinsApiService service

PinsApiService PinsApi service

func (*PinsApiService) PinsGet 

func (a *PinsApiService) PinsGet(ctx _context.Context) apiPinsGetRequest

PinsGet List pin objects List all the pin objects, matching optional filters; when no filter is provided, only successful pins are returned

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return apiPinsGetRequest

func (*PinsApiService) PinsPost 

func (a *PinsApiService) PinsPost(ctx _context.Context) apiPinsPostRequest

PinsPost Add pin object Add a new pin object for the current access token

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return apiPinsPostRequest

func (*PinsApiService) PinsRequestidDelete 

func (a *PinsApiService) PinsRequestidDelete(ctx _context.Context, requestid string) apiPinsRequestidDeleteRequest

PinsRequestidDelete Remove pin object Remove a pin object

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param requestid

@return apiPinsRequestidDeleteRequest

func (*PinsApiService) PinsRequestidGet 

func (a *PinsApiService) PinsRequestidGet(ctx _context.Context, requestid string) apiPinsRequestidGetRequest

PinsRequestidGet Get pin object Get a pin object and its status

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param requestid

@return apiPinsRequestidGetRequest

func (*PinsApiService) PinsRequestidPost 

func (a *PinsApiService) PinsRequestidPost(ctx _context.Context, requestid string) apiPinsRequestidPostRequest

PinsRequestidPost Replace pin object Replace an existing pin object (shortcut for executing remove and add operations in one step to avoid unnecessary garbage collection of blocks present in both recursive pins)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param requestid

@return apiPinsRequestidPostRequest

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type Status 

type Status string

Status Status a pin object can have at a pinning service 

const (
	QUEUED  Status = "queued"
	PINNING Status = "pinning"
	PINNED  Status = "pinned"
	FAILED  Status = "failed"
)

List of Status

func (Status) Ptr 

func (v Status) Ptr() *Status

Ptr returns reference to Status value

func (*Status) UnmarshalJSON 

func (v *Status) UnmarshalJSON(src []byte) error

Source Files

View all Source files

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.