A core metadata service.
DEPRECATED: The Pidgin functionality is now available in the Peregrine service, versions 3.2.0/2023.04 or newer. It is now unnecessary to deploy the Pidgin service.
Pidgin is a lightweight API on top of Peregrine. It takes a file's GUID as input, queries Peregrine for information about this file and returns an abstract of the file to the user.
Pidgin powers the "Download file" page, accessible from the "Files" page of the Windmill data portal.
Pidgin has a single endpoint: /<GUID of a file>. By default, this endpoint returns the core metadata as a JSON document. However, bibliography and JSON-LD schema.org formats are also supported. The user can specify the format of the output using the Accept header as follows:
Accept: application/json # for JSON format
Accept: x-bibtex # for bibliography format
Accept: application/vnd.schemaorg.ld+json # for JSON-LD formatOpenAPI documentation available here.
The YAML file containing the OpenAPI documentation can be found in the openapi folder; see the README in that folder for more details.