Open-EO / openeo-backend-validator

Service to validate back-end compliance with the API specification.
Apache License 2.0
1 stars 3 forks source link

root capabilities endpoint `/` listed as "NotSupported" #41

Closed soxofaan closed 4 years ago

soxofaan commented 4 years ago

I just updated validator to latest version (8998ea2) and it seems the capabilities endpoint is now handled as "NotSupported":


"root": {
                    "message": "Endpoint skipped, not listed in backend capabilities",
                    "state": "NotSupported",
                    "type": "GET",
                    "url": "/"
                },
bgoesswe commented 4 years ago

So I guess, the "/" endpoint is not listed your capabilities, which brings us to the question if "/" has to be in the endpoints list of the capabilities since it is kind of unnecessary... If not I would treat it special. I am not completely sure, what do you say @m-mohr?

soxofaan commented 4 years ago

the example in the API docs currently does not include / in the endpoints listing

I think it is a special case that should not be included explicitly in the list, but still be considered supported

m-mohr commented 4 years ago

Hmm... I think I'll clarify in the API that / must only be listed if any other than the current request is supported (e.g. if an extensions adds PATCH / or whetever).

m-mohr commented 4 years ago

Like that?

An entry for this endpoint (path / with method GET) SHOULD NOT be listed.

soxofaan commented 4 years ago

maybe also express that GET / is considered to be supported automatically, then the validator does not have to assume that

m-mohr commented 4 years ago

I added

This endpoint MUST always be available for the API to be valid.

to the main description of the endpoint.

bgoesswe commented 4 years ago

With 50ad24d45992e618c25832996bbeacaadfb02f63 the validation of "/" is independent from the endpoints in the capabilities.

soxofaan commented 4 years ago

confirmed, thanks