package
0.10.3
Repository: https://github.com/cscfi/qvain-api.git
Documentation: pkg.go.dev

# Functions

CreatedNewVersion returns a boolean indicating whether the new version created key exists.
No description provided by the author
No description provided by the author
GetIdentifiers returns the Metax identifier, Metax "new version" identifier and Qvain record_id fields.
GetModificationDate returns the date of last modification (created, modified, deprecated, removed) for a dataset.
GetQvainId returns the Qvain id of the dataset from the editor object or empty string.
No description provided by the author
LoadMetaxDataset constructs an existing MetaxDataset from an existing base dataset.
MaybeNewVersionId returns the id of a new Metax version if a new version was created, otherwise an empty string.
NewLinkingError creates a new LinkingError with the field name set to the argument, or marks the whole metadata block as missing if no argument given.
NewMetaxDataset creates a Metax dataset.
NewMetaxService returns a Metax API client.
Since is a dataset option that adds an if-modified-since header to dataset queries.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WithOwner is a dataset option that restricts dataset queries to the Qvain owner set in the dataset's editor object.
WithRemoved is a dataset option that filters dataset queries to those that have been removed.
WithStreaming forces the API to return a streaming response without pagination.
WithUser is a dataset option that filters dataset queries to those that have the given user identifier set in the dataset.
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
MetaxDatasetFamily is the dataset type for Fairdata datasets.
No description provided by the author
These constants are used to identify the schema a dataset is using.
These constants are used to identify the schema a dataset is using.
No description provided by the author

# Variables

CatalogIdentifiers are used to identify schema in datasets imported from Metax.
DateCreatedKey is the key for the Metax dataset creation timestamp.
DateDeprecatedKey is the key for the Metax dataset deprecation timestamp.
DateModifiedKey is the key for the Metax dataset modification timestamp.
DateRemovedKey is the key for the Metax dataset removal timestamp.
Editor is the key pointing to Qvain's private object inside the dataset.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IdentifierKey is the key pointing to the primary identifier, if any.
NewVersionId is the key holding the identifier of the new version or an empty string.
NewVersionKey is the key to the value indicating a new version has been created.
QvainId is the key with the identifier "qvain".
QvainId is the key with the Qvain record id.

# Structs

No description provided by the author
DataCatalog contains the catalog identifier.
Editor is the Go representation of the Editor object in a Metax record.
LinkingError is a custom error type that adds the missing field name.
MetaxDataset wraps a models.Dataset.
MetaxRawRecord embeds a json.RawMessage containing an unparsed JSON []byte slice with the Metax dataset.
MetaxRecord is a helper struct to parse the fields we need from a Metax dataset.
MetaxService represents the Metax API server.
No description provided by the author

# Type aliases

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