osfapi

package

Go to main page

Versions in this module

v1

v1.0.0

Jul 15, 2026

Changes in this version

+ var ErrRangeUnsupported = errors.New("download range request was not honored")

type Client

+ func (c *Client) OpenDownloadRange(ctx context.Context, downloadURL string, offset int64) (io.ReadCloser, error)

+ func (c *Client) ResolveDOI(ctx context.Context, identifier string) (DOIResolution, error)

+ func (c *Client) SearchPreprints(ctx context.Context, query, provider string, limit ...int) ([]Preprint, error)

+ type DOIResolution struct

+ DOI string

+ ResolvedURL string

+ func ResolveDOI(ctx context.Context, identifier string) (DOIResolution, error)

type Links

+ Delete string

+ HTML string

+ Upload string

type NodeAttributes

+ DateCreated string

+ Tags []string

type Option

+ func WithObserver(emitter observability.Emitter) Option

+ type Preprint struct

+ Attributes PreprintAttributes

+ ID string

+ Links Links

+ Type string

+ type PreprintAttributes struct

+ DOI string

+ DatePublished string

+ IsPublished bool

+ Title string

+ type RelatedResource struct

+ Attributes map[string]any

+ ID string

+ Links Links

+ Type string

type SearchResult

+ Keywords []string

+ Year string

type StorageFileAttributes

+ Extra StorageFileExtra

+ type StorageFileExtra struct

+ Hashes StorageFileHashes

+ type StorageFileHashes struct

+ MD5 string

v1.0.0-rc.1

Jul 14, 2026

v0

v0.3.2

Jul 12, 2026

v0.3.1

Jul 11, 2026

v0.3.0

Jul 11, 2026

v0.2.0

May 18, 2026

Changes in this version

+ type APIError struct

+ Detail string

+ Method string

+ Path string

+ StatusCode int

+ Title string

+ func (e *APIError) Error() string

+ type Client struct

+ func New(baseURL string, opts ...Option) (*Client, error)

+ func (c *Client) CreateFolder(ctx context.Context, providerURL, folderName string) error

+ func (c *Client) CreateNode(ctx context.Context, title, category, description string) (Node, error)

+ func (c *Client) CreateRegistration(ctx context.Context, nodeID string, request RegistrationRequest) (Node, error)

+ func (c *Client) CurrentUser(ctx context.Context) (User, error)

+ func (c *Client) DeleteFile(ctx context.Context, providerURL, fileName string) error

+ func (c *Client) DeleteNode(ctx context.Context, id string) error

+ func (c *Client) GetNode(ctx context.Context, id string) (Node, error)

+ func (c *Client) GetNodeFilesProvider(ctx context.Context, nodeID string) (string, error)

+ func (c *Client) GetStorageFile(ctx context.Context, id string) (StorageFile, error)

+ func (c *Client) GetUser(ctx context.Context, id string) (User, error)

+ func (c *Client) ListCurrentUserProjects(ctx context.Context) ([]Node, error)

+ func (c *Client) ListFileVersions(ctx context.Context, fileID string) ([]FileVersion, error)

+ func (c *Client) ListNodeAddons(ctx context.Context, id string) ([]Node, error)

+ func (c *Client) ListNodeChildren(ctx context.Context, id string) ([]Node, error)

+ func (c *Client) ListNodeComments(ctx context.Context, id string) ([]Node, error)

+ func (c *Client) ListNodeContributors(ctx context.Context, id string) ([]Contributor, error)

+ func (c *Client) ListNodeIdentifiers(ctx context.Context, id string) ([]Node, error)

+ func (c *Client) ListNodeLogs(ctx context.Context, id string) ([]Node, error)

+ func (c *Client) ListNodeRegistrations(ctx context.Context, id string) ([]Node, error)

+ func (c *Client) ListPreprints(ctx context.Context, provider string, limit ...int) ([]Node, error)

+ func (c *Client) ListStorageFiles(ctx context.Context, nodeID string, segments ...string) ([]StorageFile, error)

+ func (c *Client) ListWikiPages(ctx context.Context, id string) ([]Node, error)

+ func (c *Client) OpenDownload(ctx context.Context, downloadURL string) (io.ReadCloser, error)

+ func (c *Client) SearchOSF(ctx context.Context, query string, limit ...int) ([]SearchResult, error)

+ func (c *Client) UpdateNode(ctx context.Context, id, title, description string) (Node, error)

+ func (c *Client) UploadFile(ctx context.Context, providerURL, fileName string, content io.Reader, ...) error

+ type Contributor struct

+ Attributes ContributorAttributes

+ ID string

+ Links Links

+ Type string

+ type ContributorAttributes struct

+ Bibliographic bool

+ FullName string

+ Permission string

+ type FileVersion struct

+ Attributes FileVersionAttributes

+ ID string

+ Links Links

+ Type string

+ type FileVersionAttributes struct

+ DateCreated time.Time

+ DateModified time.Time

+ Size int64

+ type Links struct

+ Download string

+ Next string

+ Prev string

+ Related string

+ Self string

+ type Node struct

+ Attributes NodeAttributes

+ ID string

+ Links Links

+ Type string

+ type NodeAttributes struct

+ Category string

+ Description string

+ Title string

+ type Option func(*Client)

+ func WithBearerToken(token string) Option

+ func WithCredentials(credentials auth.Credentials) Option

+ func WithHTTPClient(httpClient *http.Client) Option

+ func WithUsernamePassword(username, password string) Option

+ type RegistrationRequest struct

+ Description string

+ SchemaID string

+ Title string

+ type SearchResult struct

+ Category string

+ Description string

+ ID string

+ Title string

+ Type string

+ URL string

+ type StorageFile struct

+ Attributes StorageFileAttributes

+ ID string

+ Links Links

+ Type string

+ func (f StorageFile) DownloadURL() string

+ type StorageFileAttributes struct

+ Kind string

+ Name string

+ Size int64

+ type User struct

+ Attributes UserAttributes

+ ID string

+ Links Links

+ Type string

+ type UserAttributes struct

+ FamilyName string

+ FullName string

+ GivenName string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL