Skip to content

Commit

Permalink
Update documentation of yaml specification file
Browse files Browse the repository at this point in the history
  • Loading branch information
c-martinez committed Aug 12, 2021
1 parent 17fe6a0 commit 58722bd
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ A grlc API specification file is a YAML file which includes the necessary inform
- `description`: API description
- `contact`: Contact details of the API owner. This should include the `name` and `url` properties.
- `licence`: A URL pointing to the licence file for the API.
- `queries`: A list of URLs of SPARQL queries (with header decorators).
- `queries`: A list of URLs of SPARQL queries (with header decorators). Alternatively a query can be defined as a dictionary with a `name` and a `url`.

For example:
```YAML
Expand All @@ -97,6 +97,8 @@ queries:
- https://www.mywebsite.org/query1.rq
- https://www.mywebsite.org/query2.rq
- https://www.otherwebsite.org/query3.rq
- name: QueryFour
url: https://www.mywebsite.org/query4.rq
```
### grlc generated API
Expand Down

0 comments on commit 58722bd

Please sign in to comment.