Skip to content

Commit 6692cd2

Browse files
PB-1949 Move tutorials to Tech Docs
This contains two changes to in the [apitransactional.html](https://data.geo.admin.ch/api/stac/static/spec/v1/apitransactional.html): 1. Add a link to the [Tech Docs](https://sys-docs.int.bgdi.ch/download-data/stac-api/overview.html) on the top of the page. 2. Remove all content that is now also present in the [Tech Docs](https://sys-docs.int.bgdi.ch/download-data/stac-api/overview.html). Replace it with a short description + a link. I only pointed to the [STAC API Overview page](https://sys-docs.int.bgdi.ch/download-data/stac-api/overview.html) and not to specific subpages, like e.g. [Authentication](https://sys-docs.int.bgdi.ch/docs/stac-api/authentication.html). I thought it does not add a lot of benefit and reduces the risk of outdated links. Note that the final docs.geo.admin.ch is not live yet but the Terraform code for it is ready and reviewed: geoadmin/infra-terraform-bgdi#1212. So I only merge this when docs.geo.admin.ch is actually online. To try out how this looks as a website, run this locally: 1. Run `make build-specs` 2. Run `make serve-specs` 3. Open the page at http://127.0.0.1:8090/apitransactional.html.
1 parent f713340 commit 6692cd2

6 files changed

Lines changed: 37 additions & 1480 deletions

File tree

spec/openapi.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@ info:
33
contact:
44
name: API Specification (based on STAC)
55
url: http://data.geo.admin.ch/api/stac/v1/
6-
description: >-
6+
description: |
77
This is an OpenAPI definition of the API to query and access federal geodata on
88
data.geo.admin.ch. The API is based on the core SpatioTemporal Asset Catalog API specification
99
[STAC](http://stacspec.org) and adds two extensions for extended searching possibilities.
10+
11+
Find tutorials, examples and best practices around the STAC API in the [Tech Docs](https://docs.geo.admin.ch/download-data/stac-api/overview.html).
1012
title: The SpatioTemporal Asset Catalog API for data.geo.admin.ch
1113
version: 1.0.0
1214
servers:
-4.19 KB
Binary file not shown.

spec/static/assets/service-stac-upload-process.svg

Lines changed: 0 additions & 755 deletions
This file was deleted.

spec/static/spec/v1/openapi.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1958,8 +1958,12 @@ info:
19581958
contact:
19591959
name: API Specification (based on STAC)
19601960
url: http://data.geo.admin.ch/api/stac/v1/
1961-
description: >-
1962-
This is an OpenAPI definition of the API to query and access federal geodata on data.geo.admin.ch. The API is based on the core SpatioTemporal Asset Catalog API specification [STAC](http://stacspec.org) and adds two extensions for extended searching possibilities.
1961+
description: |
1962+
This is an OpenAPI definition of the API to query and access federal geodata on
1963+
data.geo.admin.ch. The API is based on the core SpatioTemporal Asset Catalog API specification
1964+
[STAC](http://stacspec.org) and adds two extensions for extended searching possibilities.
1965+
1966+
Find tutorials, examples and best practices around the STAC API in the [Tech Docs](https://docs.geo.admin.ch/download-data/stac-api/overview.html).
19631967
title: The SpatioTemporal Asset Catalog API for data.geo.admin.ch
19641968
version: 1.0.0
19651969
servers:

0 commit comments

Comments
 (0)