From 223b294a99d0949ec36d094c79f7f4e6ffbc32bd Mon Sep 17 00:00:00 2001 From: Jeremy Faden Date: Fri, 9 Aug 2024 13:38:41 +0000 Subject: [PATCH 1/2] add resolve_references --- hapi-dev/HAPI-data-access-spec-dev.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/hapi-dev/HAPI-data-access-spec-dev.md b/hapi-dev/HAPI-data-access-spec-dev.md index 524fe0f..53b1b66 100644 --- a/hapi-dev/HAPI-data-access-spec-dev.md +++ b/hapi-dev/HAPI-data-access-spec-dev.md @@ -378,7 +378,7 @@ http://server/hapi/catalog | Name | Description | |------------|-------------------------------------------------------------------| | `depth` | **Optional** Possible values are `dataset` (the default) and `all`. Servers may choose to implement the `all` option, which allows all of the metadata from a server to be obtained in a single request. If this request parameter is supported, the `/capabilites` end point must return `catalogDepthOptions=["dataset", "all"]`. | - +| `resolve_references` | **Optional** When depth=all, infos may contain references which can be left unresolved, which will reduce the size of the JSON document. This is true by default.| **Response** The response is in JSON format [[3](#6-references)] as defined by RFC-7159 and has a MIME type of `application/json`. The catalog @@ -514,6 +514,7 @@ Items with a * superscript in the following table have been modified from versio |------------|-------------------------------------------------------------------| | `dataset`[ * ](#1-significant-changes-to-specification) | **Required** The identifier for the dataset ([allowed characters](#82-allowed-characters-in-id-dataset-and-parameter)) | | `parameters` | **Optional** A comma-separated list of parameters to include in the response ([allowed characters](#82-allowed-characters-in-id-dataset-and-parameter)). Default is all; `...¶meters=&...` in URL should be interpreted as meaning all parameters. | +| `resolve_references` | **Optional** Infos may contain references which can be left unresolved, which will reduce the size of the JSON document. This is true by default.| **Response** From d729c161766a2fd83d749951fffa47bd12e85c94 Mon Sep 17 00:00:00 2001 From: Jeremy Faden Date: Fri, 9 Aug 2024 14:04:36 +0000 Subject: [PATCH 2/2] wordsmithing --- 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 53b1b66..d298bef 100644 --- a/hapi-dev/HAPI-data-access-spec-dev.md +++ b/hapi-dev/HAPI-data-access-spec-dev.md @@ -378,7 +378,7 @@ http://server/hapi/catalog | Name | Description | |------------|-------------------------------------------------------------------| | `depth` | **Optional** Possible values are `dataset` (the default) and `all`. Servers may choose to implement the `all` option, which allows all of the metadata from a server to be obtained in a single request. If this request parameter is supported, the `/capabilites` end point must return `catalogDepthOptions=["dataset", "all"]`. | -| `resolve_references` | **Optional** When depth=all, infos may contain references which can be left unresolved, which will reduce the size of the JSON document. This is true by default.| +| `resolve_references` | **Optional** If `false`, allow the server to send responses with references which need resolution by the client. Default is `true`. See [3.6.13 JSON References](#3613-json-references).| **Response** The response is in JSON format [[3](#6-references)] as defined by RFC-7159 and has a MIME type of `application/json`. The catalog @@ -514,7 +514,7 @@ Items with a * superscript in the following table have been modified from versio |------------|-------------------------------------------------------------------| | `dataset`[ * ](#1-significant-changes-to-specification) | **Required** The identifier for the dataset ([allowed characters](#82-allowed-characters-in-id-dataset-and-parameter)) | | `parameters` | **Optional** A comma-separated list of parameters to include in the response ([allowed characters](#82-allowed-characters-in-id-dataset-and-parameter)). Default is all; `...¶meters=&...` in URL should be interpreted as meaning all parameters. | -| `resolve_references` | **Optional** Infos may contain references which can be left unresolved, which will reduce the size of the JSON document. This is true by default.| +| `resolve_references` | **Optional** If `false`, allow the server to send responses with references which need resolution by the client. Default is `true`. See [3.6.13 JSON References](#3613-json-references).| **Response**