diff --git a/chatto/src/main/javascript/ts/src/singleton/JsonAPI.ts b/chatto/src/main/javascript/ts/src/singleton/JsonAPI.ts index b3bef81..3bc7db6 100644 --- a/chatto/src/main/javascript/ts/src/singleton/JsonAPI.ts +++ b/chatto/src/main/javascript/ts/src/singleton/JsonAPI.ts @@ -7,26 +7,30 @@ export namespace JsonAPI { /** * Json API URL for retrieving all messages between two users * + * ### With sprintf + * const url = Sprintf(JsonAPI.CHAT_MESSAGES_GET, contactName); + * * @format /api/chat/get/messages/{contactName} * @example /api/chat/get/messages/some-user * - * ### With sprintf - * const url = Sprintf(JsonAPI.CHAT_MESSAGES_GET, contactName); * * @param contactName - * The user whose messages wish to retrieve. + * The user whose messages we wish to retrieve. */ export const CHAT_MESSAGES_GET = `/api/chat/get/messages/%s`; export const MESSAGE_POST = '/api/chat/post/message'; /** * Json API URL for retrieving paginated messages between two users * Page index starts with 0 - * @example /api/chat/get/messages/some-user?page=0&size=5 will give the first page where each page has size 5 * * ### With sprintf * const url = Sprintf(JsonAPI.CHAT_MESSAGES_GET, contactName); * - * @param contactName the user whose messages wish to retrieve + * @example /api/chat/get/messages/some-user?page=0&size=5 will give the first page where each page has size 5 + * + * + * + * @param contactName the user whose messages we wish to retrieve * @param page denotes the page required * @param size denotes the size of each page */