Skip to content

draft #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 9, 2024
Merged

draft #223

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f308341
draft
rweigel Aug 13, 2024
5caf826
typo
rweigel Sep 9, 2024
b4eb851
Add note about note.
rweigel Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions hapi-dev/HAPI-data-access-spec-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,8 @@ The server's response to this endpoint must be in JSON format [[3](#6-references
| `description` | string | **Optional** A brief description of the type of data the server provides. |
| `contactID` | string | **Optional** The identifier in the discovery system for information about the contact. For example, a SPASE ID of a person identified in the `contact` string. |
| `citation` | string | **Optional** How to cite data server. An actionable DOI is preferred (e.g., https://doi.org/...). This `citation` differs from the `citation` in an `/info` response. Here the citation is for the entity that maintains the data server. |
| `note` | string or array of strings | **Optional** General notes about the server that are not appropriate to include in `description`. For example, a change log that lists added datasets or parameters in datasets. If an array of strings is used to describe datestamped notes, we recommend prefixing the note with a [HAPI restricted ISO 8601 format](#376-representation-of-time), e.g., `["2024-01-01T00: Note on this date time", "2024-04-02T00: Note on this date time"]`. |
| `warning` | string or array of strings | **Optional** Temporary warnings about the data server, such as scheduled down-time and known general problems. Dataset-specific warnings should be placed in `warning` element of the `/info` response. |
| `dataTest` | `DataTest` | **Optional** Information that a client can use to check that a server is operational. Data response should contain more than zero records. See below for the definition of this object. |

**`DataTest` Object**
Expand Down Expand Up @@ -546,6 +548,9 @@ The response is in JSON format [[3](#6-references)] and provides metadata about
| `contactID` | string | **Optional** The identifier in the discovery system for information about the contact. For example, the SPASE ID or ORCID of the person. |
| `additionalMetadata`| object | **Optional** A way to include a block of other (non-HAPI) metadata. See below for a description of the object, which can directly contain the metadata or point to it via a URL. |
| `definitions` | object | **Optional** An object containing definitions that are referenced using a [JSON reference](#3613-json-references) |
| `note` | string or array of strings | **Optional** General notes about the dataset that are not appropriate to include in `description`. For example, a change log that lists added parameters. If an array of strings is used to describe datestamped notes, we recommend prefixing the note with a [HAPI restricted ISO 8601 format](#376-representation-of-time), e.g., `["2024-01-01T00: Note on this date time", "2024-04-02T00: Note on this date time"]`.|
| `warning` | string or array of strings | **Optional** Temporary warnings about the dataset, such as "dataset stopDate is typically updated continuously, but |


### 3.6.3 `unitsSchema` Details

Expand Down