Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 1.87 KB

HttpNewUserSignupRouteSpec.scala.md

File metadata and controls

87 lines (60 loc) · 1.87 KB
Raw
package io.komoot.server.routes.specs

import cats.effect.IO
import org.http4s.{Request, Response}

trait HttpNewUserSignupRouteSpec {

NEW-USER-SIGNUP

Simulate the 'ARN:SNS' which sends a notification to this client.

204 - POST ~/api/new-user-signup

PAYLOAD

application/json

Fields Type Description
name String Name of the new signup user
id Long Id of the new signup user
created_at String Date of the signup 
{
  "name": "Marcus",
  "id": 1589278470,
  "created_at": "2020-05-12T16:11:54.000"
}
  def notifyNewUserSignup(req: Request[IO]): IO[Response[IO]]

AWS-SNS-NEW-USER-SIGNUP

The API where the 'ARN:SNS' sends the notifications to this client.

204 - POST ~/api/aws-sns/new-user-signup

PAYLOAD

application/json

Fields Type Description
Message String Contains the message sends by the ARN:SNS
SubscribeURL URL For the very first message, the client needs to confirm the subscription by calling this endpoint 
{
  "Message": "{\"created_at\": \"2020-05-12T16:11:54.000\", \"name\": \"Marcus\", \"id\": 1}",
  "SubscribeURL": null
}
{
  "Message": "You have chosen to subscribe to the topic arn",
  "SubscribeURL": "https://sns.eu-west-3.amazonaws.com/?Action=ConfirmSubscription&TopicArn=arn:aw"
}
  def notifyNewUserSignupFromAwsSNS(req: Request[IO]): IO[Response[IO]]
}