search

opengeospatial / ogcapi-discrete-global-grid-systems

https://ogcapi.ogc.org/dggs
Other
20 stars 8 forks source link

Is ZonalID declared as a parameter? #45

Open ghobona opened 2 years ago

ghobona commented 2 years ago

I ran version 0.0.6 of the DGGS API definition document through OpenAPITools Generator and got this error:

Errors: 
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/intersects'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/relativePosition'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/intersects'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/touches'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/relate'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/touches'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/childOf'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/siblingOf'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/relatePosition'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/union'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/union'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/withinDistance'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/symDifference'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/parentOf'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/equals'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/withinDistance'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/relatePosition'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/difference'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/relativePosition'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/distance'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/crosses'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/intersection'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/overlaps'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/crosses'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/within'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/difference'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/contains'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/relate'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/disjoint'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/siblingOf'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/equals'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/distance'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/overlaps'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/disjoint'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/childOf'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/within'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/parentOf'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/intersection'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/symDifference'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/contains'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
Warnings: 
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/intersects'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/relativePosition'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/intersects'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/touches'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/relate'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/touches'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/childOf'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/siblingOf'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/relatePosition'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/union'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/union'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/withinDistance'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/symDifference'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/parentOf'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/equals'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/withinDistance'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/relatePosition'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/difference'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/relativePosition'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/distance'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/crosses'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/intersection'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/overlaps'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/crosses'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/within'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/difference'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/contains'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/relate'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/disjoint'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/siblingOf'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/equals'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/distance'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/overlaps'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/disjoint'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/childOf'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/within'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/parentOf'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/intersection'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/symDifference'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
    -attribute paths.'/dggs/{dggsRSID}/zone/{ZonalID}/contains'. Declared path parameter ZonalID needs to be defined as a path parameter in path or operation level
ghobona commented 2 years ago

I think the reason is that ZonalID is mentioned in the path, but the description says it is in the query. See the attached screenshot.

Screenshot 2021-10-28 at 12 05 52

ghobona commented 2 years ago

Outcome of discussion. The resource needs another ZonalID. Therefore one is a path parameter, and the other is a query parameter.

ghobona commented 2 years ago

A tesselate(geometry,...) function could enable the conversion of WKT-like geometries into ZonalIDs.

there could be an extension like e.g. AT_RESOLUTION(2 m) or AT_RESOLUTION(DGGS(h3, 3))

ghobona commented 2 years ago

@pvretano for more information on tesselate().

@jerstlouis for more information on AT_RESOLUTION().