0.4.1 • Published 5 years ago

mock-chat-platforms v0.4.1

Weekly downloads
3
License
UNLICENSED
Repository
github
Last release
5 years ago

mock-chat-platforms

Service that provides API for Finn Chat Platform and Finn Chat Agent

Endpoints

Mock Agent Platform

Mock Agent Platform Schema

Collection of routes that emulates an agent platform:

  • /mockAgentPlatform/agents - GET a list of available agents.
  • /mockAgentPlatform/connect/:sessionId - POST Connect to Agent request.

Mock Chat Platform

Mock Chat Platform Schema

Collection of routes that emulates a chat platform:

  • /mockChatPlatform/message - POST a message to user.
  • /mockChatPlatform/status/typing/:sessionId - POST a typing status update to user.

Run the service

By default, the service runs on port 3088 with default env variable ENV_CODE=local.

Run locally

npm run start-local

Run with Docker

npm run build to build the service.

Once built, use npm run start.

Run with Kubernetes

Mock Chat Platforms service can be run locally against a dev Kubernetes bot through Tilt.dev. Setup and running instructions can be found in this confluence document.