From bcce0544e78285d5615528c031be8fb24c0017bf Mon Sep 17 00:00:00 2001
From: Nicolas <nicolascamara29@gmail.com>
Date: Thu, 16 May 2024 11:03:32 -0700
Subject: [PATCH] Update openapi.json

---
 apps/api/openapi.json | 41 ++++++++++++++++++++++++++++++++++++++---
 1 file changed, 38 insertions(+), 3 deletions(-)

diff --git a/apps/api/openapi.json b/apps/api/openapi.json
index b0f8b99..98acbbb 100644
--- a/apps/api/openapi.json
+++ b/apps/api/openapi.json
@@ -242,7 +242,7 @@
                   "query": {
                     "type": "string",
                     "format": "uri",
-                    "description": "The URL to scrape"
+                    "description": "The query to search for"
                   },
                   "pageOptions": {
                     "type": "object",
@@ -354,14 +354,14 @@
                     "data": {
                       "type": "array",
                       "items": {
-                        "$ref": "#/components/schemas/ScrapeResponse"
+                        "$ref": "#/components/schemas/CrawlStatusResponseObj"
                       },
                       "description": "Data returned from the job (null when it is in progress)"
                     },
                     "partial_data": {
                       "type": "array",
                       "items": {
-                        "$ref": "#/components/schemas/ScrapeResponse"
+                        "$ref": "#/components/schemas/CrawlStatusResponseObj"
                       },
                       "description": "Partial documents returned as it is being crawls (streaming). When a page is ready it will append to the parial_data array - so no need to wait for all the website to be crawled."
                     }
@@ -484,6 +484,41 @@
           }
         }
       },
+      "CrawlStatusResponseObj": {
+        "type": "object",
+        "properties": {
+          "markdown": {
+            "type": "string"
+          },
+          "content": {
+            "type": "string"
+          },
+          "html": {
+            "type": "string",
+            "nullable": true,
+            "description": "Raw HTML content of the page if `includeHtml`  is true"
+          },
+          "metadata": {
+            "type": "object",
+            "properties": {
+              "title": {
+                "type": "string"
+              },
+              "description": {
+                "type": "string"
+              },
+              "language": {
+                "type": "string",
+                "nullable": true
+              },
+              "sourceURL": {
+                "type": "string",
+                "format": "uri"
+              }
+            }
+          }
+        }
+      },
       "SearchResponse": {
         "type": "object",
         "properties": {