Skip to content
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

fix headers so VSCode header won't remove Summary section #384

Merged
merged 1 commit into from
Jan 30, 2023
Merged

fix headers so VSCode header won't remove Summary section #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# STAC API - Core Specification

- [STAC API - Core Specification](#stac-api---core-specification)
- [Summary](#summary)
- [Overview](#overview)
- [Link Relations](#link-relations)
- [Endpoints](#endpoints)
- [Example Landing Page for STAC API - Core](#example-landing-page-for-stac-api---core)
- [Extensions](#extensions)
- [Structuring Catalog Hierarchies](#structuring-catalog-hierarchies)

## Summary

- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.2/core)),
- **Conformance URIs:**
- <https://api.stacspec.org/v1.0.0-rc.2/core>
Expand All @@ -15,6 +19,8 @@
- **Dependencies**: None
and [commons.yaml](commons.yaml) is the OpenAPI version of the core [STAC spec](../stac-spec) JSON Schemas.

## Overview

All STAC API implementations must implement the *STAC API - Core* specification. The conformance class
<https://api.stacspec.org/v1.0.0-rc.2/core> requires a server to provide a valid
[STAC Catalog](../stac-spec/catalog-spec/catalog-spec.md) that also includes a `conformsTo`
Expand Down
6 changes: 6 additions & 0 deletions item-search/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# STAC API - Item Search

- [STAC API - Item Search](#stac-api---item-search)
- [Summary](#summary)
- [Overview](#overview)
- [Link Relations](#link-relations)
- [Endpoints](#endpoints)
- [Query Parameters and Fields](#query-parameters-and-fields)
Expand All @@ -15,13 +17,17 @@
- [Example Landing Page for STAC API - Item Search](#example-landing-page-for-stac-api---item-search)
- [Extensions](#extensions)

## Summary

- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.2/item-search))
- **Conformance URIs:**
- <https://api.stacspec.org/v1.0.0-rc.2/item-search>
- **[Maturity Classification](../README.md#maturity-classification):** Candidate
- **Dependencies**: [STAC API - Core](../core)
- **Examples**: [examples.md](examples.md)

## Overview

The *STAC API - Item Search* specification defines the *STAC API - Item Search*
conformance class (<https://api.stacspec.org/v1.0.0-rc.2/item-search>), which
provides the ability to search for STAC [Item](../stac-spec/item-spec/README.md)
Expand Down
6 changes: 5 additions & 1 deletion ogcapi-features/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# STAC API - Collections and Features Specification

- [STAC API - Collections and Features Specification](#stac-api---collections-and-features-specification)
- [Summary](#summary)
- [Overview](#overview)
- [Conformance Classes](#conformance-classes)
- [STAC API - Features](#stac-api---features)
- [STAC API - Collections](#stac-api---collections)
Expand All @@ -16,7 +18,7 @@
- [Example Collection Endpoint](#example-collection-endpoint)
- [Extensions](#extensions)

*based on [**OGC API - Features - Part 1: Core**](https://www.ogc.org/standards/ogcapi-features)*
philvarner marked this conversation as resolved.
Show resolved Hide resolved
## Summary

- **OpenAPI specifications:**
- [STAC API - Features](openapi-features.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features))
Expand All @@ -30,6 +32,8 @@
- [OGC API - Features](https://www.ogc.org/standards/ogcapi-features)
uses all the OGC API - Features openapi fragments to describe returning STAC Item objects.

## Overview

The *STAC API - Collections and Features* specification extends the
[OGC API - Features - Part 1: Core](https://docs.opengeospatial.org/is/17-069r3/17-069r3.html)
(OAFeat) specification. OAFeat
Expand Down