@rivascva/dt-idl 1.0.7

package/services/dt-market-service.yaml

@@ -0,0 +1,474 @@
+openapi: 3.0.0
+
+info:
+  version: 1.0.0
+  title: Dream Trade Market Service
+  description: Fetch real-time data on the stock market.
+
+servers:
+  - url: http://localhost:8080/v1
+
+paths:
+  /stocks/{symbol}:
+    get:
+      description: Gets the full quote for the given stock symbol
+      operationId: getStock
+      tags:
+        - Stocks
+      parameters:
+        - in: path
+          name: symbol
+          description: The stock symbol
+          required: true
+          schema:
+            type: string
+            example: AAPL
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: object
+                $ref: "#/components/schemas/FullQuote"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+  /stocks/{symbol}/history:
+    get:
+      description: Gets the price history chart for the given stock symbol
+      operationId: getStockHistory
+      tags:
+        - Stocks
+      parameters:
+        - in: path
+          name: symbol
+          description: The stock symbol
+          required: true
+          schema:
+            type: string
+            example: AAPL
+        - in: query
+          name: timeframe
+          description: The stock history timeframe
+          required: true
+          schema:
+            $ref: "#/components/schemas/HistoryTimeframe"
+            example: MIN5
+        - in: query
+          name: from
+          description: The stock history from date
+          required: true
+          schema:
+            type: string
+            example: 2024-12-24
+        - in: query
+          name: to
+          description: The stock history to date
+          required: true
+          schema:
+            type: string
+            example: 2024-12-31
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/HistoryChartEntry"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+  /stocks/by-symbols/{symbols}:
+    get:
+      description: Gets the simple quotes for the given stock symbols
+      operationId: getStocksBySymbols
+      tags:
+        - Stocks
+      parameters:
+        - in: path
+          name: symbols
+          description: The stock symbols
+          required: true
+          schema:
+            type: string
+            example: AAPL,MSFT,AMZN
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/SimpleQuote"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+  /stocks/by-exchange/{exchange}:
+    get:
+      description: Gets the simple quotes for the given stock exchange
+      operationId: getStocksByExchange
+      tags:
+        - Stocks
+      parameters:
+        - in: path
+          name: exchange
+          description: The stock exchange
+          required: true
+          schema:
+            type: string
+            example: NYSE
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/SimpleQuote"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+  /stocks/search:
+    get:
+      description: Gets the simple quotes that fuzzy match the search query
+      operationId: searchStocks
+      tags:
+        - Stocks
+      parameters:
+        - in: query
+          name: query
+          description: The search query
+          required: true
+          schema:
+            type: string
+            example: Micro
+        - in: query
+          name: limit
+          description: The maximum number of search results
+          required: false
+          schema:
+            type: integer
+            format: int64
+            example: 10
+            default: 10
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/SimpleQuote"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+  /news:
+    get:
+      description: Gets the latest news articles
+      operationId: getNews
+      tags:
+        - News
+      parameters:
+        - in: query
+          name: limit
+          description: The maximum number of articles
+          required: false
+          schema:
+            type: integer
+            format: int64
+            example: 10
+            default: 10
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/NewsArticle"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+  /news/by-symbols/{symbols}:
+    get:
+      description: Gets the latest stock news articles for the given stock symbols
+      operationId: getNewsBySymbols
+      tags:
+        - News
+      parameters:
+        - in: path
+          name: symbols
+          description: The stock symbols
+          required: true
+          schema:
+            type: string
+            example: AAPL,MSFT,AMZN
+        - in: query
+          name: limit
+          description: The maximum number of articles
+          required: false
+          schema:
+            type: integer
+            format: int64
+            example: 10
+            default: 10
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/StockNewsArticle"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+components:
+  schemas:
+    SimpleQuote:
+      description: A simple stock quote
+      properties:
+        symbol:
+          type: string
+          example: AAPL
+        name:
+          type: string
+          example: Apple Inc
+        price:
+          type: number
+          format: double
+          example: 182.25
+        percentChange:
+          type: number
+          format: double
+          example: 1.25
+      required:
+        - symbol
+        - name
+        - price
+        - percentChange
+
+    FullQuote:
+      description: A full stock quote
+      allOf:
+        - $ref: "#/components/schemas/SimpleQuote"
+        - properties:
+            previousClose:
+              type: number
+              format: double
+              example: 180.75
+            open:
+              type: number
+              format: double
+              example: 180.75
+            dayLow:
+              type: number
+              format: double
+              example: 178.25
+            dayHigh:
+              type: number
+              format: double
+              example: 185.75
+            weekLow52:
+              type: number
+              format: double
+              example: 165.25
+            weekHigh52:
+              type: number
+              format: double
+              example: 192.75
+            volume:
+              type: integer
+              format: int64
+              example: 164000000
+            averageVolume:
+              type: integer
+              format: int64
+              example: 62000000
+            marketCap:
+              type: integer
+              format: int64
+              example: 28000000000
+            pe:
+              type: number
+              format: double
+              example: 28.25
+            eps:
+              type: number
+              format: double
+              example: 6.75
+            description:
+              type: string
+              example: Apple designs and manufactures smartphones.
+            ceo:
+              type: string
+              example: Timothy Cook
+            sector:
+              type: string
+              example: Technology
+            industry:
+              type: string
+              example: Consumer Electronics
+            city:
+              type: string
+              example: Cupertino
+            state:
+              type: string
+              example: California
+            country:
+              type: string
+              example: USA
+          required:
+            - previousClose
+            - open
+            - dayLow
+            - dayHigh
+            - weekLow52
+            - weekHigh52
+            - volume
+            - averageVolume
+            - marketCap
+            - pe
+            - eps
+            - description
+            - ceo
+            - sector
+            - industry
+            - city
+            - state
+            - country
+
+    HistoryChartEntry:
+      description: A stock history chart entry
+      properties:
+        date:
+          type: string
+          example: 2024-12-24T02:30:00Z
+        open:
+          type: number
+          format: double
+          example: 175.25
+        low:
+          type: number
+          format: double
+          example: 172.75
+        high:
+          type: number
+          format: double
+          example: 185.25
+        close:
+          type: number
+          format: double
+          example: 180.75
+      required:
+        - date
+        - open
+        - low
+        - high
+        - close
+
+    NewsArticle:
+      description: A news article
+      properties:
+        title:
+          type: string
+          example: Apple Watches Recalled
+        description:
+          type: string
+          example: Apple Watches are being recalled worldwide
+        date:
+          type: integer
+          format: int64
+          example: 1709500000000
+        link:
+          type: string
+          example: https://news.com/articles/abc
+        thumbnail:
+          type: string
+          example: https://news.com/articles/abc/image.png
+      required:
+        - title
+        - description
+        - date
+        - link
+        - thumbnail
+
+    StockNewsArticle:
+      description: A stock news article
+      allOf:
+        - $ref: "#/components/schemas/NewsArticle"
+        - type: object
+          properties:
+            symbol:
+              type: string
+              example: AAPL
+          required:
+            - symbol
+
+    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
+
+    HistoryTimeframe:
+      type: string
+      enum:
+        - MIN5
+        - MIN15
+        - MIN30
+        - HOUR1
+        - HOUR4
+        - DAY1
+
+  responses:
+    NotFound:
+      description: The resource was not found
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/Error"
+
+    InternalServerError:
+      description: There was an internal server error
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/Error"