From 2d245a35f2131cb2f00b759b92adb75d306a4447 Mon Sep 17 00:00:00 2001 From: Eric Ciarla Date: Fri, 6 Sep 2024 15:27:58 -0400 Subject: [PATCH] Delete combined_api_spec.json --- .../combined_api_spec.json | 510 ------------------ 1 file changed, 510 deletions(-) delete mode 100644 examples/turning_docs_into_api_specs/combined_api_spec.json diff --git a/examples/turning_docs_into_api_specs/combined_api_spec.json b/examples/turning_docs_into_api_specs/combined_api_spec.json deleted file mode 100644 index 526dec8b..00000000 --- a/examples/turning_docs_into_api_specs/combined_api_spec.json +++ /dev/null @@ -1,510 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "https://docs.firecrawl.dev/api-reference API Specification", - "version": "1.0.0" - }, - "paths": { - "/crawl": { - "post": { - "summary": "Crawl a website", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "Base URL to crawl" - }, - "excludePaths": { - "type": "array", - "items": { - "type": "string" - }, - "description": "URL patterns to exclude" - }, - "includePaths": { - "type": "array", - "items": { - "type": "string" - }, - "description": "URL patterns to include" - }, - "maxDepth": { - "type": "integer", - "description": "Maximum crawl depth" - }, - "ignoreSitemap": { - "type": "boolean", - "description": "Ignore sitemap?" - }, - "limit": { - "type": "integer", - "description": "Maximum pages to crawl" - }, - "allowBackwardLinks": { - "type": "boolean", - "description": "Allow backward links?" - }, - "allowExternalLinks": { - "type": "boolean", - "description": "Allow external links?" - }, - "webhook": { - "type": "string", - "description": "Webhook URL" - }, - "scrapeOptions": { - "type": "object", - "properties": { - "formats": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Formats to include" - }, - "headers": { - "type": "object", - "description": "Headers to send" - }, - "includeTags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Tags to include" - }, - "excludeTags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Tags to exclude" - }, - "onlyMainContent": { - "type": "boolean", - "description": "Only main content?" - }, - "waitFor": { - "type": "integer", - "description": "Wait time in ms" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Crawl started", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "id": { - "type": "string" - }, - "url": { - "type": "string" - } - } - } - } - } - } - }, - "security": [ - { - "Authorization": [] - } - ] - } - }, - "/scrape": { - "post": { - "summary": "Scrape a webpage", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "URL to scrape" - }, - "formats": { - "type": "array", - "description": "Output formats", - "items": { - "type": "string", - "enum": [ - "markdown", - "html", - "rawHtml", - "links", - "screenshot", - "extract", - "screenshot@fullPage" - ] - } - }, - "onlyMainContent": { - "type": "boolean", - "description": "Only main content" - }, - "includeTags": { - "type": "array", - "description": "Tags to include", - "items": { - "type": "string" - } - }, - "excludeTags": { - "type": "array", - "description": "Tags to exclude", - "items": { - "type": "string" - } - }, - "headers": { - "type": "object", - "description": "Request headers" - }, - "waitFor": { - "type": "integer", - "description": "Delay in ms" - }, - "timeout": { - "type": "integer", - "description": "Timeout in ms" - }, - "extract": { - "type": "object", - "description": "Extract object", - "properties": { - "schema": { - "type": "object", - "description": "Extraction schema" - }, - "systemPrompt": { - "type": "string", - "description": "System prompt" - }, - "prompt": { - "type": "string", - "description": "Extraction prompt" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Successful scrape", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "data": { - "type": "object", - "properties": { - "markdown": { - "type": "string" - }, - "html": { - "type": "string" - }, - "rawHtml": { - "type": "string" - }, - "screenshot": { - "type": "string" - }, - "links": { - "type": "array", - "items": { - "type": "string" - } - }, - "metadata": { - "type": "object", - "properties": { - "title": { - "type": "string" - }, - "description": { - "type": "string" - }, - "language": { - "type": "string" - }, - "sourceURL": { - "type": "string" - }, - "statusCode": { - "type": "integer" - }, - "error": { - "type": "string" - } - } - }, - "llm_extraction": { - "type": "object" - }, - "warning": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "security": [ - { - "Bearer": [] - } - ] - } - }, - "/v1/crawl/{id}": { - "get": { - "summary": "Get crawl status", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ID of crawl job", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Crawl status", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Current status of crawl" - }, - "total": { - "type": "integer", - "description": "Total pages crawled" - }, - "completed": { - "type": "integer", - "description": "Number of pages crawled" - }, - "creditsUsed": { - "type": "integer", - "description": "Credits used" - }, - "expiresAt": { - "type": "string", - "format": "date-time", - "description": "Crawl expiry" - }, - "next": { - "type": "string", - "nullable": true, - "description": "URL for next data" - }, - "data": { - "type": "array", - "description": "Data of the crawl", - "items": { - "type": "object", - "properties": { - "markdown": { - "type": "string" - }, - "html": { - "type": "string" - }, - "rawHtml": { - "type": "string" - }, - "links": { - "type": "array", - "items": { - "type": "string" - } - }, - "screenshot": { - "type": "string" - }, - "metadata": { - "type": "object", - "properties": { - "title": { - "type": "string" - }, - "description": { - "type": "string" - }, - "language": { - "type": "string" - }, - "sourceURL": { - "type": "string" - }, - "statusCode": { - "type": "integer" - }, - "error": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - } - }, - "security": [ - { - "Bearer": [] - } - ] - } - }, - "/crawl/{id}": { - "delete": { - "summary": "Cancel crawl job", - "security": [ - { - "bearerAuth": [] - } - ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ID of crawl job", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Crawl job cancelled", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "message": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "/map": { - "post": { - "summary": "Map website and return links", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "Base URL to crawl" - }, - "search": { - "type": "string", - "description": "Search query for mapping" - }, - "ignoreSitemap": { - "type": "boolean", - "description": "Ignore sitemap?" - }, - "includeSubdomains": { - "type": "boolean", - "description": "Include subdomains?" - }, - "limit": { - "type": "integer", - "description": "Max links to return" - } - }, - "required": [ - "url" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Successful mapping", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "links": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - }, - "components": { - "schemas": {} - } -} \ No newline at end of file