Documentation
¶
Overview ¶
Package api has general type definitions for doi
Index ¶
- type DataverseDataFile
- type DataverseDataset
- type DataverseDatasetResponse
- type DataverseDatasetVersion
- type DataverseFile
- type DoiResolverResponse
- type DoiResolverResponseValue
- type DoiResolverResponseValueData
- type InvenioFilesResponse
- type InvenioFilesResponseEntry
- type InvenioFilesResponseEntryLinks
- type InvenioRecordResponse
- type InvenioRecordResponseLinks
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DataverseDataFile ¶
type DataverseDataFile struct {
ID int64 `json:"id"`
Filename string `json:"filename"`
ContentType string `json:"contentType"`
FileSize int64 `json:"filesize"`
OriginalFileFormat string `json:"originalFileFormat"`
OriginalFileSize int64 `json:"originalFileSize"`
OriginalFileName string `json:"originalFileName"`
MD5 string `json:"md5"`
}
DataverseDataFile represents file metadata details
type DataverseDataset ¶
type DataverseDataset struct {
LatestVersion DataverseDatasetVersion `json:"latestVersion"`
}
DataverseDataset is the representation of a dataset
type DataverseDatasetResponse ¶
type DataverseDatasetResponse struct {
Status string `json:"status"`
Data DataverseDataset `json:"data"`
}
DataverseDatasetResponse is returned by the Dataverse dataset API
type DataverseDatasetVersion ¶
type DataverseDatasetVersion struct {
LastUpdateTime string `json:"lastUpdateTime"`
Files []DataverseFile `json:"files"`
}
DataverseDatasetVersion is the representation of a dataset version
type DataverseFile ¶
type DataverseFile struct {
DirectoryLabel string `json:"directoryLabel"`
DataFile DataverseDataFile `json:"dataFile"`
}
DataverseFile is the representation of a file found in a dataset
type DoiResolverResponse ¶
type DoiResolverResponse struct {
ResponseCode int `json:"responseCode"`
Handle string `json:"handle"`
Values []DoiResolverResponseValue `json:"values"`
}
DoiResolverResponse is returned by the DOI resolver API
Reference: https://www.doi.org/the-identifier/resources/factsheets/doi-resolution-documentation
type DoiResolverResponseValue ¶
type DoiResolverResponseValue struct {
Index int `json:"index"`
Type string `json:"type"`
Data DoiResolverResponseValueData `json:"data"`
TTL int `json:"ttl"`
Timestamp string `json:"timestamp"`
}
DoiResolverResponseValue is a single handle record value
type DoiResolverResponseValueData ¶
DoiResolverResponseValueData is the data held in a handle value
type InvenioFilesResponse ¶
type InvenioFilesResponse struct {
Entries []InvenioFilesResponseEntry `json:"entries"`
}
InvenioFilesResponse is the representation of a record's files
type InvenioFilesResponseEntry ¶
type InvenioFilesResponseEntry struct {
Key string `json:"key"`
Checksum string `json:"checksum"`
Size int64 `json:"size"`
Updated string `json:"updated"`
MimeType string `json:"mimetype"`
Links InvenioFilesResponseEntryLinks `json:"links"`
}
InvenioFilesResponseEntry is the representation of a file entry
type InvenioFilesResponseEntryLinks ¶
type InvenioFilesResponseEntryLinks struct {
Content string `json:"content"`
}
InvenioFilesResponseEntryLinks represents file links details
type InvenioRecordResponse ¶
type InvenioRecordResponse struct {
Links InvenioRecordResponseLinks `json:"links"`
}
InvenioRecordResponse is the representation of a record stored in InvenioRDM
type InvenioRecordResponseLinks ¶
type InvenioRecordResponseLinks struct {
Self string `json:"self"`
}
InvenioRecordResponseLinks represents a record's links
Source Files