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.

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

re-organization of content files/dirs #15

Merged
merged 1 commit into from
Nov 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ jobs:
python3 -m pip install --upgrade pip
pip3 install -r requirements.txt
- name: Build 📦
run: mkdocs build --no-strict
run: mkdocs build --strict
10 changes: 0 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,12 +1,2 @@
.DS_Store
workshop/.DS_Store
workshop/content/.DS_Store
workshop/content/docs/.DS_Store
workshop/content/docs/ogcapi/.DS_Store
workshop/content/site
workshop/content/docs/ogcapi/ogcapi-edr/.DS_Store
workshop/content/docs/ogcapi/ogcapi-features/.DS_Store
workshop/content/docs/ogcapi/ogcapi-processes/.DS_Store
workshop/content/docs/ogcapi/ogcapi-tiles/.DS_Store
workshop/content/docs/ogcapi/sta/.DS_Store

19 changes: 19 additions & 0 deletions workshop/content/docs/api-deep-dive/common/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: OGC API - Common
---

# OGC API - Common

!!! abstract Audience
Students that are familiar with web services and APIs, and want to have
an overview of OGC API - Common standard.

!!! abstract "Learning Objectives"
At the completion of the module students will be able to:

- Explain what the OGC API - Common standard is
- Describe what can be done with OGC API - Common as a building block

## Introduction

## Resources

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,4 +1,167 @@
# Resources of OGC API - Features
---
title: OGC API - Features
---

# OGC API - Features

!!! abstract Audience
Students that are familiar with web services and APIs, and want to have
an overview of OGC API - Features standard.

!!! abstract "Learning Objectives"
At the completion of the module students will be able to:

- Explain what the OGC API - Features standard is
- Describe what can be done with OGC API - Features implementations
- Understand the main resources offered by OGC API - Features implementations
- Understand how to retrieve a description of the capabilities of an OGC API - Features implementation
- Understand how to issue requests to an implementation of OGC API - Features
- Be able to find an OGC API - Features endpoint and use it through a client

## Introduction

OGC API - Features is a multi-part standard that offers the capability
to create, modify, and query spatial data on the Web and specifies
requirements and recommendations for APIs that want to follow a standard
way of sharing feature data. The Core part of the standard is called
**OGC API - Features - Part 1: Core**. The Core part of the
specification describes the mandatory capabilities that every
implementing service has to support and is restricted to read-access to
spatial data. Additional capabilities that address specific needs will
be specified in additional parts. Envisaged future capabilities include,
for example, support for creating and modifying data, more complex data
models, richer queries, and additional coordinate reference systems.

!!! note
This tutorial module is not intended to be a replacement to the actual
**OGC API - Features - Part 1: Core** standard. The tutorial
intentionally focuses on a subset of capabilities in order to get the
student started with using the standard. Please refer to the **OGC API -
Features - Part 1: Core** standard for additional detail.


## Background

> History

While in draft form and prior to February 2019, **OGC API -
Features - Part 1: Core** was referred to as WFS3.0.

> Versions

**OGC API - Features - Part 1: Core** version 1.0.0 is the current
latest version

> Test Suite

Test suites are available for:

