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

Process Examples incomplete #285

Closed
m-mohr opened this issue May 25, 2020 · 0 comments · Fixed by #286
Closed

Process Examples incomplete #285

m-mohr opened this issue May 25, 2020 · 0 comments · Fixed by #286
Labels
Milestone

Comments

@m-mohr
Copy link
Member

m-mohr commented May 25, 2020

Process examples can consist of either arguments only or a process graph at the moment. For process graphs, I probably have forgotten to update the process examples structure when doing the changes for #161. Looking through the processes, the process_graph variant of the examples is rarely used yet (see also Open-EO/openeo-processes#136 ). Another issue is that adding multiple "process graph" examples to a process will increase the size of the GET /results response by far. Also many examples get duplicated. Thus I propose the following:

  • Remove process graph examples from the processes + API
  • Add A rel type "example" to the list and allow linking to examples externally. This decreases the response size and makes re-using examples easier.

Strictly speaking, this is a breaking change, but I think it's very rarely used at the moment (maybe even not used at all) and it makes the spec cleaner.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant