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

Overview on ogcapi.ogc.org is outdated #60

Open
jerstlouis opened this issue Nov 11, 2022 · 2 comments
Open

Overview on ogcapi.ogc.org is outdated #60

jerstlouis opened this issue Nov 11, 2022 · 2 comments
Assignees

Comments

@jerstlouis
Copy link
Member

jerstlouis commented Nov 11, 2022

The overview at:

https://ogcapi.ogc.org/dggs/overview.html

is outdated, and could be replaced by the content from a subset of the README in this repository.

@geofizzydrink @ghobona

@jerstlouis
Copy link
Member Author

Reached out to Greg and Gobe.

In addition, the text above "Overview" should be rephrased to say:

The draft OGC API - Discrete Global Grid Systems standard specifies an API for accessing and querying data from a Discrete Global Grid System (DGGS) implementation supporting one or more Discrete Global Grid Reference Systems (DGGRSs).

A DGGRS is a spatial reference system that uses a hierarchical tessellation of zones to partition and address the globe.

The same fix for this short description should also be made to the higher up page at:

https://ogcapi.ogc.org/dggs/

In addition, I believe the ReDoc page at https://developer.ogc.org/api/dggs/index.html was pointed out as being outdated.

I believe a similar ReDoc page can be automatically generated by pointing it directly to the latest bundled JSON OpenAPI definition:
https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/opengeospatial/ogcapi-discrete-global-grid-systems/master/openapi/ogcapi-dggs-1.bundled.json

As a general point applying to all of the OGC APIs on this ogcapi.ogc.org, the Overview pages are missing a link back to the resource above, which makes it difficult to get to the GitHub repository or even to the published / draft standard themselves.
Since the Overview is often where users end up as a result of search engines, I believe this is a problem which should be fixed.

Thank you!

@jerstlouis
Copy link
Member Author

jerstlouis commented Dec 7, 2024

Thanks @ghobona for the update on the overview.

There is still a small mismatch:

Overview for GET .../dggs says List of DGGS Resource Instances.

This should say List of Discrete Global Grid Reference Systems (DGGRS).

Though in the past we sometimes referred to these as DGGS Resource Instances, we are trying to clarify the terminology based on Topic 21 and the additional clarifications in the DGGS API standard.

From the point of view of the DGGS API, there is really a single system/implementation (DGGS) at .../dggs which supports one or more DGGRSs at .../dggrs/{dggrsId} (which are listed in that .../dggs resource). Whether the underlying implementation uses one or more different software libraries to implement each DGGRS is an implementation detail.

See #56 (comment) for more details on this discussion.

See PR opengeospatial/ogcapi-org#77

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

No branches or pull requests

3 participants