* [OGC API - Features](https://github.com/opengeospatial/ets-ogcapi-features10)

> Implementations

Implementations can be found on the Compliance Database <http://www.opengeospatial.org/resource/products/byspec>

### Usage

**OGC API - Features - Part 1: Core** specifies discovery and query
operations that are implemented using the HTTP GET method. Support for
additional methods (in particular POST, PUT, DELETE, PATCH) will be
specified in additional parts. Government agencies, private
organisations and academic institutes use this standard to publish
vector geospatial datasets in a way that makes it easier for receiving
organisations to compile new maps or conduct analysis on the supplied
data.

The standard provides a standard interface for requesting vector
geospatial data consisting of geographic features and their properties.
The benefit of this is that client applications can request source data
from multiple implementations of the API, and then render the data for
display or process the data further as part of a workflow. The standard
enables the data to be accessed consistently with other data. Feature
properties encoded using common data types such as text strings, date
and time can also be accessed consistently.

### Relation to other OGC Standards

- OGC Web Feature Service Interface Standard (WFS): The WFS standard
is more appropriate when working with client applications that only
support classic OGC Web Services. Note as well that WFS adopts the
Geography Markup Language ([GML](https://www.ogc.org/standards/gml))
as a default data format. In contrast, OGC API - Features includes
recommendations to support [HTML](https://html.spec.whatwg.org) and
[GeoJSON](https://geojson.org) as encodings, where practical.
Implementations of OGC API - Features may also optionally support
GML.

## Overview of Resources

**OGC API - Features - Part 1: Core** defines the resources listed in
the following table.

<table>
<tr>
<th>Resource</th>
<th>Path</th>
<th>Purpose</th>
</tr>
<tr>
<td>Landing page</td>
<td>/</td>
<td>This is the top-level resource, which serves as an entry point.</td>
</tr>
<tr>
<td>Conformance declaration</td>
<td>/conformance</td>
<td>This resource presents information about the functionality that is implemented by the server.</td>
</tr>
<tr>
<td>API definition</td>
<td>/api</td>
<td>This resource provides metadata about the API itself. Note use of /api on the server is optional and the API definition may be hosted on completely separate server.</td>
</tr>
<tr>
<td>Feature collections</td>
<td>/collections </td>
<td>This resource lists the feature collections that are offered through the API.</td>
</tr>
<tr>
<td>Feature collection</td>
<td>/collections/{collectionId}</td>
<td>This resource describes the feature collection identified in the path.</td>
</tr>
<tr>
<td>Features</td>
<td>/collections/{collectionId}/items</td>
<td>This resource presents the features that are contained in the collection.</td>
</tr>
<tr>
<td>Feature</td>
<td>/collections/{collectionId}/items/{featureId}</td>
<td>This resource presents the feature that is identified in the path</td>
</tr>
</table>

## Example

This [demonstration
server](https://demo.pygeoapi.io/master)
publishes vector geospatial data through an interface that conforms to
OGC API - Features.

An example request that can be used to retrieve data from the Portuguese Points of Interest feature collection is
<https://demo.pygeoapi.io/master/collections/ogr_gpkg_poi?f=html>

Note that the response to the request is HTML in this case.

Alternatively, the same data can be retrieved in GeoJSON format, through
the request
<https://demo.pygeoapi.io/master/collections/ogr_gpkg_poi?f=json>

A client application can then retrieve the GeoJSON document and display
or process it.

# Resources

This section provides basic information about the types of resources
that OGC API - Features offers.
Expand Down Expand Up @@ -197,21 +360,6 @@ Below is an extract from the response to the request
]
```
















## Feature collection {#ogcapif_collection}

The **Collection** resource provides detailed information about the
Expand Down
21 changes: 21 additions & 0 deletions workshop/content/docs/api-deep-dive/maps/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: OGC API - Maps
---

# OGC API - Maps

!!! abstract Audience
Students that are familiar with web services and APIs, and want to have
an overview of OGC API - Maps standard.

!!! abstract "Learning Objectives"
At the completion of the module students will be able to:

- Explain what the OGC API - Maps standard is
- Describe what can be done with OGC API - Maps implementations
- Understand the main resources offered by OGC API - Maps implementations
- Understand how to retrieve a description of the capabilities of an OGC API - Maps implementation
- Understand how to issue requests to an implementation of OGC API - Maps
- Be able to find an OGC API - Maps endpoint and use it through a client

TODO
Original file line number Diff line number Diff line change
@@ -1,8 +1,28 @@
---
title: OGC API - Processes
---

# OGC API - Processes

!!! abstract Audience
Students that are familiar with web services and APIs, and want to have
an overview of OGC API - Processes standard.

!!! abstract "Learning Objectives"
At the completion of the module students will be able to:

- Explain what the OGC API - Processes standard is
- Describe what can be done with OGC API - Processes implementations
- Understand the main resources offered by OGC API - Processes implementations
- Understand how to retrieve a description of the capabilities of an OGC API - Processes implementation
- Understand how to issue requests to an implementation of OGC API - Processes
- Be able to find an OGC API - Processes endpoint and use it through a client

# An Introduction to OGC API - Processes

## Introduction

The OGC API --- Processes standard supports the wrapping of
The OGC API -- Processes standard supports the wrapping of
computational tasks into executable processes that can be offered by a
server through a Web API and be invoked by a client application. The
standard specifies a processing interface to communicate over a RESTful
Expand Down
21 changes: 21 additions & 0 deletions workshop/content/docs/api-deep-dive/records/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: OGC API - Records
---

# OGC API - Records

!!! abstract Audience
Students that are familiar with web services and APIs, and want to have
an overview of OGC API - Records standard.

!!! abstract "Learning Objectives"
At the completion of the module students will be able to:

- Explain what the OGC API - Records standard is
- Describe what can be done with OGC API - Records implementations
- Understand the main resources offered by OGC API - Records implementations
- Understand how to retrieve a description of the capabilities of an OGC API - Records implementation
- Understand how to issue requests to an implementation of OGC API - Records
- Be able to find an OGC API - Records endpoint and use it through a client

TODO
Loading
Loading