@@ -65509,6 +65509,149 @@ components:
6550965509 type: string
6551065510 x-enum-varnames:
6551165511 - SUITES
65512+ SyntheticsTestFileAbortMultipartUploadRequest:
65513+ description: Request body for aborting a multipart file upload.
65514+ properties:
65515+ key:
65516+ description: The full storage path of the file whose upload should be aborted.
65517+ example: "org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json"
65518+ type: string
65519+ uploadId:
65520+ description: The upload ID of the multipart upload to abort.
65521+ example: "upload-id-abc123"
65522+ type: string
65523+ required:
65524+ - uploadId
65525+ - key
65526+ type: object
65527+ SyntheticsTestFileCompleteMultipartUploadPart:
65528+ description: A completed part of a multipart upload.
65529+ properties:
65530+ ETag:
65531+ description: The ETag returned by the storage provider after uploading the part.
65532+ example: '"d41d8cd98f00b204e9800998ecf8427e"'
65533+ type: string
65534+ PartNumber:
65535+ description: The 1-indexed part number for the multipart upload.
65536+ example: 1
65537+ format: int64
65538+ type: integer
65539+ required:
65540+ - ETag
65541+ - PartNumber
65542+ type: object
65543+ SyntheticsTestFileCompleteMultipartUploadRequest:
65544+ description: Request body for completing a multipart file upload.
65545+ properties:
65546+ key:
65547+ description: The full storage path for the uploaded file.
65548+ example: "org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json"
65549+ type: string
65550+ parts:
65551+ description: Array of completed parts with their ETags.
65552+ items:
65553+ $ref: "#/components/schemas/SyntheticsTestFileCompleteMultipartUploadPart"
65554+ type: array
65555+ uploadId:
65556+ description: The upload ID returned when the multipart upload was initiated.
65557+ example: "upload-id-abc123"
65558+ type: string
65559+ required:
65560+ - uploadId
65561+ - key
65562+ - parts
65563+ type: object
65564+ SyntheticsTestFileDownloadRequest:
65565+ description: Request body for getting a presigned download URL for a test file.
65566+ properties:
65567+ bucketKey:
65568+ description: The bucket key referencing the file to download.
65569+ example: "api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json"
65570+ minLength: 1
65571+ type: string
65572+ required:
65573+ - bucketKey
65574+ type: object
65575+ SyntheticsTestFileDownloadResponse:
65576+ description: Response containing a presigned URL for downloading a test file.
65577+ properties:
65578+ url:
65579+ description: A presigned URL to download the file. The URL expires after a short period.
65580+ example: "https://storage.example.com/presigned-download-url"
65581+ type: string
65582+ type: object
65583+ SyntheticsTestFileMultipartPresignedUrlsParams:
65584+ description: Presigned URL parameters returned for a multipart upload.
65585+ properties:
65586+ key:
65587+ description: The full storage path for the file being uploaded.
65588+ example: "org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json"
65589+ type: string
65590+ upload_id:
65591+ description: The upload ID assigned by the storage provider for this multipart upload.
65592+ example: "upload-id-abc123"
65593+ type: string
65594+ urls:
65595+ additionalProperties:
65596+ type: string
65597+ description: A map of part numbers to presigned upload URLs.
65598+ example:
65599+ "1": "https://storage.example.com/presigned-upload-url-part-1"
65600+ "2": "https://storage.example.com/presigned-upload-url-part-2"
65601+ type: object
65602+ type: object
65603+ SyntheticsTestFileMultipartPresignedUrlsPart:
65604+ description: A part descriptor for initiating a multipart upload.
65605+ properties:
65606+ md5:
65607+ description: Base64-encoded MD5 digest of the part content.
65608+ example: "1B2M2Y8AsgTpgAmY7PhCfg=="
65609+ maxLength: 24
65610+ minLength: 22
65611+ type: string
65612+ partNumber:
65613+ description: The 1-indexed part number for the multipart upload.
65614+ example: 1
65615+ format: int64
65616+ type: integer
65617+ required:
65618+ - md5
65619+ - partNumber
65620+ type: object
65621+ SyntheticsTestFileMultipartPresignedUrlsRequest:
65622+ description: Request body for getting presigned URLs for a multipart file upload.
65623+ properties:
65624+ bucketKeyPrefix:
65625+ $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsRequestBucketKeyPrefix"
65626+ parts:
65627+ description: Array of part descriptors for the multipart upload.
65628+ items:
65629+ $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsPart"
65630+ type: array
65631+ required:
65632+ - bucketKeyPrefix
65633+ - parts
65634+ type: object
65635+ SyntheticsTestFileMultipartPresignedUrlsRequestBucketKeyPrefix:
65636+ description: The bucket key prefix indicating the type of file upload.
65637+ enum:
65638+ - api-upload-file
65639+ - browser-upload-file-step
65640+ example: "api-upload-file"
65641+ type: string
65642+ x-enum-varnames:
65643+ - API_UPLOAD_FILE
65644+ - BROWSER_UPLOAD_FILE_STEP
65645+ SyntheticsTestFileMultipartPresignedUrlsResponse:
65646+ description: Response containing presigned URLs for multipart file upload and the bucket key.
65647+ properties:
65648+ bucketKey:
65649+ description: The bucket key that references the uploaded file after completion.
65650+ example: "api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json"
65651+ type: string
65652+ multipart_presigned_urls_params:
65653+ $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsParams"
65654+ type: object
6551265655 SyntheticsTestOptions:
6551365656 description: Object describing the extra options for a Synthetic test.
6551465657 properties:
@@ -107394,6 +107537,237 @@ paths:
107394107537 permissions:
107395107538 - synthetics_write
107396107539 - synthetics_create_edit_trigger
107540+ /api/v2/synthetics/tests/{public_id}/files/download:
107541+ post:
107542+ description: |-
107543+ Get a presigned URL to download a file attached to a Synthetic test.
107544+ The returned URL is temporary and expires after a short period.
107545+ operationId: GetTestFileDownloadUrl
107546+ parameters:
107547+ - description: The public ID of the Synthetic test.
107548+ in: path
107549+ name: public_id
107550+ required: true
107551+ schema:
107552+ example: abc-def-123
107553+ type: string
107554+ requestBody:
107555+ content:
107556+ application/json:
107557+ schema:
107558+ $ref: "#/components/schemas/SyntheticsTestFileDownloadRequest"
107559+ required: true
107560+ responses:
107561+ "200":
107562+ content:
107563+ application/json:
107564+ schema:
107565+ $ref: "#/components/schemas/SyntheticsTestFileDownloadResponse"
107566+ description: OK
107567+ "400":
107568+ content:
107569+ application/json:
107570+ schema:
107571+ $ref: "#/components/schemas/APIErrorResponse"
107572+ description: API error response.
107573+ "403":
107574+ content:
107575+ application/json:
107576+ schema:
107577+ $ref: "#/components/schemas/APIErrorResponse"
107578+ description: Forbidden.
107579+ "404":
107580+ content:
107581+ application/json:
107582+ schema:
107583+ $ref: "#/components/schemas/APIErrorResponse"
107584+ description: API error response.
107585+ "429":
107586+ $ref: "#/components/responses/TooManyRequestsResponse"
107587+ security:
107588+ - apiKeyAuth: []
107589+ appKeyAuth: []
107590+ - AuthZ:
107591+ - synthetics_read
107592+ summary: Get a presigned URL for downloading a test file
107593+ tags:
107594+ - Synthetics
107595+ x-permission:
107596+ operator: OR
107597+ permissions:
107598+ - synthetics_read
107599+ /api/v2/synthetics/tests/{public_id}/files/multipart-presigned-urls:
107600+ post:
107601+ description: |-
107602+ Get presigned URLs for uploading a file to a Synthetic test using multipart upload.
107603+ Returns the presigned URLs for each part along with the bucket key that references the file.
107604+ operationId: GetTestFileMultipartPresignedUrls
107605+ parameters:
107606+ - description: The public ID of the Synthetic test.
107607+ in: path
107608+ name: public_id
107609+ required: true
107610+ schema:
107611+ example: abc-def-123
107612+ type: string
107613+ requestBody:
107614+ content:
107615+ application/json:
107616+ schema:
107617+ $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsRequest"
107618+ required: true
107619+ responses:
107620+ "200":
107621+ content:
107622+ application/json:
107623+ schema:
107624+ $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsResponse"
107625+ description: OK
107626+ "400":
107627+ content:
107628+ application/json:
107629+ schema:
107630+ $ref: "#/components/schemas/APIErrorResponse"
107631+ description: API error response.
107632+ "403":
107633+ content:
107634+ application/json:
107635+ schema:
107636+ $ref: "#/components/schemas/APIErrorResponse"
107637+ description: Forbidden.
107638+ "404":
107639+ content:
107640+ application/json:
107641+ schema:
107642+ $ref: "#/components/schemas/APIErrorResponse"
107643+ description: API error response.
107644+ "429":
107645+ $ref: "#/components/responses/TooManyRequestsResponse"
107646+ security:
107647+ - apiKeyAuth: []
107648+ appKeyAuth: []
107649+ - AuthZ:
107650+ - synthetics_write
107651+ summary: Get presigned URLs for uploading a test file
107652+ tags:
107653+ - Synthetics
107654+ x-permission:
107655+ operator: OR
107656+ permissions:
107657+ - synthetics_write
107658+ - synthetics_create_edit_trigger
107659+ /api/v2/synthetics/tests/{public_id}/files/multipart-upload-abort:
107660+ post:
107661+ description: |-
107662+ Abort an in-progress multipart file upload for a Synthetic test. This cancels the upload
107663+ and releases any storage used by already-uploaded parts.
107664+ operationId: AbortTestFileMultipartUpload
107665+ parameters:
107666+ - description: The public ID of the Synthetic test.
107667+ in: path
107668+ name: public_id
107669+ required: true
107670+ schema:
107671+ example: abc-def-123
107672+ type: string
107673+ requestBody:
107674+ content:
107675+ application/json:
107676+ schema:
107677+ $ref: "#/components/schemas/SyntheticsTestFileAbortMultipartUploadRequest"
107678+ required: true
107679+ responses:
107680+ "204":
107681+ description: No Content
107682+ "400":
107683+ content:
107684+ application/json:
107685+ schema:
107686+ $ref: "#/components/schemas/APIErrorResponse"
107687+ description: API error response.
107688+ "403":
107689+ content:
107690+ application/json:
107691+ schema:
107692+ $ref: "#/components/schemas/APIErrorResponse"
107693+ description: Forbidden.
107694+ "404":
107695+ content:
107696+ application/json:
107697+ schema:
107698+ $ref: "#/components/schemas/APIErrorResponse"
107699+ description: API error response.
107700+ "429":
107701+ $ref: "#/components/responses/TooManyRequestsResponse"
107702+ security:
107703+ - apiKeyAuth: []
107704+ appKeyAuth: []
107705+ - AuthZ:
107706+ - synthetics_write
107707+ summary: Abort a multipart upload of a test file
107708+ tags:
107709+ - Synthetics
107710+ x-permission:
107711+ operator: OR
107712+ permissions:
107713+ - synthetics_write
107714+ - synthetics_create_edit_trigger
107715+ /api/v2/synthetics/tests/{public_id}/files/multipart-upload-complete:
107716+ post:
107717+ description: |-
107718+ Complete a multipart file upload for a Synthetic test. Call this endpoint after all parts
107719+ have been uploaded using the presigned URLs obtained from the multipart presigned URLs endpoint.
107720+ operationId: CompleteTestFileMultipartUpload
107721+ parameters:
107722+ - description: The public ID of the Synthetic test.
107723+ in: path
107724+ name: public_id
107725+ required: true
107726+ schema:
107727+ example: abc-def-123
107728+ type: string
107729+ requestBody:
107730+ content:
107731+ application/json:
107732+ schema:
107733+ $ref: "#/components/schemas/SyntheticsTestFileCompleteMultipartUploadRequest"
107734+ required: true
107735+ responses:
107736+ "204":
107737+ description: No Content
107738+ "400":
107739+ content:
107740+ application/json:
107741+ schema:
107742+ $ref: "#/components/schemas/APIErrorResponse"
107743+ description: API error response.
107744+ "403":
107745+ content:
107746+ application/json:
107747+ schema:
107748+ $ref: "#/components/schemas/APIErrorResponse"
107749+ description: Forbidden.
107750+ "404":
107751+ content:
107752+ application/json:
107753+ schema:
107754+ $ref: "#/components/schemas/APIErrorResponse"
107755+ description: API error response.
107756+ "429":
107757+ $ref: "#/components/responses/TooManyRequestsResponse"
107758+ security:
107759+ - apiKeyAuth: []
107760+ appKeyAuth: []
107761+ - AuthZ:
107762+ - synthetics_write
107763+ summary: Complete a multipart upload of a test file
107764+ tags:
107765+ - Synthetics
107766+ x-permission:
107767+ operator: OR
107768+ permissions:
107769+ - synthetics_write
107770+ - synthetics_create_edit_trigger
107397107771 /api/v2/synthetics/tests/{public_id}/parent-suites:
107398107772 get:
107399107773 description: Get the list of parent suites and their status for a given Synthetic test.
0 commit comments