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

GEP Services Examples #39

Merged
merged 9 commits into from
Nov 22, 2024
Merged

GEP Services Examples #39

merged 9 commits into from
Nov 22, 2024

Conversation

p3dr0
Copy link
Member

@p3dr0 p3dr0 commented Oct 9, 2024

Here are two examples of services instantiated in GEP

@p3dr0 p3dr0 mentioned this pull request Oct 9, 2024
11 tasks
@jdries
Copy link
Contributor

jdries commented Oct 10, 2024

Hi @p3dr0, thanks, these records indeed look valid.
I propose that we do a more thorough review of these first cases, so that we have at least 1 high quality example that we can point other users to. (That's how we did it for openEO as well.)

So as for review:

The description/documentation is important, here's an example of a description we did:
https://github.com/ESA-APEx/apex_algorithms/blob/main/algorithm_catalog/max_ndvi_composite_files/max_ndvi_composite_description.md
I think we now put that in the udp, but it can also be used at the level of the OGC record.

Of course, if you have good documentation on the GEP, it makes a lot of sense to also link to that.

What I also did, is adding a link to STAC metadata of example output, like this:

{
  "rel": "example",
  "type": "application/json",
  "title": "Example output",
  "href": "https://s3.waw3-1.cloudferro.com/swift/v1/APEx-examples/max_ndvi_denmark/collection.json"
}

I think this is one of the most convenient ways to show what an algorithm actually produces, and this is something that we can then for instance show in geospatial explorer.

Finally, but most importantly, can you add the link to the OGC Process description? This is the crucial element for all the tooling to work, but also simply required for users to be able to generate output.

@JanssenBrm
Copy link
Contributor

@p3dr0 - Have you already had the chance to look at the previous request for updates? It may be too late to fully integrate the OGC Processes in all of the tools, but it would be nice if we could (at least) show these services in our catalogue. Our catalogue team is waiting for the finalization of this PR to continue the work.

added access and documentation links
added access and documentation links
@p3dr0
Copy link
Member Author

p3dr0 commented Nov 20, 2024

I updated both json files with links

please note that I'm considering these relations types

  • “rel”: “order” -> is where you can obtain information about how to buy it
  • “rel”: “license”, -> link for the EULA of the service
  • “rel”: “service”, -> direct link to submit, status, etc … (no need to make string addition with other rels)
  • “rel”: “documentation” -> direct link for the documentation pages
  • “rel”: “application” -> direct links for the application package

these are self-standing, this means from each alone you are able to complete an action in a given context (provided by the relation and mime-type), it should not be needed to sum them together in pairs to provide an action

in the examples updated, both the service and application links are protected so you'll get a 403 for now

@JanssenBrm JanssenBrm merged commit 5f68ec6 into ESA-APEx:main Nov 22, 2024
@soxofaan soxofaan mentioned this pull request Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants