From 1a1720242a3fe08f476f43d9d35c147d7e5e6731 Mon Sep 17 00:00:00 2001 From: Phil Varner Date: Tue, 14 Feb 2023 08:59:04 -0500 Subject: [PATCH 1/2] remove browseable, moved to https://github.com/stac-api-extensions/browseable --- core/README.md | 38 +------------------------------------- overview.md | 2 -- 2 files changed, 1 insertion(+), 39 deletions(-) diff --git a/core/README.md b/core/README.md index 47fe3174..6577f5df 100644 --- a/core/README.md +++ b/core/README.md @@ -4,7 +4,6 @@ - [Summary](#summary) - [Overview](#overview) - [Core](#core) - - [Browseable](#browseable) - [Link Relations](#link-relations) - [Endpoints](#endpoints) - [Example Landing Page for STAC API - Core](#example-landing-page-for-stac-api---core) @@ -16,7 +15,6 @@ - **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.2/core)), - **Conformance URIs:** - - - - **[Maturity Classification](../README.md#maturity-classification):** Candidate - **Dependencies**: None and [commons.yaml](commons.yaml) is the OpenAPI version of the core [STAC spec](../stac-spec) JSON Schemas. @@ -26,9 +24,7 @@ All STAC API implementations must implement the *STAC API - Core* conformance class . This requires a server to return from a root endpoint a valid [STAC Catalog](../stac-spec/catalog-spec/catalog-spec.md) "landing page" that also includes a `conformsTo` -attribute with a string array value. Any API implementing this is considered a minimal, valid STAC API. Additionally, -a STAC API conforming conformance class () must be structured -such that all Items in the catalog can be accessed by following `child` and `item` link relations. +attribute with a string array value. Any API implementing this is considered a minimal, valid STAC API. ## Core @@ -66,35 +62,6 @@ that declare different conformance classes. This is useful when an entire catalo support the *STAC API - Item Search* conformance class, perhaps because it uses multiple databases to store items, but sub-catalogs whose items are all in one database can support search. -## Browseable - -The Browseable conformance class () provides a formal way -to advertise that all Items in the Catalog presented by a STAC API may be reached by following `child` and -`item` link relations. In a non-API STAC Catalog, all items must be reachable via these relations to be -considered in the catalog. With a STAC API Catalog, items are considered to be in the catalog if they are -accessible via `child` and `item` relations **or** search operations using either [STAC API - Features](../ogcapi-features/README.md) or -[STAC API - Item Search](../item-search/README.md) endpoints. When a STAC API Catalog has child -and item link relations, there is ambiguity in whether the same set of items accessible via -search operations -is also accessible via link relations. Browseable clarifies this by unambiguously advertising that -items available via search can also be accessed by following link relations. - -Support for this "browse" mode of interaction via link relations is complementary to the dynamic search -capabilities defined in the [STAC API - Features](../ogcapi-features/README.md) and -[STAC API - Item Search](../item-search/README.md) conformance classes. -Conversely, a STAC API implementation may not support browsing, even though the root is a Catalog object, -if it does not have the appropriate `child` and `item` link relations to traverse over the objects in -the catalog. - -Search and browse are complementary ways of interacting with the catalog, and allow users to iteratively interrogate the data -to discover what data is available through browse, and search to filter to only relevant data. Supporting both also opens up a catalog to -clients that are oriented towards reading non-API STAC catalogs -(e.g., [STAC Browser](https://github.com/radiantearth/stac-browser)) and those that are oriented towards -searchable STAC API catalogs -(e.g., [PySTAC Client](https://pystac-client.readthedocs.io/), [stac-nb](https://github.com/darrenwiens/stac-nb)). - -Recommendations for supporting browse is discussed in [Structuring Catalog Hierarchies](#structuring-catalog-hierarchies). - ## Link Relations The following Link relations must exist in the Landing Page (root). @@ -122,9 +89,6 @@ supported by this endpoint, e.g., `text/html`. Additionally, `child` relations may exist to child Catalogs and Collections and `item` relations to Items. These relations form a directed graph that enables traversal from a root catalog or collection to items. -If all Items in a Catalog can be accessed by traversing these links, the Browseable conformance class - should be advertised. - | **rel** | **href** | **From** | **Description** | | ------- | -------- | --------------- | -------------------------------------- | | `child` | various | STAC API - Core | The child STAC Catalogs & Collections. | diff --git a/overview.md b/overview.md index 30d2ff0a..642d6b0b 100644 --- a/overview.md +++ b/overview.md @@ -119,7 +119,6 @@ conformance URIs serve up a rendered HTML version of the corresponding OpenAPI d | **Name** | **Specified in** | **Conformance URI** | **Description** | | ---------------------- | ------------------------------------------- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | | STAC API - Core | [Core](core) | | Specifies the STAC Landing page `/`, communicating conformance and available endpoints. | -| STAC API - Browseable | [Core](core) | | Advertises all Items can be reached through `child` and `item` links, as they would be in a non-API Catalog. | | STAC API - Item Search | [Item Search](item-search) | | Enables search of all STAC Item objects on the server, with the STAC `[/search](#stac-api-endpoints)` endpoint. | | STAC API - Features | [Collections and Features](ogcapi-features) | | Specifies the use of OGC API - Features to serve STAC Item and Collection objects | | STAC API - Collections | [Collections and Features](ogcapi-features) | | Specifies the use of a subset of STAC API - Features to serve Collection objects | @@ -145,7 +144,6 @@ The Landing Page will at least have the following `conformsTo` and `links`: "type": "Catalog", "conformsTo" : [ "https://api.stacspec.org/v1.0.0-rc.2/core", - "https://api.stacspec.org/v1.0.0-rc.2/browseable", "https://api.stacspec.org/v1.0.0-rc.2/collections", "https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features", "https://api.stacspec.org/v1.0.0-rc.2/item-search", From 9b594944a68e7347196bb669945463ab260e8571 Mon Sep 17 00:00:00 2001 From: Phil Varner Date: Tue, 14 Feb 2023 09:02:23 -0500 Subject: [PATCH 2/2] update changelog --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 51189594..0ff85a85 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## Changed + +- Browseable has been moved to an extension, now located at + ## Added - Added authentication status code recommendations.