Mercurial > p > roundup > code
annotate doc/license.txt @ 5632:a29a8dae2095
Initial implementation of function to return data for / and /data
endpoints under /rest/.
/rest/ returns:
1) default_version of the interface and supported_version array
2) list of links with rel and uri properties that indicate
what assets are available under /rest. E.g. /rest/data
/data returns:
a list of possible assets (e.g. issue, user, keyword, status)
and links for accessing those assets.
E.G.
{
"data": {
"keyword": {
"link": "https://example.net/demo/rest/data/keyword"
},
"user": {
"link": "https://example.net/demo/rest/data/user"
}, ...
}
}
Both of these are currently hand coded. Others will be doing more
development on the rest interface. These two examples are meant to
spark discussion on what the payloads returned by the rest interface
should look like and give some ideas around HATEOAS.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Fri, 01 Mar 2019 23:24:40 -0500 |
| parents | f22831a12ab8 |
| children | 8a73b0b12102 |
| rev | line source |
|---|---|
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
1 License |
|
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
2 ======= |
|
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
3 |
|
4612
771e66e8c0b4
Trying to get the license included in the generated website docs.
Bernhard Reiter <bernhard@intevation.de>
parents:
4033
diff
changeset
|
4 Roundup is Free Software under the following license (from the file |
|
771e66e8c0b4
Trying to get the license included in the generated website docs.
Bernhard Reiter <bernhard@intevation.de>
parents:
4033
diff
changeset
|
5 COPYING.txt in the software distribution): |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
6 |
|
4621
f22831a12ab8
Fix path to included COPYING.txt.
Ralf Schlatterbeck <rsc@runtux.com>
parents:
4612
diff
changeset
|
7 .. include:: ../COPYING.txt |
|
4612
771e66e8c0b4
Trying to get the license included in the generated website docs.
Bernhard Reiter <bernhard@intevation.de>
parents:
4033
diff
changeset
|
8 :literal: |
