Ticket #276 (new task)

Opened 1 month ago

Last modified 3 weeks ago

Kauri documentation refactoring overview

Reported by: svr Assigned to: mpo
Priority: minor Milestone: 0.4
Component: < Documentation Version: trunk
Keywords: kauri doc documentation refactoring overview Cc:

Description

Document as attachment with our (sdm + svr) remarks about the current documentation of kauri 0.4. If there are any questions or remarks, just ask.

Attachments

Overview issues kauri documentation.pdf (166.2 kB) - added by svr on 04/02/10 13:55:06.
document with remarks about the current version of the documentation of kauri 0.4

Change History

04/02/10 13:55:06 changed by svr

  • attachment Overview issues kauri documentation.pdf added.

document with remarks about the current version of the documentation of kauri 0.4

(in reply to: ↑ description ) 22/02/10 10:21:43 changed by sdm

Apparently there is no documentation about URIs like the following:

"uri": '${publicUri('service:/myRouter')}/acc/byRoles/{-list|,|roles}'

The structure {-list|,|roles} is used to define the separator between the different values of "roles". But apart from -list, the following options also exist: -prefix, -append, -opt, -neg and -join. It is not clear how, when and why to use these.

It would also be useful if the documentation mentioned how to assign a default value to a variable, like this: {id=-1}

The explanation on the following page is quite clear and could be used as a reference:

http://bitworking.org/projects/URI-Templates/spec/draft-gregorio-uritemplate-03.html