From f30834165f148aaab4330300fef783b9718ac4d8 Mon Sep 17 00:00:00 2001 From: Bob Weigel Date: Tue, 13 Aug 2024 15:14:23 +0000 Subject: [PATCH 1/3] draft --- hapi-dev/HAPI-data-access-spec-dev.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/hapi-dev/HAPI-data-access-spec-dev.md b/hapi-dev/HAPI-data-access-spec-dev.md index 6c063c4..b7eb5f1 100644 --- a/hapi-dev/HAPI-data-access-spec-dev.md +++ b/hapi-dev/HAPI-data-access-spec-dev.md @@ -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. | +| `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** @@ -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 server that are not appropriate to include in `description`. For example, a change log that lists added parameters. | +| `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 From 5caf826d270c7e33cab2580319f9fd2873591a4e Mon Sep 17 00:00:00 2001 From: Bob Weigel Date: Mon, 9 Sep 2024 16:17:40 +0000 Subject: [PATCH 2/3] typo --- hapi-dev/HAPI-data-access-spec-dev.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hapi-dev/HAPI-data-access-spec-dev.md b/hapi-dev/HAPI-data-access-spec-dev.md index b7eb5f1..7342823 100644 --- a/hapi-dev/HAPI-data-access-spec-dev.md +++ b/hapi-dev/HAPI-data-access-spec-dev.md @@ -548,7 +548,7 @@ 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 server that are not appropriate to include in `description`. For example, a change log that lists added parameters. | +| `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. | | `warning` | string or array of strings | **Optional** Temporary warnings about the dataset, such as "dataset stopDate is typically updated continuously, but | From b4eb8511d7d1af8d67cddc94da689c957994078b Mon Sep 17 00:00:00 2001 From: Bob Weigel Date: Mon, 9 Sep 2024 16:29:20 +0000 Subject: [PATCH 3/3] Add note about note. --- hapi-dev/HAPI-data-access-spec-dev.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/hapi-dev/HAPI-data-access-spec-dev.md b/hapi-dev/HAPI-data-access-spec-dev.md index 7342823..2045950 100644 --- a/hapi-dev/HAPI-data-access-spec-dev.md +++ b/hapi-dev/HAPI-data-access-spec-dev.md @@ -264,7 +264,7 @@ 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. | +| `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. | @@ -548,7 +548,7 @@ 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. | +| `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 |