Skip to content

Commit ae876ca

Browse files
committed
Review and edit services.md
Edit mentions of custom functionality and detail services to match README.md
1 parent 0ec5edd commit ae876ca

File tree

1 file changed

+29
-25
lines changed

1 file changed

+29
-25
lines changed

docs/src/services.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,36 @@
11
---
2+
23
hide:
3-
- navigation
4+
5+
- navigation
6+
47
---
58

6-
The `eoAPI` is composed of four services built on top of `state-of-the-art` projects: [**pgstac**](https://github.com/stac-utils/pgstac), [**stac-fastapi**](https://github.com/stac-utils/stac-fastapi), [**titiler-pgstac**](https://github.com/stac-utils/titiler-pgstac) and [**tipg**](https://github.com/developmentseed/tipg). While those offert a great baseline, we choose to customize them to demo how they could work together, not only be used in parallel.
9+
eoAPI combines several state-of-the-art projects to create a full Earth Observation API. Each service can be used and deployed independently but eoAPI creates the interconnections between each service:
10+
11+
- pgSTAC database https://github.com/stac-utils/pgstac
12+
- STAC API built on top of https://github.com/stac-utils/stac-fastapi
13+
- STAC Items And Mosaic Raster Tiles API built on top of https://github.com/stac-utils/titiler-pgstac
14+
- OGC Features and Vector Tiles API built on top of https://github.com/developmentseed/tipg
715

816
## Metadata
917

1018
A custom version of [stac-fastapi.pgstac](https://github.com/stac-utils/stac-fastapi) application, adding a **`TiTilerExtension`** and a simple **`Search Viewer`**.
1119

1220
The service includes:
1321

14-
- Full **stac-fastapi** implementation - see [docs](http://localhost:8081/docs) if using the `docker compose` configuration.
15-
16-
- Simple STAC Search **viewer** - see [viewer](http://localhost:8081/index.html) if using the `docker compose` configuration.
22+
- Full **stac-fastapi** implementation - see [docs](http://localhost:8081/docs) if using the `docker-compose` configuration.
23+
- Simple STAC Search **viewer** - see [viewer](http://localhost:8081/index.html) if using the `docker-compose` configuration.
24+
- **Proxy** to the tiler endpoint for STAC Items.
25+
26+
When the `TITILER_ENDPOINT` environment variable is set (pointing to the `raster` application), additional endpoints will be added to the stac-fastapi application (see: [stac/extension.py](https://github.com/developmentseed/eoAPI/blob/main/src/eoapi/stac/eoapi/stac/extension.py)):
1727

18-
- **Proxy** to the Tiler endpoint for STAC Items
19-
20-
When `TITILER_ENDPOINT` environement is set (pointing the `raster` application), additional endpoints will be added to the stac-fastapi application (see: [stac/extension.py](https://github.com/developmentseed/eoAPI/blob/main/src/eoapi/stac/eoapi/stac/extension.py)):
21-
22-
- `/collections/{collectionId}/items/{itemId}/tilejson.json`: Return the `raster` tilejson for an item
23-
- `/collections/{collectionId}/items/{itemId}/viewer`: Redirect to the `raster` viewer
28+
- `/collections/{collectionId}/items/{itemId}/tilejson.json`: Return the `raster` tilejson for an item
29+
- `/collections/{collectionId}/items/{itemId}/viewer`: Redirect to the `raster` viewer
2430

2531
<p align="center">
26-
<img src="https://user-images.githubusercontent.com/10407788/146790933-e439893c-ef2e-4d78-a372-f2f18694836c.png"/>
27-
<p align="center">STAC Search viewer</p>
32+
<img src="https://user-images.githubusercontent.com/10407788/146790933-e439893c-ef2e-4d78-a372-f2f18694836c.png"/>
33+
<p align="center">STAC Search viewer</p>
2834
</p>
2935

3036
Code: [/runtime/eoapi/stac](https://github.com/developmentseed/eoAPI/tree/main/runtime/eoapi/stac)
@@ -33,15 +39,15 @@ Code: [/runtime/eoapi/stac](https://github.com/developmentseed/eoAPI/tree/main/r
3339

3440
## Raster
3541

36-
The dynamic tiler deployed within eoAPI is built on top of [titiler-pgstac](https://github.com/stac-utils/titiler-pgstac) and [pgstac](https://github.com/stac-utils/pgstac). It enables large scale mosaic based on results of STAC searches queries.
42+
The dynamic tiler deployed within `eoAPI` is built on top of [titiler-pgstac](https://github.com/stac-utils/titiler-pgstac) and [pgstac](https://github.com/stac-utils/pgstac). It enables large-scale mosaic based on the results of STAC search queries.
3743

3844
The service includes:
3945

40-
- Full **titiler-pgstac** implementation
46+
- Full **titiler-pgstac** implementation.
4147

4248
<p align="center">
43-
<img src="https://user-images.githubusercontent.com/10407788/129632282-f71e9f45-264c-4882-af28-7062c4e56f25.png"/>
44-
<p align="center">TiTiler-PgSTAC workflow</p>
49+
<img src="https://user-images.githubusercontent.com/10407788/129632282-f71e9f45-264c-4882-af28-7062c4e56f25.png"/>
50+
<p align="center">TiTiler-PgSTAC workflow</p>
4551
</p>
4652

4753
Code: [/runtime/eoapi/raster](https://github.com/developmentseed/eoAPI/tree/main/runtime/eoapi/raster)
@@ -50,14 +56,12 @@ Code: [/runtime/eoapi/raster](https://github.com/developmentseed/eoAPI/tree/main
5056

5157
## Vector
5258

53-
OGC Features + Tiles API built on top of [tipg](https://github.com/developmentseed/tipg).
59+
OGC Features and Tiles API built on top of [tipg](https://github.com/developmentseed/tipg).
5460

55-
By default, the API will look for tables in the `public` schema of the database. We've also added three custom functions which connect to the pgSTAC schema.
61+
By default, the API will look for tables in the `public` schema of the database. We've also added three custom functions that connect to the pgSTAC schema.
5662

57-
- **pg_temp.pgstac_collections_view**: Simple function which return PgSTAC Collections
58-
- **pg_temp.pgstac_hash**: Return features for a specific searchId (hash)
59-
- **pg_temp.pgstac_hash_count**: Return the number of items per geometry for a specific searchId (hash)
63+
- **pg_temp.pgstac_collections_view**: Simple function which returns PgSTAC Collections
64+
- **pg_temp.pgstac_hash**: Return features for a specific `searchId` (hash)
65+
- **pg_temp.pgstac_hash_count**: Return the number of items per geometry for a specific `searchId` (hash)
6066

61-
Code: [/runtime/eoapi/vector](https://github.com/developmentseed/eoAPI/tree/main/runtime/eoapi/vector)
62-
63-
---
67+
Code: [/runtime/eoapi/vector](https://github.com/developmentseed/eoAPI/tree/main/runtime/eoapi/vector)

0 commit comments

Comments
 (0)