You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: hapi-dev/HAPI-data-access-spec-dev.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -264,6 +264,8 @@ The server's response to this endpoint must be in JSON format [[3](#6-references
264
264
|`description`| string |**Optional** A brief description of the type of data the server provides. |
265
265
|`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. |
266
266
|`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. |
267
+
|`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"]`. |
268
+
|`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. |
267
269
|`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. |
268
270
269
271
**`DataTest` Object**
@@ -548,6 +550,9 @@ The response is in JSON format [[3](#6-references)] and provides metadata about
548
550
|`contactID`| string |**Optional** The identifier in the discovery system for information about the contact. For example, the SPASE ID or ORCID of the person. |
549
551
|`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. |
550
552
|`definitions`| object |**Optional** An object containing definitions that are referenced using a [JSON reference](#3613-json-references)|
553
+
|`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"]`.|
554
+
|`warning`| string or array of strings |**Optional** Temporary warnings about the dataset, such as "dataset stopDate is typically updated continuously, but |
0 commit comments