Query decorators

In addition to the actual query the .rq files can also hold specific query decorators that enhance the resulting query in the API. The decorators always start with #+ and must be placed at the beginning of the query. These are some of the decorators that can be used:

• defaults is used to set a default value for a specific parameter in the query, in case it is not supplied by the user.
• enumerate restricts the input for specified parameters to a given set of possibilities.
• endpoint will be the endpoint for the query. When endpoint is not defined it will default to http://dbpedia.org/sparql.
• method sets the HTTP method that is used to send the query (GET is default).
• mime declares the mime-type of the endpoint when it is not a SPARQL endpoint.
• pagination determines the number of items that are returned per page and adds a parameter which is the page number of the page that is returned.
• summary adds a short description of the functionality of the query to the API, so users will know what the query will return.
• tags will be used to categorize the query within the API, grouping the queries with the same tag. Multiple tags will result in multiple duplicates of the query on the the API page.

The decorators of the queries are based on the decorators used in YAML.

example

#+ summary: Returns the track names of the MIDI file of the Ghostbusters theme
#+ endpoint: https://raw.githubusercontent.com/albertmeronyo/lodapi/master/ghostbusters.ttl
#+ mime: text/turtle
#+ tags:
#+   - RDF dump
#+ method: GET
#+ pagination: 50
#+ defaults:
#+   - midiEvent: http://example.org/midi/Track
#+ enumerate:
#+   - midiEvent:
#+      - http://example.org/midi/Track
#+      - http://example.org/midi/ProgramChangeEvent
#+      - http://example.org/midi/TrackNameEvent

PREFIX mid: <http://example.org/midi/>

SELECT ?s WHERE {
    ?s a ?_midiEvent_iri .
}