Skip to content

Commit d14afa0

Browse files
algolia-botpipeline1987millotp
committed
feat(specs): logs endpoints (#5580) (generated) [skip ci]
Co-authored-by: Felipe Bermudez <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent 5d2594b commit d14afa0

File tree

3 files changed

+683
-0
lines changed

3 files changed

+683
-0
lines changed

‎docs/bundled/crawler.json‎

Lines changed: 275 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -688,6 +688,91 @@
688688
}
689689
}
690690
},
691+
"/1/crawlers/{id}/crawl_runs": {
692+
"get": {
693+
"operationId": "listCrawlRuns",
694+
"summary": "List crawler runs",
695+
"description": "The Crawler Logs feature allows you to monitor and debug your crawler’s activity by recording\ndetailed logs for each crawl run. Logs are useful for troubleshooting crawl issues,\nverifying site coverage, and monitoring crawler performance over time.\n",
696+
"tags": [
697+
"crawlers"
698+
],
699+
"x-acl": [
700+
"settings"
701+
],
702+
"parameters": [
703+
{
704+
"$ref": "#/components/parameters/CrawlerIdParameter"
705+
},
706+
{
707+
"$ref": "#/components/parameters/From"
708+
},
709+
{
710+
"$ref": "#/components/parameters/Until"
711+
},
712+
{
713+
"$ref": "#/components/parameters/Status"
714+
},
715+
{
716+
"$ref": "#/components/parameters/Limit"
717+
},
718+
{
719+
"$ref": "#/components/parameters/Offset"
720+
},
721+
{
722+
"$ref": "#/components/parameters/Order"
723+
}
724+
],
725+
"responses": {
726+
"200": {
727+
"$ref": "#/components/responses/crawlerLogsResponse"
728+
},
729+
"400": {
730+
"$ref": "#/components/responses/InvalidRequest"
731+
},
732+
"401": {
733+
"$ref": "#/components/responses/MissingAuthorization"
734+
},
735+
"403": {
736+
"$ref": "#/components/responses/NoRightsOnCrawler"
737+
}
738+
}
739+
}
740+
},
741+
"/1/crawlers/{id}/{logId}/download": {
742+
"get": {
743+
"operationId": "getCrawlRunFile",
744+
"summary": "Crawler run file",
745+
"description": "The Crawler Logs file allows you to monitor and debug your crawler’s activity by recording\ndetailed logs for each crawl run. Logs are useful for troubleshooting crawl issues,\nverifying site coverage, and monitoring crawler performance over time.\n",
746+
"tags": [
747+
"crawlers"
748+
],
749+
"x-acl": [
750+
"settings"
751+
],
752+
"parameters": [
753+
{
754+
"$ref": "#/components/parameters/CrawlerIdParameter"
755+
},
756+
{
757+
"$ref": "#/components/parameters/CrawlerLogIdParameter"
758+
}
759+
],
760+
"responses": {
761+
"200": {
762+
"$ref": "#/components/responses/crawlerLogsResponse"
763+
},
764+
"400": {
765+
"$ref": "#/components/responses/InvalidRequest"
766+
},
767+
"401": {
768+
"$ref": "#/components/responses/MissingAuthorization"
769+
},
770+
"403": {
771+
"$ref": "#/components/responses/NoRightsOnCrawler"
772+
}
773+
}
774+
}
775+
},
691776
"/1/crawlers/{id}/config": {
692777
"patch": {
693778
"operationId": "patchConfig",
@@ -3107,6 +3192,42 @@
31073192
"readable": "Forbidden by robots.txt"
31083193
}
31093194
},
3195+
"from": {
3196+
"type": "string",
3197+
"description": "Unix string 'from' date.",
3198+
"example": 1762264044
3199+
},
3200+
"until": {
3201+
"type": "string",
3202+
"description": "Unix string 'until' date.",
3203+
"example": 1762264044
3204+
},
3205+
"limit": {
3206+
"type": "integer",
3207+
"description": "Limit of the query results.",
3208+
"minimum": 1,
3209+
"default": 10,
3210+
"maximum": 1000,
3211+
"example": 10
3212+
},
3213+
"offset": {
3214+
"type": "integer",
3215+
"description": "Offset of the query results.",
3216+
"example": 11
3217+
},
3218+
"parameters_order": {
3219+
"type": "string",
3220+
"description": "Order of the query.\n",
3221+
"enum": [
3222+
"ASC",
3223+
"DESC"
3224+
]
3225+
},
3226+
"CrawlerLogID": {
3227+
"type": "string",
3228+
"description": "Universally unique identifier (UUID) of the crawler log.",
3229+
"example": "a2ebb507-ef64-4b6b-9d84-ef66baaa7a80"
3230+
},
31103231
"version": {
31113232
"type": "integer",
31123233
"description": "Version of the configuration. Version 1 is the initial configuration you used when creating the crawler.",
@@ -3229,6 +3350,63 @@
32293350
"$ref": "#/components/schemas/CrawlerID"
32303351
}
32313352
},
3353+
"From": {
3354+
"name": "from",
3355+
"in": "query",
3356+
"description": "Date 'from' filter.",
3357+
"schema": {
3358+
"$ref": "#/components/schemas/from"
3359+
}
3360+
},
3361+
"Until": {
3362+
"name": "until",
3363+
"in": "query",
3364+
"description": "Date 'until' filter.",
3365+
"schema": {
3366+
"$ref": "#/components/schemas/until"
3367+
}
3368+
},
3369+
"Status": {
3370+
"name": "status",
3371+
"in": "query",
3372+
"description": "Status to filter 'DONE', 'SKIPPED' or 'FAILED'.",
3373+
"schema": {
3374+
"$ref": "#/components/schemas/urlsCrawledGroupStatus"
3375+
}
3376+
},
3377+
"Limit": {
3378+
"name": "limit",
3379+
"in": "query",
3380+
"description": "Limit of the query results.",
3381+
"schema": {
3382+
"$ref": "#/components/schemas/limit"
3383+
}
3384+
},
3385+
"Offset": {
3386+
"name": "offset",
3387+
"in": "query",
3388+
"description": "Offset of the query results.",
3389+
"schema": {
3390+
"$ref": "#/components/schemas/offset"
3391+
}
3392+
},
3393+
"Order": {
3394+
"name": "order",
3395+
"in": "query",
3396+
"description": "Order of the query 'ASC' or 'DESC'.",
3397+
"schema": {
3398+
"$ref": "#/components/schemas/parameters_order"
3399+
}
3400+
},
3401+
"CrawlerLogIdParameter": {
3402+
"name": "logId",
3403+
"in": "path",
3404+
"description": "Crawler log ID.",
3405+
"required": true,
3406+
"schema": {
3407+
"$ref": "#/components/schemas/CrawlerLogID"
3408+
}
3409+
},
32323410
"CrawlerVersionParameter": {
32333411
"name": "version",
32343412
"in": "path",
@@ -3333,6 +3511,103 @@
33333511
}
33343512
}
33353513
},
3514+
"crawlerLogsResponse": {
3515+
"description": "List Response of Crawler Logs.",
3516+
"content": {
3517+
"application/json": {
3518+
"schema": {
3519+
"title": "listCrawlerLogsResponse",
3520+
"type": "object",
3521+
"properties": {
3522+
"logs": {
3523+
"type": "array",
3524+
"items": {
3525+
"title": "crawlerLogItem",
3526+
"type": "object",
3527+
"properties": {
3528+
"id": {
3529+
"type": "string",
3530+
"description": "ID of the crawler log."
3531+
},
3532+
"configId": {
3533+
"type": "string",
3534+
"description": "Crawler Config identifier."
3535+
},
3536+
"reindexId": {
3537+
"type": "string",
3538+
"description": "Identifier of Reindex."
3539+
},
3540+
"fileSizeBytes": {
3541+
"type": "integer",
3542+
"description": "Size of the compressed crawler log."
3543+
},
3544+
"uncompressedSizeBytes": {
3545+
"type": "integer",
3546+
"description": "Size of the uncompressed crawler log."
3547+
},
3548+
"crawlStartedAt": {
3549+
"type": "string",
3550+
"description": "Crawl started at date."
3551+
},
3552+
"crawlCompletedAt": {
3553+
"type": "string",
3554+
"description": "Crawl started at date."
3555+
},
3556+
"fileCreatedAt": {
3557+
"type": "string",
3558+
"description": "File created date."
3559+
},
3560+
"expiresAt": {
3561+
"type": "string",
3562+
"description": "File expiration date."
3563+
},
3564+
"status": {
3565+
"type": "string",
3566+
"description": "File status."
3567+
},
3568+
"accessCount": {
3569+
"type": "integer",
3570+
"description": "File access count."
3571+
},
3572+
"lastAccessedAt": {
3573+
"type": "string",
3574+
"description": "File last accessed date.",
3575+
"nullable": true
3576+
},
3577+
"urlsDone": {
3578+
"type": "integer",
3579+
"description": "Crawler urls done."
3580+
},
3581+
"urlsSkipped": {
3582+
"type": "integer",
3583+
"description": "Crawler urls skipped."
3584+
},
3585+
"urlsFailed": {
3586+
"type": "integer",
3587+
"description": "Crawler urls failed."
3588+
}
3589+
}
3590+
}
3591+
},
3592+
"meta": {
3593+
"title": "crawlerLogsMeta",
3594+
"type": "object",
3595+
"properties": {
3596+
"total": {
3597+
"type": "integer",
3598+
"description": "Total of records found."
3599+
}
3600+
}
3601+
}
3602+
},
3603+
"required": [
3604+
"logs",
3605+
"meta"
3606+
]
3607+
}
3608+
}
3609+
}
3610+
},
33363611
"Forbidden": {
33373612
"description": "Invalid credentials.",
33383613
"content": {

0 commit comments

Comments
 (0)