Skip to content

Commit 2be5e04

Browse files
committed
got rid of old changes that snuck in
1 parent d0336de commit 2be5e04

File tree

1 file changed

+35
-24
lines changed

1 file changed

+35
-24
lines changed

catalog-spec/catalog-spec.md

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# STAC Catalog Specification
1+
# STAC Catalog Specification <!-- omit in toc -->
22

33
- [Catalog fields](#catalog-fields)
44
- [Additional Field Information](#additional-field-information)
5+
- [stac_version](#stac_version)
56
- [stac_extensions](#stac_extensions)
67
- [Link Object](#link-object)
78
- [Relation types](#relation-types)
@@ -10,15 +11,18 @@
1011
- [STAC Media Types](#stac-media-types)
1112
- [Extensions](#extensions)
1213

13-
This document explains the structure and content of a STAC Catalog. A STAC Catalog is a
14-
[Collection](../collection-spec/collection-spec.md) of [STAC Items](../item-spec/item-spec.md). These Items can be
15-
linked to directly from a Catalog, or the Catalog can link to other Catalogs (often called sub-Catalogs) that contain
16-
links to Items. The division of sub-catalogs is up to the implementor, but is generally done to aid the ease of
17-
online browsing by people.
14+
This document explains the structure and content of a STAC **Catalog** object. A STAC Catalog object
15+
represents a logical group of other Catalog,
16+
[Collection](../collection-spec/collection-spec.md), and [Item](../item-spec/item-spec.md) objects.
17+
These Items can be linked to directly from a Catalog, or the Catalog can link to other Catalogs (often called
18+
sub-catalogs) that contain links to Collections and Items. The division of sub-catalogs is up to the implementor,
19+
but is generally done to aid the ease of online browsing by people.
1820

19-
Catalogs are not intended to be queried. Their purpose is discovery: to be browsed by people and crawled
20-
by machines to build a search index. A Catalog can be represented in JSON format. Any JSON object
21-
that contains all the required fields is a valid STAC Catalog.
21+
A Catalog object will typically be the entry point into a STAC catalog. Their
22+
purpose is discovery: to be browsed by people or be crawled
23+
by clients to build a searchable index.
24+
25+
Any JSON object that contains all the required fields is a valid STAC Catalog object.
2226

2327
- [Examples](../examples/)
2428
- See an example [catalog.json](../examples/catalog.json). The [collection.json](../examples/collection.json) is also a valid
@@ -39,8 +43,8 @@ also a valid STAC Catalog.
3943

4044
| Element | Type | Description |
4145
| --------------- | ------------- | ------------------------------------------------------------ |
42-
| stac_version | string | **REQUIRED.** The STAC version the Catalog implements. STAC versions can be mixed, but please keep the [recommended best practices](../best-practices.md#mixing-stac-versions) in mind. |
4346
| type | string | **REQUIRED.** Set to `Catalog` if this Catalog only implements the Catalog spec. |
47+
| stac_version | string | **REQUIRED.** The STAC version the Catalog implements. |
4448
| stac_extensions | \[string] | A list of extension identifiers the Catalog implements. |
4549
| id | string | **REQUIRED.** Identifier for the Catalog. |
4650
| title | string | A short descriptive one-line title for the Catalog. |
@@ -50,22 +54,29 @@ also a valid STAC Catalog.
5054

5155
### Additional Field Information
5256

57+
#### stac_version
58+
59+
In general, STAC versions can be mixed, but please keep the [recommended best practices](../best-practices.md#mixing-stac-versions) in mind.
60+
5361
#### stac_extensions
5462

55-
A list of extensions the Catalog implements. This does NOT declare the extensions of children or Items. The list contains URLs to the JSON Schema files it can be validated against. For [core extensions](../extensions/README.md#core-stac-extensions), a "shortcut" can be used. This means you can specify the folder name of the extension, for example `view` for the View extension. If the versions of the extension and the Catalog diverge, you can specify the URL of the JSON schema file.
56-
This list must only contain extensions that extend the Catalog itself, see the the 'Scope' column in the list of extensions.
63+
A list of extensions the Catalog implements.
64+
The list consists of URLs to JSON Schema files that can be used for validation.
65+
This list must only contain extensions that extend the Catalog specification itself,
66+
see the 'Scope' for each of the extensions.
67+
This must **not** declare the extensions that are only implemented in child Collection objects or child Item objects.
5768

5869
### Link Object
5970

6071
This object describes a relationship with another entity. Data providers are advised to be liberal
6172
with links.
6273

63-
| Field Name | Type | Description |
64-
| ---------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- |
65-
| href | string | **REQUIRED.** The actual link in the format of an URL. Relative and absolute links are both allowed. |
74+
| Field Name | Type | Description |
75+
| ---------- | ------ | ----------- |
76+
| href | string | **REQUIRED.** The actual link in the format of an URL. Relative and absolute links are both allowed. |
6677
| rel | string | **REQUIRED.** Relationship between the current document and the linked document. See chapter ["Relation types"](#relation-types) for more information. |
67-
| type | string | [Media type](#media-types) of the referenced entity. |
68-
| title | string | A human readable title to be used in rendered displays of the link. |
78+
| type | string | [Media type](#media-types) of the referenced entity. |
79+
| title | string | A human readable title to be used in rendered displays of the link. |
6980

7081
For a full discussion of the situations where relative and absolute links are recommended see the
7182
['Use of links'](../best-practices.md#use-of-links) section of the STAC best practices.
@@ -77,8 +88,8 @@ The following types are commonly used as `rel` types in the Link Object of a STA
7788
| Type | Description |
7889
| ------- | ----------- |
7990
| self | STRONGLY RECOMMENDED. *Absolute* URL to the location that the Catalog file can be found online, if available. This is particularly useful when in a download package that includes metadata, so that the downstream user can know where the data has come from. |
80-
| root | STRONGLY RECOMMENDED. URL to the root STAC entity (Catalog or [Collection](../collection-spec/README.md)). Catalogs should include a link to their root, even if it's the root and points to itself. |
81-
| parent | URL to the parent STAC entity (Catalog or Collection). Non-root Catalogs should include a link to their parent. |
91+
| root | STRONGLY RECOMMENDED. URL to the root STAC Catalog or [Collection](../collection-spec/README.md). Catalogs should include a link to their root, even if it's the root and points to itself. |
92+
| parent | URL to the parent STAC Catalog or Collection. Non-root Catalogs should include a link to their parent. |
8293
| child | URL to a child STAC Catalog or Collection. |
8394
| item | URL to a STAC Item. |
8495

@@ -106,11 +117,11 @@ A STAC Catalog is a JSON file ([RFC 8259](https://tools.ietf.org/html/rfc8259)),
106117

107118
The following table lists the Media Types to use for STAC structures.
108119

109-
| Media Type | Description |
110-
| ------------------------------ | ------------------------------------------------------------ |
111-
| `application/geo+json` | A STAC [Item](../item-spec/item-spec.md) |
112-
| `application/json` | A STAC [Catalog](#stac-catalog-specification) |
113-
| `application/json` | A STAC [Collection](../collection-spec/collection-spec.md) |
120+
| Media Type | Description |
121+
| ---------------------- | ---------------------------------------------------------- |
122+
| `application/geo+json` | A STAC [Item](../item-spec/item-spec.md) |
123+
| `application/json` | A STAC Catalog |
124+
| `application/json` | A STAC [Collection](../collection-spec/collection-spec.md) |
114125

115126
## Extensions
116127

0 commit comments

Comments
 (0)