{"openapi":"3.1.0","info":{"title":"Firestore","version":"main (0ea2594)","description":"Local Firestore HTTP routes audited against CloudBurrow main at `0ea2594`.\n\nRequest and response shapes use the pinned Google discovery version and any linked CloudBurrow route definitions. A route’s coverage status describes the linked test or implementation, and individual schema fields can have narrower support.","license":{"name":"BSD 3-Clause (Google discovery)","url":"https://github.com/googleapis/google-api-go-client/blob/v0.298.0/LICENSE"}},"servers":[{"url":"http://127.0.0.1:{port}","description":"Local instance only. Use the FIRESTORE_EMULATOR_HOST value from cloudburrow env for the running instance.","variables":{"port":{"default":"9010","description":"Configured default. Use the actual port reported for your running instance."}}}],"paths":{"/v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{collectionId}":{"post":{"operationId":"firestore.projects.databases.documents.createDocument","summary":"firestore.projects.databases.documents.createDocument","description":"The local HTTP binding is **Verified**. The tracked operation `google.firestore.v1.Firestore/CreateDocument` has **Verified** coverage.\n\nCoverage evidence\n\n[TestFirestoreDocumentRPCs](https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/firestoremethods_test.go#L59)","parameters":[{"name":"projectsId","in":"path","required":true,"schema":{"type":"string"}},{"name":"databasesId","in":"path","required":true,"schema":{"type":"string"}},{"name":"documentsId","in":"path","required":true,"schema":{"type":"string"}},{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"query","schema":{"type":"string"}},{"name":"mask.fieldPaths","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"requestOptions.requestTags","in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"2XX":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}}},"x-cloudburrow":{"status":"Verified","coverageStatus":"Verified","method":"google.firestore.v1.Firestore/CreateDocument","tests":[{"name":"TestFirestoreDocumentRPCs","url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/firestoremethods_test.go#L59"}]},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}}},"delete":{"operationId":"firestore.projects.databases.documents.delete","summary":"firestore.projects.databases.documents.delete","description":"The local HTTP binding is **Verified**. The tracked operation `google.firestore.v1.Firestore/DeleteDocument` has **Verified** coverage.\n\nCoverage evidence\n\n[TestFirestoreDocumentRPCs](https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/firestoremethods_test.go#L59)","parameters":[{"name":"projectsId","in":"path","required":true,"schema":{"type":"string"}},{"name":"databasesId","in":"path","required":true,"schema":{"type":"string"}},{"name":"documentsId","in":"path","required":true,"schema":{"type":"string"}},{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"currentDocument.exists","in":"query","schema":{"type":"boolean"}},{"name":"currentDocument.updateTime","in":"query","schema":{"type":"string","format":"google-datetime"}},{"name":"requestOptions.requestTags","in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"2XX":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}}}},"x-cloudburrow":{"status":"Verified","coverageStatus":"Verified","method":"google.firestore.v1.Firestore/DeleteDocument","tests":[{"name":"TestFirestoreDocumentRPCs","url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/firestoremethods_test.go#L59"}]}},"get":{"operationId":"firestore.projects.databases.documents.get","summary":"firestore.projects.databases.documents.get","description":"The local HTTP binding is **Verified**. The tracked operation `google.firestore.v1.Firestore/GetDocument` has **Verified** coverage.\n\nCoverage evidence\n\n[TestFirestoreDocumentRPCs](https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/firestoremethods_test.go#L59)","parameters":[{"name":"projectsId","in":"path","required":true,"schema":{"type":"string"}},{"name":"databasesId","in":"path","required":true,"schema":{"type":"string"}},{"name":"documentsId","in":"path","required":true,"schema":{"type":"string"}},{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"mask.fieldPaths","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"readTime","in":"query","schema":{"type":"string","format":"google-datetime"}},{"name":"requestOptions.requestTags","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"transaction","in":"query","schema":{"type":"string","format":"byte"}}],"responses":{"2XX":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}}},"x-cloudburrow":{"status":"Verified","coverageStatus":"Verified","method":"google.firestore.v1.Firestore/GetDocument","tests":[{"name":"TestFirestoreDocumentRPCs","url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/firestoremethods_test.go#L59"}]}},"patch":{"operationId":"firestore.projects.databases.documents.patch","summary":"firestore.projects.databases.documents.patch","description":"The local HTTP binding is **Verified**. The tracked operation `google.firestore.v1.Firestore/UpdateDocument` has **Verified** coverage.\n\nCoverage evidence\n\n[TestFirestoreDocumentRPCs](https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/firestoremethods_test.go#L59)","parameters":[{"name":"projectsId","in":"path","required":true,"schema":{"type":"string"}},{"name":"databasesId","in":"path","required":true,"schema":{"type":"string"}},{"name":"documentsId","in":"path","required":true,"schema":{"type":"string"}},{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"currentDocument.exists","in":"query","schema":{"type":"boolean"}},{"name":"currentDocument.updateTime","in":"query","schema":{"type":"string","format":"google-datetime"}},{"name":"mask.fieldPaths","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"requestOptions.requestTags","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"updateMask.fieldPaths","in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"2XX":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}}},"x-cloudburrow":{"status":"Verified","coverageStatus":"Verified","method":"google.firestore.v1.Firestore/UpdateDocument","tests":[{"name":"TestFirestoreDocumentRPCs","url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/firestoremethods_test.go#L59"}]},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}}}},"/v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}/{collectionId}":{"get":{"operationId":"firestore.projects.databases.documents.list","summary":"firestore.projects.databases.documents.list","description":"The local HTTP binding is **Implemented**. The tracked operation `google.firestore.v1.Firestore/ListDocuments` has **Verified** coverage.\n\nCoverage evidence\n\n[TestConsoleFirestoreCountsMissingDocuments](https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/consoledatawrites_test.go#L1013)\n\n[TestConsoleFirestoreListsMissingDocumentsWithSubcollections](https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/consoledatawrites_test.go#L600)","parameters":[{"name":"projectsId","in":"path","required":true,"schema":{"type":"string"}},{"name":"databasesId","in":"path","required":true,"schema":{"type":"string"}},{"name":"documentsId","in":"path","required":true,"schema":{"type":"string"}},{"name":"documentsId1","in":"path","required":true,"schema":{"type":"string"}},{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"mask.fieldPaths","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"orderBy","in":"query","schema":{"type":"string"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageToken","in":"query","schema":{"type":"string"}},{"name":"readTime","in":"query","schema":{"type":"string","format":"google-datetime"}},{"name":"recursive","in":"query","schema":{"type":"boolean"}},{"name":"requestOptions.requestTags","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"showMissing","in":"query","schema":{"type":"boolean"}},{"name":"transaction","in":"query","schema":{"type":"string","format":"byte"}}],"responses":{"2XX":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDocumentsResponse"}}}}},"x-cloudburrow":{"status":"Implemented","coverageStatus":"Verified","method":"google.firestore.v1.Firestore/ListDocuments","tests":[{"name":"TestConsoleFirestoreCountsMissingDocuments","url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/consoledatawrites_test.go#L1013"},{"name":"TestConsoleFirestoreListsMissingDocumentsWithSubcollections","url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/consoledatawrites_test.go#L600"}]}}},"/v1/projects/{projectsId}/databases/{databasesId}/documents:partitionQuery":{"post":{"operationId":"firestore.projects.databases.documents.partitionQuery","summary":"firestore.projects.databases.documents.partitionQuery","description":"The local HTTP binding is **Implemented**. The tracked operation `google.firestore.v1.Firestore/PartitionQuery` has **Verified** coverage.\n\nCoverage evidence\n\n[TestFirestorePartitionedQueries](https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/firestoremethods_test.go#L322)","parameters":[{"name":"projectsId","in":"path","required":true,"schema":{"type":"string"}},{"name":"databasesId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"2XX":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartitionQueryResponse"}}}}},"x-cloudburrow":{"status":"Implemented","coverageStatus":"Verified","method":"google.firestore.v1.Firestore/PartitionQuery","tests":[{"name":"TestFirestorePartitionedQueries","url":"https://github.com/cloudburrow/cloudburrow/blob/0ea25940d357e11a52853ca2d35617fc5253ffb0/test/compat/firestoremethods_test.go#L322"}]},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartitionQueryRequest"}}}}}}},"components":{"schemas":{"Document":{"type":"object","properties":{"createTime":{"type":"string","format":"google-datetime"},"fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Value"}},"name":{"type":"string"},"updateTime":{"type":"string","format":"google-datetime"}}},"Value":{"type":"object","properties":{"arrayValue":{"$ref":"#/components/schemas/ArrayValue"},"booleanValue":{"type":"boolean"},"bytesValue":{"type":"string","format":"byte"},"doubleValue":{"type":"number","format":"double"},"fieldReferenceValue":{"type":"string"},"functionValue":{"$ref":"#/components/schemas/Function"},"geoPointValue":{"$ref":"#/components/schemas/LatLng"},"integerValue":{"type":"string","format":"int64"},"mapValue":{"$ref":"#/components/schemas/MapValue"},"nullValue":{"type":"string","enum":["NULL_VALUE"]},"pipelineValue":{"$ref":"#/components/schemas/Pipeline"},"referenceValue":{"type":"string"},"stringValue":{"type":"string"},"timestampValue":{"type":"string","format":"google-datetime"},"variableReferenceValue":{"type":"string"}}},"ArrayValue":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/Value"}}}},"Function":{"type":"object","properties":{"args":{"type":"array","items":{"$ref":"#/components/schemas/Value"}},"name":{"type":"string"},"options":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Value"}}}},"LatLng":{"type":"object","properties":{"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"}}},"MapValue":{"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Value"}}}},"Pipeline":{"type":"object","properties":{"stages":{"type":"array","items":{"$ref":"#/components/schemas/Stage"}}}},"Stage":{"type":"object","properties":{"args":{"type":"array","items":{"$ref":"#/components/schemas/Value"}},"name":{"type":"string"},"options":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Value"}}}},"Empty":{"type":"object","properties":{}},"ListDocumentsResponse":{"type":"object","properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"nextPageToken":{"type":"string"}}},"PartitionQueryResponse":{"type":"object","properties":{"nextPageToken":{"type":"string"},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/Cursor"}}}},"Cursor":{"type":"object","properties":{"before":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/Value"}}}},"PartitionQueryRequest":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"pageToken":{"type":"string"},"partitionCount":{"type":"string","format":"int64"},"readTime":{"type":"string","format":"google-datetime"},"requestOptions":{"$ref":"#/components/schemas/RequestOptions"},"structuredQuery":{"$ref":"#/components/schemas/StructuredQuery"}}},"RequestOptions":{"type":"object","properties":{"requestTags":{"type":"array","items":{"type":"string"}}}},"StructuredQuery":{"type":"object","properties":{"endAt":{"$ref":"#/components/schemas/Cursor"},"findNearest":{"$ref":"#/components/schemas/FindNearest"},"from":{"type":"array","items":{"$ref":"#/components/schemas/CollectionSelector"}},"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"orderBy":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"select":{"$ref":"#/components/schemas/Projection"},"startAt":{"$ref":"#/components/schemas/Cursor"},"where":{"$ref":"#/components/schemas/Filter"}}},"FindNearest":{"type":"object","properties":{"distanceMeasure":{"type":"string","enum":["DISTANCE_MEASURE_UNSPECIFIED","EUCLIDEAN","COSINE","DOT_PRODUCT"]},"distanceResultField":{"type":"string"},"distanceThreshold":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"},"queryVector":{"$ref":"#/components/schemas/Value"},"vectorField":{"$ref":"#/components/schemas/FieldReference"}}},"FieldReference":{"type":"object","properties":{"fieldPath":{"type":"string"}}},"CollectionSelector":{"type":"object","properties":{"allDescendants":{"type":"boolean"},"collectionId":{"type":"string"}}},"Order":{"type":"object","properties":{"direction":{"type":"string","enum":["DIRECTION_UNSPECIFIED","ASCENDING","DESCENDING"]},"field":{"$ref":"#/components/schemas/FieldReference"}}},"Projection":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/FieldReference"}}}},"Filter":{"type":"object","properties":{"compositeFilter":{"$ref":"#/components/schemas/CompositeFilter"},"fieldFilter":{"$ref":"#/components/schemas/FieldFilter"},"unaryFilter":{"$ref":"#/components/schemas/UnaryFilter"}}},"CompositeFilter":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"op":{"type":"string","enum":["OPERATOR_UNSPECIFIED","AND","OR"]}}},"FieldFilter":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldReference"},"op":{"type":"string","enum":["OPERATOR_UNSPECIFIED","LESS_THAN","LESS_THAN_OR_EQUAL","GREATER_THAN","GREATER_THAN_OR_EQUAL","EQUAL","NOT_EQUAL","ARRAY_CONTAINS","IN","ARRAY_CONTAINS_ANY","NOT_IN"]},"value":{"$ref":"#/components/schemas/Value"}}},"UnaryFilter":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/FieldReference"},"op":{"type":"string","enum":["OPERATOR_UNSPECIFIED","IS_NAN","IS_NULL","IS_NOT_NAN","IS_NOT_NULL"]}}}}},"x-cloudburrow":{"ref":"main","sha":"0ea25940d357e11a52853ca2d35617fc5253ffb0","coverageKey":"firestore","endpointEnv":"FIRESTORE_EMULATOR_HOST","discoveryVersion":"v1","source":"https://github.com/googleapis/google-api-go-client/blob/v0.298.0/firestore/v1/firestore-api.json"},"x-discovery-license-notice":"Copyright (c) 2011 Google Inc. All rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n   * Redistributions of source code must retain the above copyright\nnotice, this list of conditions and the following disclaimer.\n   * Redistributions in binary form must reproduce the above\ncopyright notice, this list of conditions and the following disclaimer\nin the documentation and/or other materials provided with the\ndistribution.\n   * Neither the name of Google Inc. nor the names of its\ncontributors may be used to endorse or promote products derived from\nthis software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\nLIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\nDATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\nTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n"}