Skip to content

175 catalog needs option to deliver non resolved reference #220

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
jbfaden merged 2 commits into from
Aug 9, 2024
Merged

175 catalog needs option to deliver non resolved reference #220

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
223b294
add resolve_references
jbfaden Aug 9, 2024
d729c16
wordsmithing
jbfaden Aug 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
3 changes: 2 additions & 1 deletion 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 @@ -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** 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
Expand Down Expand Up @@ -514,6 +514,7 @@ Items with a * superscript in the following table have been modified from versio
|------------|-------------------------------------------------------------------|
| `dataset`[<sup>&nbsp;*&nbsp;</sup>](#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; `...&parameters=&...` in URL should be interpreted as meaning all parameters. |
| `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**

Expand Down