CropSAR_px UDF and CropSAR UDF APIs are not consistent
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 30
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
Description
CropSAR and CropSAR_px are both processes available from the list of UDF processes provided by VITO and are often used in the FuseTS framework. With OpenEO it is possible to also get the documentation of each process, and it turns out that, according to the documentation, the APIs for these two processes are not the same, and it would make more sense if the APIs were aligned.
By comparing the function fingerprints with
connection.describe_process(id="CropSAR", namespace="vito")andconnection.describe_process(id="CropSAR_px", namespace="vito")
The interface of the latter process is much more defined and allows the user greater operability with the UDF, while for the former process, the interface is quite limited.
Recommendations
We recommend that the authors of the processes better align the interface to these two very similar processes.
Acceptance criterea
- The required parameters for both service use a consistent name and description
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running the two documented calls, connection.describe_process(id="CropSAR", namespace="vito") and connection.describe_process(id="CropSAR_px", namespace="vito"), and compare their required parameters and descriptions. Confirm where these UDF process definitions are maintained, then align the required parameter names and descriptions and verify both process fingerprints are consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100