|
4 | 4 | - [Summary](#summary) |
5 | 5 | - [Overview](#overview) |
6 | 6 | - [Core](#core) |
7 | | - - [Browseable](#browseable) |
8 | 7 | - [Link Relations](#link-relations) |
9 | 8 | - [Endpoints](#endpoints) |
10 | 9 | - [Example Landing Page for STAC API - Core](#example-landing-page-for-stac-api---core) |
|
16 | 15 | - **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.2/core)), |
17 | 16 | - **Conformance URIs:** |
18 | 17 | - <https://api.stacspec.org/v1.0.0-rc.2/core> |
19 | | - - <https://api.stacspec.org/v1.0.0-rc.2/browseable> |
20 | 18 | - **[Maturity Classification](../README.md#maturity-classification):** Candidate |
21 | 19 | - **Dependencies**: None |
22 | 20 | and [commons.yaml](commons.yaml) is the OpenAPI version of the core [STAC spec](../stac-spec) JSON Schemas. |
|
26 | 24 | All STAC API implementations must implement the *STAC API - Core* conformance class |
27 | 25 | <https://api.stacspec.org/v1.0.0-rc.2/core>. This requires a server to return from a root endpoint a valid |
28 | 26 | [STAC Catalog](../stac-spec/catalog-spec/catalog-spec.md) "landing page" that also includes a `conformsTo` |
29 | | -attribute with a string array value. Any API implementing this is considered a minimal, valid STAC API. Additionally, |
30 | | -a STAC API conforming conformance class (<https://api.stacspec.org/v1.0.0-rc.2/browseable>) must be structured |
31 | | -such that all Items in the catalog can be accessed by following `child` and `item` link relations. |
| 27 | +attribute with a string array value. Any API implementing this is considered a minimal, valid STAC API. |
32 | 28 |
|
33 | 29 | ## Core |
34 | 30 |
|
@@ -66,35 +62,6 @@ that declare different conformance classes. This is useful when an entire catalo |
66 | 62 | support the *STAC API - Item Search* conformance class, perhaps because it uses multiple databases to store items, |
67 | 63 | but sub-catalogs whose items are all in one database can support search. |
68 | 64 |
|
69 | | -## Browseable |
70 | | - |
71 | | -The Browseable conformance class (<https://api.stacspec.org/v1.0.0-rc.2/browseable>) provides a formal way |
72 | | -to advertise that all Items in the Catalog presented by a STAC API may be reached by following `child` and |
73 | | -`item` link relations. In a non-API STAC Catalog, all items must be reachable via these relations to be |
74 | | -considered in the catalog. With a STAC API Catalog, items are considered to be in the catalog if they are |
75 | | -accessible via `child` and `item` relations **or** search operations using either [STAC API - Features](../ogcapi-features/README.md) or |
76 | | -[STAC API - Item Search](../item-search/README.md) endpoints. When a STAC API Catalog has child |
77 | | -and item link relations, there is ambiguity in whether the same set of items accessible via |
78 | | -search operations |
79 | | -is also accessible via link relations. Browseable clarifies this by unambiguously advertising that |
80 | | -items available via search can also be accessed by following link relations. |
81 | | - |
82 | | -Support for this "browse" mode of interaction via link relations is complementary to the dynamic search |
83 | | -capabilities defined in the [STAC API - Features](../ogcapi-features/README.md) and |
84 | | -[STAC API - Item Search](../item-search/README.md) conformance classes. |
85 | | -Conversely, a STAC API implementation may not support browsing, even though the root is a Catalog object, |
86 | | -if it does not have the appropriate `child` and `item` link relations to traverse over the objects in |
87 | | -the catalog. |
88 | | - |
89 | | -Search and browse are complementary ways of interacting with the catalog, and allow users to iteratively interrogate the data |
90 | | -to discover what data is available through browse, and search to filter to only relevant data. Supporting both also opens up a catalog to |
91 | | -clients that are oriented towards reading non-API STAC catalogs |
92 | | -(e.g., [STAC Browser](https://github.com/radiantearth/stac-browser)) and those that are oriented towards |
93 | | -searchable STAC API catalogs |
94 | | -(e.g., [PySTAC Client](https://pystac-client.readthedocs.io/), [stac-nb](https://github.com/darrenwiens/stac-nb)). |
95 | | - |
96 | | -Recommendations for supporting browse is discussed in [Structuring Catalog Hierarchies](#structuring-catalog-hierarchies). |
97 | | - |
98 | 65 | ## Link Relations |
99 | 66 |
|
100 | 67 | While the STAC definition of Link does not require the `type` field, |
@@ -126,9 +93,6 @@ supported by this endpoint, e.g., `text/html`. |
126 | 93 | Additionally, `child` relations may exist to child Catalogs and Collections and `item` relations to Items. These |
127 | 94 | relations form a directed graph that enables traversal from a root catalog or collection to items. |
128 | 95 |
|
129 | | -If all Items in a Catalog can be accessed by traversing these links, the Browseable conformance class |
130 | | -<https://api.stacspec.org/v1.0.0-rc.2/browseable> should be advertised. |
131 | | - |
132 | 96 | | **rel** | **href** | **Media Type** | **From** | **Description** | |
133 | 97 | | ------- | -------- | -------------------- | --------------- | -------------------------------------- | |
134 | 98 | | `child` | various | application/json | STAC API - Core | The child STAC Catalogs & Collections. | |
|
0 commit comments