Skip to content

Commit 131fd91

Browse files
committed
Add /rest/ and /xmlrpc/ to section Roundup URL design
1 parent b53c5f4 commit 131fd91

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

doc/customizing.txt

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2208,16 +2208,29 @@ The following prefix is used to access static resources:
22082208

22092209
4. ``/@@file/``
22102210

2211+
Two additional url's are used for the API's.
2212+
The `REST api`_ is accessed via:
2213+
2214+
5. ``/rest/``
2215+
2216+
.. _`REST api`: rest.html
2217+
2218+
and the `XMLRPC api`_ is available at:
2219+
2220+
6. ``/rest/``
2221+
2222+
.. _`XMLRPC api`: xmlrpc.html
2223+
22112224
All other URLs depend on the classes configured in Roundup database.
22122225
Each class receives two URLs - one for the class itself and another
22132226
for specific items of that class. Example for class URL:
22142227

2215-
5. ``/issue``
2228+
7. ``/issue``
22162229

22172230
This is usually used to show listings of class items. The URL for
22182231
for specific object of issue class with id 1 will look like:
22192232

2220-
6. ``/issue1``
2233+
8. ``/issue1``
22212234

22222235

22232236
Determining web context

0 commit comments

Comments
 (0)