Skip to content
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
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/openeo_platform.json"
"href": "../../../../platform_catalog/openeo_platform.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "DHI",
"href": "../../record.json"
},
{
"rel": "webapp",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/openeo_platform.json"
"href": "../../../../platform_catalog/openeo_platform.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "DHI",
"href": "../../record.json"
},
{
"rel": "webapp",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "Eurac Research",
"href": "../../record.json"
},
{
"rel": "webapp",
Expand Down
8 changes: 7 additions & 1 deletion algorithm_catalog/terradue/gep_bas/records/gep_bas.json
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/gep.json"
"href": "../../../../platform_catalog/gep.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "Terradue",
"href": "../../record.json"
},
{
"rel": "service",
Expand Down
8 changes: 7 additions & 1 deletion algorithm_catalog/terradue/gep_ost/records/gep_ost.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/gep.json"
"href": "../../../../platform_catalog/gep.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "Terradue",
"href": "../../record.json"
},
{
"rel": "service",
Expand Down
8 changes: 7 additions & 1 deletion algorithm_catalog/terradue/sar_coin/records/sar_coin.json
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/gep.json"
"href": "../../../../platform_catalog/gep.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "Terradue",
"href": "../../record.json"
},
{
"rel": "service",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/gep.json"
"href": "../../../../platform_catalog/gep.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "Terradue",
"href": "../../record.json"
},
{
"rel": "service",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "VITO",
"href": "../../record.json"
},
{
"rel": "example-output",
Expand Down
8 changes: 7 additions & 1 deletion algorithm_catalog/vito/biopar/records/biopar.json
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "VITO",
"href": "../../record.json"
},
{
"rel": "example-output",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "VITO",
"href": "../../record.json"
},
{
"rel": "about",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "VITO",
"href": "../../record.json"
},
{
"rel": "example-output",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "VITO",
"href": "../../record.json"
},
{
"rel": "webapp",
Expand Down Expand Up @@ -142,4 +148,4 @@
"href": "https://raw.githubusercontent.com/Open-EO/openeo-community-examples/refs/heads/main/python/ParcelDelineation/Parcel%20delineation.ipynb"
}
]
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "VITO",
"href": "../../record.json"
},
{
"rel": "example-output",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "VITO",
"href": "../../record.json"
},
{
"rel": "example-output",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "VITO",
"href": "../../record.json"
},
{
"rel": "example-output",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "VITO",
"href": "../../record.json"
},
{
"rel": "about",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "VITO",
"href": "../../record.json"
},
{
"rel": "about",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "VITO",
"href": "../../record.json"
},
{
"rel": "webapp",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,13 @@
"rel": "platform",
"type": "application/json",
"title": "CDSE openEO federation",
"href": "https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/platform_catalog/cdse_openeo_federation.json"
"href": "../../../../platform_catalog/cdse_openeo_federation.json"
},
{
"rel": "provider",
"type": "application/json",
"title": "Wageningen University & Research",
"href": "../../record.json"
}
]
}
19 changes: 19 additions & 0 deletions docs/catalogue.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,25 @@ Onboarding your service to the APEx Algorithm Services Catalogue is a straightfo
2. Fork the current repository and add your record file to `algorithm_catalog/<provider>/<service>/records/<service>.json`. You can create the necessary subdirectories if they do not already exist.
3. Once your record is ready, submit a pull request to this repository. The APEx team will review your submission and, upon approval, your service will be added to the APEx Algorithm Services Catalogue.

# Providers and Platforms

To ensure the proper contribution of the services that are part of the APEx Algorithm Services Catalogue, it is essential to include information about the service provider and the hosting platform within the record.

## Provider Information

### Creating a new Provider Record
If you are creating a new folder in the `algorithm_catalog` directory for your service, make sure to include a `record.json` file within that folder. This OGC API Record should contain all the necessary information about the service provider, such as the provider's name, description, and contact details, and a link to the website and logo. You can refer to an existing provider folder in the repository as a template for creating your own.

### Linking the Service to the Provider
It is also important to link the service record to the provider record. This can be achieved by adding an entry in the `links` section of the service record, where the `rel` property is set to `provider` and the `href` contains the relative path to the provider's record file (`../../record.json`).

## Hosting Platform Information

### Creating a new Platform Record
If you are integrating a service record that is hosted on an APEx-compliant platform that is not yet represented in the repository, you will need to create a new `<platform>.json` file within the `platform_catalog` directory. This new file contains all the necessary information about the hosting platform, such as its name, description, contact details, website link, and logo. You can refer to an existing platform file in the repository as a template for creating your own.

### Linking the Service to the Hosting Platform
To link the service record to the hosting platform record, add an entry in the `links` section of the service record. Set the `rel` property to `platform` and the `href` to the relative path of the platform's record file (`../../../../platform_catalog/<platform>.json`).

# Record Mapping
The following sections demonstrate how the various sections from the record are connected to the information displayed in the APEx Algorithm Service Catalogue.
Expand Down
Loading