AI/firecrawl
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/mendableai/firecrawl synced 2025-04-23 06:29:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update cancel crawl response

Browse Source 
- add cancel crawl event to requests.http
This commit is contained in:
Ademílson Tonato 2025-01-24 16:16:04 +00:00
parent 720a429115
commit 34e3911a97
No known key found for this signature in database
GPG Key ID: 169C7BE271C9FA3A
2 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
apps/api/requests.http
View File

@ -28,6 +28,11 @@ content-type: application/json
GET {{baseUrl}}/v1/crawl/{{crawlId}} HTTP/1.1 GET {{baseUrl}}/v1/crawl/{{crawlId}} HTTP/1.1
Authorization: Bearer {{$dotenv TEST_API_KEY}} Authorization: Bearer {{$dotenv TEST_API_KEY}}
### Cancel Crawl
@crawlId = {{crawl.response.body.$.id}}
# @name cancelCrawl
DELETE {{baseUrl}}/v1/crawl/{{crawlId}} HTTP/1.1
Authorization: Bearer {{$dotenv TEST_API_KEY}}
### Batch Scrape Websites ### Batch Scrape Websites
# @name batchScrape # @name batchScrape

22
apps/api/v1-openapi.json
View File

@ -840,19 +840,16 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "Successful cancellation", "description": "Crawl job successfully cancelled",
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"type": "object", "type": "object",
"properties": { "properties": {
"success": { "status": {
"type": "boolean",
"example": true
},
"message": {
"type": "string", "type": "string",
"example": "Crawl job successfully cancelled." "enum": ["cancelled"],
"example": "cancelled"
} }
} }
} }
@ -988,19 +985,16 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "Successful cancellation", "description": "Crawl job successfully cancelled",
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"type": "object", "type": "object",
"properties": { "properties": {
"success": { "status": {
"type": "boolean",
"example": true
},
"message": {
"type": "string", "type": "string",
"example": "Crawl job successfully cancelled." "enum": ["cancelled"],
"example": "cancelled"
} }
} }
} }