feature/added resourceDoc endpoint

.gitignore

@@ -139,6 +139,6 @@ build/
 
 *.code-workspace
 .specstory
-project/project/metals.sbt
-project/metals.sbt
+metals.sbt
 .bsp/sbt.json
+*.conf

README.md

@@ -87,6 +87,20 @@ connectors {
 
 See `ai.log` for detailed development history and architectural decisions.
 
+
+## Deployment
+
+1. Build the assembly JAR:
+   ```bash
+   sbt assembly
+   ```
+2. Copy the JAR from `target/scala-2.13/obp-trading-assembly-0.1.0-SNAPSHOT.jar` to your server.
+3. Run with Java 11+:
+   ```bash
+   java -jar obp-trading-assembly-0.1.0-SNAPSHOT.jar
+   ```
+
+
 ## License
 
 AGPL-3.0  

build.sbt

@@ -43,6 +43,11 @@ libraryDependencies ++= Seq(
   "io.circe" %% "circe-generic" % "0.14.6",
   "io.circe" %% "circe-parser" % "0.14.6",
   "io.circe" %% "circe-literal" % "0.14.6",
+
+  // JSON Schema generation
+  "com.github.andyglow" %% "scala-jsonschema" % "0.7.11",
+  "com.github.andyglow" %% "scala-jsonschema-circe-json" % "0.7.11",
+
 
   // Database
   "com.typesafe.slick" %% "slick" % slickVersion,

src/main/resources/application.conf.example

@@ -1,6 +1,11 @@
 // Example configuration for OBP-Trading
 // Copy to application.conf and adjust values for your environment
 
+server {
+  host = "0.0.0.0" // HTTP server host
+  port = "8086"    // HTTP server port
+}
+
 obp {
   api {
     base_url = "https://api.openbankproject.com" // OBP-API base URL

src/main/scala/com/openbankproject/trading/docs/TradingResourceDocs.scala

@@ -0,0 +1,13 @@
+package com.openbankproject.trading.docs
+
+import com.openbankproject.trading.docs.model.ResourceDoc
+import com.openbankproject.trading.docs.registry.ResourceDocRegistry
+
+object TradingResourceDocs {
+
+  private val docs: Seq[ResourceDoc] = Seq.empty
+
+  def registerAll(): Unit = ResourceDocRegistry.registerAll(docs)
+}
+
+

src/main/scala/com/openbankproject/trading/docs/model/EmptyBody.scala

@@ -0,0 +1,11 @@
+package com.openbankproject.trading.docs.model
+
+/**
+  * Marker for empty request/response body in ResourceDoc examples.
+  */
+case object EmptyBody extends Product with Serializable {
+  override def productArity: Int = 0
+  override def productElement(n: Int): Any = throw new IndexOutOfBoundsException(n.toString)
+  override def canEqual(that: Any): Boolean = that.isInstanceOf[EmptyBody.type]
+}
+

src/main/scala/com/openbankproject/trading/docs/model/ErrorDoc.scala

@@ -0,0 +1,5 @@
+package com.openbankproject.trading.docs.model
+
+final case class ErrorDoc(code: String, httpStatus: Int, message: Option[String] = None)
+
+

src/main/scala/com/openbankproject/trading/docs/model/HttpMethod.scala

@@ -0,0 +1,15 @@
+package com.openbankproject.trading.docs.model
+
+sealed trait HttpMethod extends Product with Serializable { def name: String }
+
+object HttpMethod {
+  case object GET extends HttpMethod { val name: String = "GET" }
+  case object POST extends HttpMethod { val name: String = "POST" }
+  case object PUT extends HttpMethod { val name: String = "PUT" }
+  case object DELETE extends HttpMethod { val name: String = "DELETE" }
+  case object PATCH extends HttpMethod { val name: String = "PATCH" }
+  case object HEAD extends HttpMethod { val name: String = "HEAD" }
+  case object OPTIONS extends HttpMethod { val name: String = "OPTIONS" }
+}
+
+

src/main/scala/com/openbankproject/trading/docs/model/RequiredRole.scala

@@ -0,0 +1,11 @@
+package com.openbankproject.trading.docs.model
+
+sealed trait RequiredRole extends Product with Serializable
+
+object RequiredRole {
+  case object Public extends RequiredRole {
+    override def toString: String = "Public"
+  }
+}
+
+

src/main/scala/com/openbankproject/trading/docs/model/ResourceDoc.scala

@@ -0,0 +1,120 @@
+package com.openbankproject.trading.docs.model
+
+import com.openbankproject.trading.http.OBPEndpoint
+import io.circe.Json
+import java.time.Instant
+
+/**
+  * ResourceDoc aligned with OBP-API structure.
+  * Simplified version without Lift dependencies.
+  *
+  * @param partialFunction The actual partial function implementing this endpoint
+  * @param implementedInApiVersion API version (e.g., "v7.0.0")
+  * @param partialFunctionName Name of the partial function (e.g., "getOfferPF")
+  * @param requestVerb HTTP method (GET, POST, PUT, DELETE, etc.)
+  * @param requestUrl URL pattern with path parameters
+  * @param summary Short description of the endpoint
+  * @param description Detailed description
+  * @param exampleRequestBody Example request body as case class (use EmptyBody if no body)
+  * @param successResponseBody Example success response as case class
+  * @param errorResponseBodies List of possible error messages
+  * @param tags Tags for categorization
+  * @param roles Required roles (None means public)
+  */
+final case class ResourceDoc(
+  partialFunction: OBPEndpoint,
+  implementedInApiVersion: String,
+  partialFunctionName: String,
+  requestVerb: String,
+  requestUrl: String,
+  summary: String,
+  description: String,
+  exampleRequestBody: Option[Product] = None,
+  successResponseBody: Product,
+  errorResponseBodies: List[String],
+  tags: List[String],
+  roles: Option[List[String]] = None,
+  isFeatured: Boolean = false,
+  specialInstructions: Option[String] = None,
+  specifiedUrl: String = "",
+  createdByBankId: Option[String] = None
+) {
+  require(partialFunctionName.trim.nonEmpty, "partialFunctionName must be non-empty")
+  require(requestUrl.trim.nonEmpty, "requestUrl must be non-empty")
+  require(requestVerb.trim.nonEmpty, "requestVerb must be non-empty")
+}
+
+/**
+  * Used to describe where an API call is implemented, similar to OBP's ImplementedByJson.
+  */
+final case class ImplementedByJson(
+  version: String,  // Short hand for version, e.g. "v7_0_0"
+  function: String  // The partial function name, e.g. "getOfferPF"
+)
+
+/**
+  * Export-friendly ResourceDocJson, mirroring OBP-API structure for docs/export.
+  */
+
+/**
+  * Metadata summary for exported ResourceDocs.
+  */
+final case class ResourceDocMeta(
+  response_date: Instant,
+  count: Int
+)
+
+/**
+  * Wrapper for exported docs list and metadata.
+  */
+final case class ResourceDocsJson(
+  resource_docs: List[ResourceDocJson],
+  meta: Option[ResourceDocMeta] = None
+)
+
+final case class ResourceDocJson(
+  operation_id: String,
+  implemented_by: ImplementedByJson,
+  request_verb: String,
+  request_url: String,
+  summary: String,
+  description: String,
+  description_markdown: String,
+  example_request_body: Option[Json],
+  success_response_body: Json,
+  error_response_bodies: List[String],
+  tags: List[String],
+  typed_request_body: Option[Json],
+  typed_success_response_body: Option[Json],
+  roles: Option[List[String]] = None,
+  is_featured: Boolean = false,
+  special_instructions: Option[String] = None,
+  specified_url: String,
+  connector_methods: List[String] = Nil,
+  created_by_bank_id: Option[String] = None
+)
+
+object ResourceDocJson {
+  import io.circe.generic.semiauto._
+  import io.circe.{Encoder, Decoder}
+
+  implicit val implementedByJsonEncoder: Encoder[ImplementedByJson] =
+    deriveEncoder[ImplementedByJson]
+  implicit val implementedByJsonDecoder: Decoder[ImplementedByJson] =
+    deriveDecoder[ImplementedByJson]
+
+  implicit val resourceDocMetaEncoder: Encoder[ResourceDocMeta] =
+    deriveEncoder[ResourceDocMeta]
+  implicit val resourceDocMetaDecoder: Decoder[ResourceDocMeta] =
+    deriveDecoder[ResourceDocMeta]
+
+  implicit val resourceDocJsonEncoder: Encoder[ResourceDocJson] =
+    deriveEncoder[ResourceDocJson].mapJson(_.dropNullValues)
+  implicit val resourceDocJsonDecoder: Decoder[ResourceDocJson] =
+    deriveDecoder[ResourceDocJson]
+
+  implicit val resourceDocsJsonEncoder: Encoder[ResourceDocsJson] =
+    deriveEncoder[ResourceDocsJson]
+  implicit val resourceDocsJsonDecoder: Decoder[ResourceDocsJson] =
+    deriveDecoder[ResourceDocsJson]
+}

src/main/scala/com/openbankproject/trading/docs/registry/ConsistencyCheck.scala

@@ -0,0 +1,10 @@
+package com.openbankproject.trading.docs.registry
+
+import com.openbankproject.trading.docs.model.ResourceDoc
+
+object ConsistencyCheck {
+  def findDuplicateImplementations(docs: Seq[ResourceDoc]): Map[String, Int] =
+    docs.groupBy(_.partialFunctionName).view.mapValues(_.size).filter(_._2 > 1).toMap
+}
+
+

src/main/scala/com/openbankproject/trading/docs/registry/ResourceDocRegistry.scala

@@ -0,0 +1,25 @@
+package com.openbankproject.trading.docs.registry
+
+import com.openbankproject.trading.docs.model.ResourceDoc
+import scala.collection.concurrent.TrieMap
+
+object ResourceDocRegistry {
+  private[this] val byPartialFunctionName: TrieMap[String, ResourceDoc] = TrieMap.empty
+
+  def register(doc: ResourceDoc): Unit = {
+    byPartialFunctionName.put(doc.partialFunctionName, doc)
+    ()
+  }
+
+  def registerAll(docs: Iterable[ResourceDoc]): Unit = docs.foreach(register)
+
+  def get(partialFunctionName: String): Option[ResourceDoc] = 
+    byPartialFunctionName.get(partialFunctionName)
+
+  def all: Vector[ResourceDoc] = 
+    byPartialFunctionName.values.toVector.sortBy(_.partialFunctionName)
+
+  def clear(): Unit = byPartialFunctionName.clear()
+}
+
+

src/main/scala/com/openbankproject/trading/http/HttpServerMain.scala

@@ -6,38 +6,46 @@ import org.http4s.server.Router
 import org.http4s.implicits._
 import org.http4s.ember.server.EmberServerBuilder
 import com.comcast.ip4s._
+import com.typesafe.config.ConfigFactory
 
 /**
   * Minimal http4s server that mounts Routes.api with placeholder services.
   * Replace the placeholder services with real implementations when ready.
   */
 object HttpServerMain extends IOApp.Simple {
 
-  private val orderServiceIO: IO[OrderService[IO]] = InMemoryOrderService.create[IO]()
+  private val orderServiceIO: IO[OrderService] = InMemoryOrderService.create()
+  private val offerServiceIO: IO[OfferService] = InMemoryOfferService.create()
 
-  private val matchService: MatchService[IO] = new MatchService[IO] {
-    def createMatch(req: MatchRequest) = IO.pure(Left(ErrorResponse("not_implemented", "createMatch not implemented")))
+  private val matchService: MatchService = new MatchService {
+    def createMatch(req: MatchRequest) = IO.pure(Left(ErrorResponse(ErrorCodes.NOT_IMPLEMENTED, "createMatch not implemented")))
   }
 
-  private val settlementService: SettlementService[IO] = new SettlementService[IO] {
-    def settle(req: SettlementRequest) = IO.pure(Left(ErrorResponse("not_implemented", "settle not implemented")))
-    def getTrade(tradeId: String) = IO.pure(Left(ErrorResponse("not_implemented", "getTrade not implemented")))
+  private val settlementService: SettlementService = new SettlementService {
+    def settle(req: SettlementRequest) = IO.pure(Left(ErrorResponse(ErrorCodes.NOT_IMPLEMENTED, "settle not implemented")))
+    def getTrade(tradeId: String) = IO.pure(Left(ErrorResponse(ErrorCodes.NOT_IMPLEMENTED, "getTrade not implemented")))
   }
 
-  private val fundsService: FundsService[IO] = new FundsService[IO] {
-    def notifyDeposit(req: DepositNotification) = IO.pure(Left(ErrorResponse("not_implemented", "notifyDeposit not implemented")))
-    def requestWithdrawal(req: WithdrawalRequest) = IO.pure(Left(ErrorResponse("not_implemented", "requestWithdrawal not implemented")))
+  private val fundsService: FundsService = new FundsService {
+    def notifyDeposit(req: DepositNotification) = IO.pure(Left(ErrorResponse(ErrorCodes.NOT_IMPLEMENTED, "notifyDeposit not implemented")))
+    def requestWithdrawal(req: WithdrawalRequest) = IO.pure(Left(ErrorResponse(ErrorCodes.NOT_IMPLEMENTED, "requestWithdrawal not implemented")))
   }
 
   override def run: IO[Unit] =
     for {
+      config <- IO(ConfigFactory.load())
+      serverHost = config.getString("server.host")
+      serverPort = config.getString("server.port").toInt
+      offerService <- offerServiceIO
       orderService <- orderServiceIO
-      apiRoutes = Routes.api[IO](orderService, matchService, settlementService, fundsService)
+      apiRoutes = Routes.api(orderService, offerService, matchService, settlementService, fundsService)
       httpApp   = Router("/" -> apiRoutes).orNotFound
+      host <- IO.fromOption(Host.fromString(serverHost))(new IllegalArgumentException(s"Invalid host: $serverHost"))
+      port <- IO.fromOption(Port.fromInt(serverPort))(new IllegalArgumentException(s"Invalid port: $serverPort"))
       _ <- EmberServerBuilder
         .default[IO]
-        .withHost(ipv4"0.0.0.0")
-        .withPort(port"8080")
+        .withHost(host)
+        .withPort(port)
         .withHttpApp(httpApp)
         .build
         .useForever