Documenting JSON queries

CLARIAH / grlc

grlc builds Web APIs using shared SPARQL queries

http://grlc.io

MIT License

137 stars 32 forks source link

Documenting JSON queries #482

Open c-martinez opened 4 months ago

c-martinez commented 4 months ago

Because we use SPARQLTransformer, it is possible to express queries in JSON format. However, this functionality is not very well documented. We should improve the documentation to better communicate this functionality and provide some examples.

At the same time, it would be good to add tests to check JSON queries are properly handled and that JSON files which are NOT queries are safely ignored.

c-martinez commented 3 months ago

The second part of this

add tests to check JSON queries are properly handled and that JSON files which are NOT queries are safely ignored.

is covered by #487

c-martinez commented 3 months ago

An example query has been created in the queries repo