@rivascva/dt-idl 1.0.7

package/services/dt-trade-service.yaml

@@ -0,0 +1,388 @@
+openapi: 3.0.0
+
+info:
+  version: 1.0.0
+  title: Dream Trade Trade Service
+  description: Make trades on the stock market.
+
+servers:
+  - url: http://localhost:8081/v1
+
+paths:
+  /users:
+    get:
+      description: Gets all users
+      operationId: getUsers
+      tags:
+        - Users
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/User"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+    post:
+      description: Adds a new user
+      operationId: addUser
+      tags:
+        - Users
+      requestBody:
+        description: The request body to add a user
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UserPayload"
+      responses:
+        201:
+          description: Added
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/User"
+        400:
+          $ref: "#/components/responses/BadRequest"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+  /users/{userId}:
+    get:
+      description: Gets a user
+      operationId: getUser
+      tags:
+        - Users
+      parameters:
+        - in: path
+          name: userId
+          description: The user id
+          required: true
+          schema:
+            type: string
+            example: 123456
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: object
+                $ref: "#/components/schemas/User"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+    put:
+      description: Updates an existing user
+      operationId: updateUser
+      tags:
+        - Users
+      parameters:
+        - in: path
+          name: userId
+          description: The user id
+          required: true
+          schema:
+            type: string
+            example: 123456
+      requestBody:
+        description: The request body to updated a user
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UserPayload"
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/User"
+        400:
+          $ref: "#/components/responses/BadRequest"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+  /users/{userId}/portfolios:
+    get:
+      description: Gets all portfolios of a user
+      operationId: getUserPortfolios
+      tags:
+        - Users
+      parameters:
+        - in: path
+          name: userId
+          description: The user id
+          required: true
+          schema:
+            type: string
+            example: 123456
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Portfolio"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+  
+  /orders:
+    post:
+      description: Add a new order
+      operationId: addOrder
+      tags:
+        - Orders
+      requestBody:
+        description: The request body to add an order
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/OrderPayload"
+      responses:
+        201:
+          description: Added
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Order"
+        400:
+          $ref: "#/components/responses/BadRequest"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+components:
+  schemas:
+    UserPayload:
+      description: A user payload
+      properties:
+        email:
+          type: string
+          example: sam.smith@example.com
+        name:
+          type: string
+          example: Sam Smith
+      required:
+        - email
+        - name
+
+    User:
+      description: A user
+      allOf:
+        - $ref: "#/components/schemas/UserPayload"
+        - type: object
+          properties:
+            id:
+              type: string
+              example: 123456
+            dateCreated:
+              type: integer
+              format: int64
+              example: 1713398544000
+            dateUpdated:
+              type: integer
+              format: int64
+              example: 1713398544000
+          required:
+            - id
+            - dateCreated
+            - dateUpdated
+    
+    Portfolio:
+      description: A trading portfolio
+      properties:
+        id:
+          type: string
+          example: 123456
+        userId:
+          type: string
+          example: 123456
+        type:
+          $ref: "#/components/schemas/PortfolioType"
+          example: PERSONAL
+        cash:
+          type: number
+          format: double
+          example: 10500.25
+        holdings:
+          type: array
+          items:
+            $ref: "#/components/schemas/Holding"
+        dateCreated:
+          type: integer
+          format: int64
+          example: 1713398544000
+        dateUpdated:
+          type: integer
+          format: int64
+          example: 1713398544000
+      required:
+        - id
+        - userId
+        - type
+        - cash
+        - holdings
+        - dateCreated
+        - dateUpdated
+    
+    Holding:
+      description: An active stock holding
+      properties:
+        id:
+          type: string
+          example: 123456
+        symbol:
+          type: string
+          example: AAPL
+        averagePrice:
+          type: number
+          format: double
+          example: 182.25
+        quantity:
+          type: integer
+          format: int64
+          example: 10
+        dateCreated:
+          type: integer
+          format: int64
+          example: 1713398544000
+        dateUpdated:
+          type: integer
+          format: int64
+          example: 1713398544000
+      required:
+        - id
+        - symbol
+        - averagePrice
+        - quantity
+        - dateCreated
+        - dateUpdated
+    
+    OrderPayload:
+      description: A trade order payload
+      properties:
+        portfolioId:
+          type: string
+          example: 123456
+        type:
+          $ref: "#/components/schemas/OrderType"
+          example: BUY
+        symbol:
+          type: string
+          example: AAPL
+        targetPrice:
+          type: number
+          format: double
+          example: 182.25
+        quantity:
+          type: integer
+          format: int64
+          example: 10
+      required:
+        - portfolioId
+        - type
+        - symbol
+        - targetPrice
+        - quantity
+    
+    Order:
+      description: A trade order
+      allOf:
+        - $ref: "#/components/schemas/OrderPayload"
+        - type: object
+          properties:
+            id:
+              type: string
+              example: 123456
+            actualPrice:
+              type: number
+              format: double
+              example: 182.25
+            dateCreated:
+              type: integer
+              format: int64
+              example: 1713398544000
+          required:
+            - id
+            - actualPrice
+            - dateCreated
+
+    Error:
+      description: A generic error
+      properties:
+        status:
+          type: integer
+          format: int64
+          example: 500
+        code:
+          $ref: "#/components/schemas/ErrorCode"
+          example: ERROR
+        message:
+          type: string
+          example: Error
+      required:
+        - status
+        - code
+        - message
+
+    ErrorCode:
+      type: string
+      enum:
+        - ERROR
+        - NOT_ENOUGH_CASH
+        - NOT_ENOUGH_SHARES
+        - REQS_NOT_MET
+
+    PortfolioType:
+      type: string
+      enum:
+        - PERSONAL
+        - COMPETITIVE
+    
+    OrderType:
+      type: string
+      enum:
+        - BUY_MARKET
+        - BUY_LIMIT
+        - BUY_STOP
+        - SELL_MARKET
+        - SELL_LIMIT
+        - SELL_STOP
+
+  responses:
+    NotFound:
+      description: The resource was not found
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/Error"
+
+    BadRequest:
+      description: Invalid request payload
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/Error"
+
+    InternalServerError:
+      description: There was an internal server error
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/Error"

package/ts/clients/clients.ts

@@ -0,0 +1,10 @@
+import createClient, { ClientOptions } from 'openapi-fetch';
+
+import { paths as MarketServicePaths } from '@ts/services/dt-market-service';
+import { paths as TradeServicePaths } from '@ts/services/dt-trade-service';
+
+export const createMarketServiceClient = (options: ClientOptions) =>
+  createClient<MarketServicePaths>(options);
+
+export const createTradeServiceClient = (options: ClientOptions) =>
+  createClient<TradeServicePaths>(options);

package/ts/clients/index.ts

@@ -0,0 +1 @@
+export * from './clients';

package/ts/index.ts

@@ -0,0 +1,2 @@
+export * from './clients';
+export * from './types';