Mercurial > p > roundup > code
comparison doc/customizing.txt @ 6631:9455538c4a1f
Add /rest/ and /xmlrpc/ to section Roundup URL design
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 11 Apr 2022 17:51:57 -0400 |
| parents | 24e2eeb2ed9a |
| children | e1588ae185dc c68739264869 |
comparison
equal
deleted
inserted
replaced
| 6630:0351caa802f7 | 6631:9455538c4a1f |
|---|---|
| 2206 | 2206 |
| 2207 The following prefix is used to access static resources: | 2207 The following prefix is used to access static resources: |
| 2208 | 2208 |
| 2209 4. ``/@@file/`` | 2209 4. ``/@@file/`` |
| 2210 | 2210 |
| 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 | |
| 2211 All other URLs depend on the classes configured in Roundup database. | 2224 All other URLs depend on the classes configured in Roundup database. |
| 2212 Each class receives two URLs - one for the class itself and another | 2225 Each class receives two URLs - one for the class itself and another |
| 2213 for specific items of that class. Example for class URL: | 2226 for specific items of that class. Example for class URL: |
| 2214 | 2227 |
| 2215 5. ``/issue`` | 2228 7. ``/issue`` |
| 2216 | 2229 |
| 2217 This is usually used to show listings of class items. The URL for | 2230 This is usually used to show listings of class items. The URL for |
| 2218 for specific object of issue class with id 1 will look like: | 2231 for specific object of issue class with id 1 will look like: |
| 2219 | 2232 |
| 2220 6. ``/issue1`` | 2233 8. ``/issue1`` |
| 2221 | 2234 |
| 2222 | 2235 |
| 2223 Determining web context | 2236 Determining web context |
| 2224 ----------------------- | 2237 ----------------------- |
| 2225 | 2238 |