Skip to content

How to document query functions? #56

@situx

Description

@situx

We are considering documenting the query functions of OGC GeoSPARQL using the building blocks environment.

I did not see any example of how to do that, so my question is:

Is building blocks meant for this in general?

I would like to document a query function by URI (in addition to the rainbow), provide a SPARQL query example, a sample (correct) query result and a test dataset on which the query could be executed.
It might look sth. liks this in my opinion: https://github.com/opengeospatial/ogc-geosparql/tree/13buildingblocks/_sources/geof/is3D

We have already prepared many of these resources for the GeoSPARQL compliance benchmark, including many correct and incorrect query executions:
https://github.com/OpenLinkSoftware/GeoSPARQLBenchmark/tree/master/src/main/resources

Also all functions including their parameters are already modeled in RDF:
https://github.com/opengeospatial/ogc-geosparql/blob/13buildingblocks/vocabularies/functions.ttl

So could building blocks be a way to document these functions and examples better or should query function executions actually become tests in the future which could be picked up by compliance benchmark implementations from the building blocks structure?

And if yes how would you recommend the documentation of query functions?

Let me know what you think and whether this is the right place to ask this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions