fix(docs): validate and correct Firecrawl v2 OpenAPI schema

Browse Source

Based on live API testing of v2 endpoints:

✅ Validated against actual responses:
- /v2/scrape - matches schema ✓
- /v2/map - corrected response structure (direct links array with url objects)
- /v2/crawl - added missing 'url' field to response
- /v2/batch/scrape - added 'url' and 'invalidURLs' fields
- /v2/search - corrected to data.web structure with creditsUsed at root

🔧 Schema corrections:
- MapResponse: Fixed to use direct 'links' array with {url: string} objects
- CrawlResponse: Added required 'url' field for status endpoint
- BatchScrapeResponse: Added 'url' and 'invalidURLs' fields
- SearchResponse: Fixed to use data.web structure + root creditsUsed
- ScrapeMetadata: Added optional title, favicon, language fields

🚮 Removed all v1 endpoints to focus only on v2 API
🏷️ Updated title to 'Firecrawl API v2' and version to '2.0.0'

All schemas now accurately reflect actual API behavior from container 5d8e66d87762

...

This commit is contained in:

Travis Vasceannie

2025-09-19 00:45:43 +00:00

parent fa06d8ffbe

commit 37d1e434af

1 changed files with 439 additions and 480 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

919

firecrawl.json

File diff suppressed because it is too large Load Diff