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

case insensitive handling of UDF runtimes ? #510

Open
soxofaan opened this issue Sep 8, 2023 · 5 comments
Open

case insensitive handling of UDF runtimes ? #510

soxofaan opened this issue Sep 8, 2023 · 5 comments
Milestone

Comments

@soxofaan
Copy link
Member

soxofaan commented Sep 8, 2023

Quite a bit of "ids" are accepted in case insensitive manner:

Format names MUST be accepted in a *case insensitive* manner throughout the API.

Billing plans MUST be handled in a *case insensitive* manner.

Service types MUST be accepted in a *case insensitive* manner.

Can we also do that for UDF runtimes?

Strictly speaking this is probably a breaking change, but I don't think that will break anything in practice.

@soxofaan
Copy link
Member Author

soxofaan commented Sep 8, 2023

side-note:

Service names MUST be accepted in a *case insensitive* manner throughout the API.

I think this should be Service types MUST be accepted... like done here:

openeo-api/openapi.yaml

Lines 5752 to 5753 in c5a45b4

service types can be retrieved via `GET /service_types`. Service types
MUST be accepted in a *case insensitive* manner.

@m-mohr
Copy link
Member

m-mohr commented Sep 8, 2023

That looks like an oversight, unfortunately.

@m-mohr
Copy link
Member

m-mohr commented Sep 8, 2023

On the other hand:

It is RECOMMENDED to use the following naming and casing:
* For programming langauge environments use the names as provided
in in the Scriptol List of Programming Languages.
* For docker images use the docker image identifier excluding the registry path.

@soxofaan
Copy link
Member Author

soxofaan commented Sep 8, 2023

hmm that note doesn't seem to be rendered on e.g. https://openeo.org/documentation/1.0/developers/api/reference.html

Also it recommends how runtimes should be named in the /udf_runtime response, not what backends must do when receiving a process graph with run_udf(..., runtime="pYthOn")

@m-mohr
Copy link
Member

m-mohr commented Sep 8, 2023

Yeah, ReDoc has some limitations and doesn't show everything.

Indeed, so right now it should be assumed to be case-sensitive.

@m-mohr m-mohr added this to the 2.0.0 milestone Sep 8, 2023
soxofaan added a commit to Open-EO/openeo-python-client that referenced this issue Sep 8, 2023
and improve type annotations along the way
related to #470 and Open-EO/openeo-api#510
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants