This document outlines the APIs within the Chatter Forums module.

Thread APIs

Fetch Threads

• Endpoint: /api/chatter/threads
• Method: GET
• Description: Retrieve a list of threads.
• Parameters: None
• Response: JSON array of threads with basic details.

Create Thread

• Endpoint: /api/chatter/threads
• Method: POST
• Description: Create a new thread.
• Parameters: Forum ID, user ID, title, content.
• Response: JSON object of the newly created thread.

Update Thread

• Endpoint: /api/chatter/threads/{id}
• Method: PUT
• Description: Update an existing thread.
• Parameters: Thread ID, updated title or content.
• Response: JSON object of the updated thread.

Delete Thread

• Endpoint: /api/chatter/threads/{id}
• Method: DELETE
• Description: Delete a thread.
• Parameters: Thread ID.
• Response: Success or error message.

Fetch Thread by ID

• Endpoint: /api/chatter/threads/{id}
• Method: GET
• Description: Retrieve details of a specific thread.
• Parameters: Thread ID.
• Response: JSON object with detailed information about the thread.

Fetch Threads by Forum

• Endpoint: /api/chatter/forums/{forum_id}/threads
• Method: GET
• Description: Retrieve threads within a specific forum.
• Parameters: Forum ID.
• Response: JSON array of threads within the forum.

Post APIs

Fetch Posts

• Endpoint: /api/chatter/posts
• Method: GET
• Description: Retrieve a list of posts.
• Parameters: None
• Response: JSON array of posts with basic details.

Create Post

• Endpoint: /api/chatter/posts
• Method: POST
• Description: Create a new post.
• Parameters: Thread ID, user ID, content.
• Response: JSON object of the newly created post.

Update Post

• Endpoint: /api/chatter/posts/{id}
• Method: PUT
• Description: Update an existing post.
• Parameters: Post ID, updated content.
• Response: JSON object of the updated post.

Delete Post

• Endpoint: /api/chatter/posts/{id}
• Method: DELETE
• Description: Delete a post.
• Parameters: Post ID.
• Response: Success or error message.

Fetch Posts by Thread

• Endpoint: /api/chatter/threads/{thread_id}/posts
• Method: GET
• Description: Retrieve posts within a specific thread.
• Parameters: Thread ID.
• Response: JSON array of posts within the thread.

Fetch Posts by User

• Endpoint: /api/chatter/users/{user_id}/posts
• Method: GET
• Description: Retrieve posts created by a specific user.
• Parameters: User ID.
• Response: JSON array of posts created by the user.

Forum APIs

Fetch Forums

• Endpoint: /api/chatter/forums
• Method: GET
• Description: Retrieve a list of forums.
• Parameters: None
• Response: JSON array of forums with basic details.

Create Forum

• Endpoint: /api/chatter/forums
• Method: POST
• Description: Create a new forum.
• Parameters: Name, description.
• Response: JSON object of the newly created forum.

Update Forum

• Endpoint: /api/chatter/forums/{id}
• Method: PUT
• Description: Update an existing forum.
• Parameters: Forum ID, updated name or description.
• Response: JSON object of the updated forum.

Delete Forum

• Endpoint: /api/chatter/forums/{id}
• Method: DELETE
• Description: Delete a forum.
• Parameters: Forum ID.
• Response: Success or error message.

Fetch Forum by ID

• Endpoint: /api/chatter/forums/{id}
• Method: GET
• Description: Retrieve details of a specific forum.
• Parameters: Forum ID.
• Response: JSON object with detailed information about the forum.

Fetch Forums by User

• Endpoint: /api/chatter/users/{user_id}/forums
• Method: GET
• Description: Retrieve forums created by a specific user.
• Parameters: User ID.
• Response: JSON array of forums created by the user.

Plugin APIs

Upload Plugin

• Endpoint: /api/chatter/plugin/upload
• Method: POST
• Description: Upload and install a new plugin.
• Parameters: Plugin ZIP file (uploaded as multipart/form-data).
• Response: JSON object with success or error message.

Check Plugin Existence

• Endpoint: /api/chatter/plugin/exists
• Method: GET
• Description: Check if a plugin exists.
• Parameters: None
• Response: JSON object indicating if the plugin exists.