Skip to content

Commit 97c2db8

Browse files
authored
draft (#223)
* draft * typo * Add note about note.
1 parent 1eee9e3 commit 97c2db8

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

hapi-dev/HAPI-data-access-spec-dev.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,8 @@ The server's response to this endpoint must be in JSON format [[3](#6-references
264264
| `description` | string | **Optional** A brief description of the type of data the server provides. |
265265
| `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. |
266266
| `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. |
267269
| `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. |
268270

269271
**`DataTest` Object**
@@ -548,6 +550,9 @@ The response is in JSON format [[3](#6-references)] and provides metadata about
548550
| `contactID` | string | **Optional** The identifier in the discovery system for information about the contact. For example, the SPASE ID or ORCID of the person. |
549551
| `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. |
550552
| `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 |
555+
551556

552557
### 3.6.3 `unitsSchema` Details
553558

0 commit comments

Comments
 (0)