{"openapi":"3.1.0","info":{"title":"Cloud Storage XML API","version":"main-0ea2594","description":"CloudBurrow’s built-in Storage server serves this XML subset on the same local endpoint as the JSON API. These are path-style routes. A configured virtual host can also supply the bucket name. The server verifies signed URLs where a signed query is supplied. See the [XML handler](https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/internal/service/storage/xml.go) and the [Storage compatibility notes](https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/docs/compatibility.md#cloud-storage--json-api-v1)."},"x-cloudburrow":{"ref":"main","sha":"0ea25940d357e11a52853ca2d35617fc5253ffb0","coverageKey":"storage","endpointEnv":"STORAGE_EMULATOR_HOST"},"servers":[{"url":"http://127.0.0.1:9001","description":"Default local Storage endpoint. Use STORAGE_EMULATOR_HOST for your instance."}],"paths":{"/":{"get":{"operationId":"listXmlBuckets","summary":"List buckets for a project","parameters":[{"in":"header","name":"x-goog-project-id","description":"Local project ID.","schema":{"type":"string"},"required":true,"example":"cloudburrow"}],"responses":{"200":{"description":"Project buckets.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"ListAllMyBucketsResult"},"properties":{"Buckets":{"type":"object","xml":{"name":"Buckets"},"properties":{"Bucket":{"type":"array","items":{"type":"object","xml":{"name":"Bucket"},"properties":{"Name":{"type":"string"},"CreationDate":{"type":"string"}}}}}}}}}}},"default":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}}},"externalDocs":{"url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/storagexmlpost_test.go#L33"}}},"/{bucket}":{"parameters":[{"in":"path","name":"bucket","required":true,"schema":{"type":"string"},"example":"example-bucket"}],"get":{"operationId":"listXmlBucketObjects","summary":"List objects or active multipart uploads","description":"List objects by default. With the uploads query flag, list active multipart uploads.","parameters":[{"in":"query","name":"uploads","description":"Include this flag to initiate or list multipart uploads.","schema":{"type":"string"}},{"in":"query","name":"prefix","description":"Match keys with this prefix.","schema":{"type":"string"}},{"in":"query","name":"delimiter","description":"Group keys at this separator.","schema":{"type":"string"}},{"in":"query","name":"marker","description":"Start after this key.","schema":{"type":"string"}},{"in":"query","name":"max-keys","description":"Maximum number of keys.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Object or multipart-upload list.","content":{"application/xml":{"schema":{"oneOf":[{"type":"object","xml":{"name":"ListBucketResult"},"properties":{"Name":{"type":"string"},"Prefix":{"type":"string"},"IsTruncated":{"type":"boolean"},"Contents":{"type":"array","items":{"type":"object","xml":{"name":"Contents"},"properties":{"Key":{"type":"string"},"Size":{"type":"integer"},"ETag":{"type":"string"}}}}}},{"type":"object","xml":{"name":"ListMultipartUploadsResult"},"properties":{"Bucket":{"type":"string"},"Upload":{"type":"array","items":{"type":"object","xml":{"name":"Upload"},"properties":{"Key":{"type":"string"},"UploadId":{"type":"string"}}}}}}]}}}},"default":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}}},"externalDocs":{"url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/internal/service/storage/xmlops.go#L165"}},"put":{"operationId":"createXmlBucket","summary":"Create a bucket","parameters":[{"in":"header","name":"x-goog-project-id","description":"Local project ID.","schema":{"type":"string"},"required":true,"example":"cloudburrow"}],"requestBody":{"content":{"application/xml":{"schema":{"type":"object","xml":{"name":"CreateBucketConfiguration"},"properties":{"LocationConstraint":{"type":"string"},"StorageClass":{"type":"string"}}},"example":"<CreateBucketConfiguration><LocationConstraint>EU</LocationConstraint><StorageClass>NEARLINE</StorageClass></CreateBucketConfiguration>"}}},"responses":{"200":{"description":"Bucket created."},"409":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}},"default":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}}},"externalDocs":{"url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/storagexmlpost_test.go#L33"}},"post":{"operationId":"uploadXmlForm","summary":"Upload an object with a signed browser form","description":"Send the fields from a V4 POST policy and the file. The policy controls allowed fields, size and expiration.","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["key","policy","x-goog-algorithm","x-goog-credential","x-goog-date","x-goog-signature","file"],"properties":{"key":{"type":"string"},"policy":{"type":"string"},"x-goog-algorithm":{"type":"string"},"x-goog-credential":{"type":"string"},"x-goog-date":{"type":"string"},"x-goog-signature":{"type":"string"},"file":{"type":"string","format":"binary"},"success_action_status":{"type":"string","enum":["200","201","204"]},"success_action_redirect":{"type":"string"}}}}}},"responses":{"200":{"description":"Object stored."},"201":{"description":"Object stored and described.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"PostResponse"},"properties":{"Location":{"type":"string"},"Bucket":{"type":"string"},"Key":{"type":"string"},"ETag":{"type":"string"}}}}},"headers":{"Location":{"description":"Session or object URL.","schema":{"type":"string"}}}},"204":{"description":"Object stored."},"303":{"description":"Redirect to the approved URL.","headers":{"Location":{"description":"Session or object URL.","schema":{"type":"string"}}}},"default":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}}},"externalDocs":{"url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/storagexmlpost_test.go#L120"}},"delete":{"operationId":"deleteXmlBucket","summary":"Delete an empty bucket","responses":{"204":{"description":"Bucket deleted."},"409":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}},"default":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}}}},"options":{"operationId":"checkXmlBucketCors","summary":"Check cross-origin access","description":"The response includes CORS headers when the origin and requested method match the bucket policy.","parameters":[{"in":"header","name":"Origin","description":"Origin to check.","schema":{"type":"string"}},{"in":"header","name":"Access-Control-Request-Method","description":"Proposed HTTP method.","schema":{"type":"string"}},{"in":"header","name":"Access-Control-Request-Headers","description":"Proposed headers.","schema":{"type":"string"}}],"responses":{"200":{"description":"CORS check result."},"default":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}}},"externalDocs":{"url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/storagecors_test.go#L92"}}},"/{bucket}/{object}":{"parameters":[{"in":"path","name":"bucket","required":true,"schema":{"type":"string"},"example":"example-bucket"},{"in":"path","name":"object","required":true,"schema":{"type":"string"},"example":"hello.txt"}],"get":{"operationId":"readXmlObject","summary":"Read an object or list uploaded parts","description":"Use Range for a partial read. Supply uploadId to list parts for an active multipart upload.","parameters":[{"in":"query","name":"generation","description":"Read a specific object generation.","schema":{"type":"string"}},{"in":"query","name":"uploadId","description":"ID returned by XML multipart initiation.","schema":{"type":"string"}},{"in":"header","name":"Range","description":"Optional byte range, such as bytes=0-99.","schema":{"type":"string"}}],"responses":{"200":{"description":"Object bytes or the multipart part list.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}},"application/xml":{"schema":{"type":"object","xml":{"name":"ListPartsResult"},"properties":{"Part":{"type":"array","items":{"type":"object","xml":{"name":"Part"},"properties":{"Key":{"type":"string"},"Size":{"type":"integer"},"ETag":{"type":"string"}}}}}}}},"headers":{"ETag":{"description":"Entity tag. Save each part tag for multipart completion.","schema":{"type":"string"}}}},"206":{"description":"Requested byte range.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"headers":{"ETag":{"description":"Entity tag. Save each part tag for multipart completion.","schema":{"type":"string"}}}},"default":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}}},"externalDocs":{"url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/storagexml_test.go#L67"}},"head":{"operationId":"headXmlObject","summary":"Read object headers","parameters":[{"in":"query","name":"generation","description":"Read a specific object generation.","schema":{"type":"string"}}],"responses":{"200":{"description":"Object headers.","headers":{"ETag":{"description":"Entity tag. Save each part tag for multipart completion.","schema":{"type":"string"}}}},"404":{"description":"Object or bucket not found."}}},"put":{"operationId":"writeXmlObject","summary":"Write an object, multipart part or resumable chunk","description":"Without a session parameter, writes an object. Use uploadId and partNumber to upload a multipart part. Use the resumable Location with upload_id and Content-Range for a resumable chunk.","parameters":[{"in":"query","name":"uploadId","description":"ID returned by XML multipart initiation.","schema":{"type":"string"}},{"in":"query","name":"upload_id","description":"Keep the ID from the resumable session Location unchanged.","schema":{"type":"string"}},{"in":"query","name":"partNumber","description":"Multipart part number.","schema":{"type":"integer"}},{"in":"header","name":"Content-Range","description":"Resumable byte range, such as bytes 0-9/10.","schema":{"type":"string"}},{"in":"header","name":"Content-MD5","description":"Optional base64-encoded digest of the body.","schema":{"type":"string"}},{"in":"header","name":"x-goog-if-generation-match","description":"Write only if the generation matches. Use 0 to require an absent object.","schema":{"type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Object or part stored.","headers":{"ETag":{"description":"Entity tag. Save each part tag for multipart completion.","schema":{"type":"string"}}}},"308":{"description":"Resumable session is incomplete."},"412":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}},"default":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}}},"externalDocs":{"url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/storagexml_test.go#L113"}},"post":{"operationId":"startOrCompleteXmlUpload","summary":"Start an upload or complete multipart assembly","description":"Add uploads to start multipart upload, send uploadId with the part list to complete it, or send X-Goog-Resumable: start to create a resumable session.","parameters":[{"in":"query","name":"uploads","description":"Include this flag to initiate or list multipart uploads.","schema":{"type":"string"}},{"in":"query","name":"uploadId","description":"ID returned by XML multipart initiation.","schema":{"type":"string"}},{"in":"header","name":"X-Goog-Resumable","description":"Use start to create a resumable session.","schema":{"type":"string"}}],"requestBody":{"content":{"application/xml":{"schema":{"type":"object","xml":{"name":"CompleteMultipartUpload"},"properties":{"Part":{"type":"array","items":{"type":"object","xml":{"name":"Part"},"properties":{"PartNumber":{"type":"integer"},"ETag":{"type":"string"}}}}}},"example":"<CompleteMultipartUpload><Part><PartNumber>1</PartNumber><ETag>example-tag</ETag></Part></CompleteMultipartUpload>"}}},"responses":{"200":{"description":"Multipart initiation or completion result.","content":{"application/xml":{"schema":{"oneOf":[{"type":"object","xml":{"name":"InitiateMultipartUploadResult"},"properties":{"Bucket":{"type":"string"},"Key":{"type":"string"},"UploadId":{"type":"string"}}},{"type":"object","xml":{"name":"CompleteMultipartUploadResult"},"properties":{"Location":{"type":"string"},"Bucket":{"type":"string"},"Key":{"type":"string"},"ETag":{"type":"string"}}}]}}}},"201":{"description":"Resumable session created.","headers":{"Location":{"description":"Session or object URL.","schema":{"type":"string"}}}},"default":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}}},"externalDocs":{"url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/internal/service/storage/multipart.go"}},"delete":{"operationId":"deleteXmlObject","summary":"Delete an object or cancel an upload","description":"Use uploadId to abort a multipart session, or use the resumable Location to cancel a resumable session.","parameters":[{"in":"query","name":"generation","description":"Delete a specific object generation.","schema":{"type":"string"}},{"in":"query","name":"uploadId","description":"ID returned by XML multipart initiation.","schema":{"type":"string"}},{"in":"query","name":"upload_id","description":"Keep the ID from the resumable session Location unchanged.","schema":{"type":"string"}}],"responses":{"204":{"description":"Object deleted or session canceled."},"default":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}}}},"options":{"operationId":"checkXmlObjectCors","summary":"Check cross-origin access","description":"The response includes CORS headers when the origin and requested method match the bucket policy.","parameters":[{"in":"header","name":"Origin","description":"Origin to check.","schema":{"type":"string"}},{"in":"header","name":"Access-Control-Request-Method","description":"Proposed HTTP method.","schema":{"type":"string"}},{"in":"header","name":"Access-Control-Request-Headers","description":"Proposed headers.","schema":{"type":"string"}}],"responses":{"200":{"description":"CORS check result."},"default":{"description":"Storage XML error.","content":{"application/xml":{"schema":{"type":"object","xml":{"name":"Error"},"properties":{"Code":{"type":"string"},"Message":{"type":"string"},"Details":{"type":"string"}}}}}}},"externalDocs":{"url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/storagecors_test.go#L92"}}}}}