Project chat RestXQ documentation
Summary
This document provides details of the RestXQ annotations. These provide mappings from Web endpoints to XQuery code.
- Base path
- ///chat
Related documents
| View | Description | Format |
|---|---|---|
| report | Index of sources | xhtml |
| imports | Summary of import usage | xhtml |
| imports-diag | Project wide module imports as html mermaid class diagram | html5 |
| imports-diag.mmd | Project wide module imports as a mermaid class diagram | text |
| annotations | Summary of XQuery annotation use | xhtml |
| xqdoca.xml | xqDocA run configuration report (XML) | xml |
| xqdoc-validate | validate generated xqdoc files | xml |
Rest interface paths
2.1 /chat
ALL
/chatRA
- Description
Login or main page.
chat:chat#0- Output
- Serialization: html
Annotations (2)
%rest:path | ('/chat') |
%output:method | ('html') |
2.2 /chat/login-check
POST
/chat/login-checkR
- Description
Checks the user input, registers the user and reloads the chat.
chat:login-check#2- Query parameters
Name Type Description Default name xs:string username pass xs:string password
Annotations (4)
%rest:POST | () |
%rest:path | ('/chat/login-check') |
%rest:query-param | ('name','{$name}') |
%rest:query-param | ('pass','{$pass}') |
2.3 /chat/logout
ALL
/chat/logoutR
- Description
Logs out the current user, notifies all WebSocket clients, and redirects to the login page.
chat:logout#0
Annotations (1)
%rest:path | ('/chat/logout') |