{ "uuid": "4397f643-687b-47b2-bd8b-b264dd577f5d", "lastMigration": 29, "name": "Cloud Firestore API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "0347ded0-b86a-4bcb-b8d0-9c93ff8d0904", "documentation": "Deletes a composite index.", "method": "delete", "endpoint": "v1beta2/:name", "responses": [ { "uuid": "1244cad4-16a8-41bf-8014-bf04d3b32ecd", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4695017f-2ae2-48de-b40d-2bcac2e056c0", "documentation": "Gets a composite index.", "method": "get", "endpoint": "v1beta2/:name", "responses": [ { "uuid": "5896d3ec-c0ec-4873-9721-6daed13b6bc1", "body": "{\n \"fields\": [\n {\n \"arrayConfig\": \"{{oneOf (array 'ARRAY_CONFIG_UNSPECIFIED' 'CONTAINS')}}\",\n \"fieldPath\": \"\",\n \"order\": \"{{oneOf (array 'ORDER_UNSPECIFIED' 'ASCENDING' 'DESCENDING')}}\"\n }\n ],\n \"name\": \"\",\n \"queryScope\": \"{{oneOf (array 'QUERY_SCOPE_UNSPECIFIED' 'COLLECTION' 'COLLECTION_GROUP')}}\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'CREATING' 'READY' 'NEEDS_REPAIR')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c869534a-5b9e-45f6-a5d6-2f2333257a73", "documentation": "Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: \"index_config\" }`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.", "method": "patch", "endpoint": "v1beta2/:name", "responses": [ { "uuid": "60c54eb1-c0b1-4b80-b91b-35fb55bc0197", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fbcbbbe3-e389-4f4c-b732-c28c84a8435a", "documentation": "Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.", "method": "post", "endpoint": "v1beta2/:name:exportDocuments", "responses": [ { "uuid": "421f3e70-12c7-4f24-b08a-073537753f30", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f94a7de2-0fa6-4712-9ad5-9720088cf89a", "documentation": "Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.", "method": "post", "endpoint": "v1beta2/:name:importDocuments", "responses": [ { "uuid": "4a777192-862d-4707-bb20-a225347eda90", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d4d0fa40-df5e-423b-a782-bcacd9e50020", "documentation": "Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`.", "method": "get", "endpoint": "v1beta2/:parent/fields", "responses": [ { "uuid": "506227b4-78c9-407f-bbfc-ac5c3ab28cc1", "body": "{\n \"fields\": [\n {\n \"indexConfig\": {\n \"ancestorField\": \"\",\n \"indexes\": [\n {\n \"fields\": [\n {\n \"arrayConfig\": \"{{oneOf (array 'ARRAY_CONFIG_UNSPECIFIED' 'CONTAINS')}}\",\n \"fieldPath\": \"\",\n \"order\": \"{{oneOf (array 'ORDER_UNSPECIFIED' 'ASCENDING' 'DESCENDING')}}\"\n }\n ],\n \"name\": \"\",\n \"queryScope\": \"{{oneOf (array 'QUERY_SCOPE_UNSPECIFIED' 'COLLECTION' 'COLLECTION_GROUP')}}\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'CREATING' 'READY' 'NEEDS_REPAIR')}}\"\n }\n ],\n \"reverting\": {{faker 'datatype.boolean'}},\n \"usesAncestorConfig\": {{faker 'datatype.boolean'}}\n },\n \"name\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0094babd-29aa-43e0-a38b-89bc940eded7", "documentation": "Lists composite indexes.", "method": "get", "endpoint": "v1beta2/:parent/indexes", "responses": [ { "uuid": "9ff6dbfd-c2fa-418d-b3c9-3303c7dd3f54", "body": "{\n \"indexes\": [\n {\n \"fields\": [\n {\n \"arrayConfig\": \"{{oneOf (array 'ARRAY_CONFIG_UNSPECIFIED' 'CONTAINS')}}\",\n \"fieldPath\": \"\",\n \"order\": \"{{oneOf (array 'ORDER_UNSPECIFIED' 'ASCENDING' 'DESCENDING')}}\"\n }\n ],\n \"name\": \"\",\n \"queryScope\": \"{{oneOf (array 'QUERY_SCOPE_UNSPECIFIED' 'COLLECTION' 'COLLECTION_GROUP')}}\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'CREATING' 'READY' 'NEEDS_REPAIR')}}\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "587dc2cd-3f54-4976-973b-63832a0aa74c", "documentation": "Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.", "method": "post", "endpoint": "v1beta2/:parent/indexes", "responses": [ { "uuid": "21199acf-8d3a-40ba-b155-7f9b3e378198", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "0347ded0-b86a-4bcb-b8d0-9c93ff8d0904" }, { "type": "route", "uuid": "4695017f-2ae2-48de-b40d-2bcac2e056c0" }, { "type": "route", "uuid": "c869534a-5b9e-45f6-a5d6-2f2333257a73" }, { "type": "route", "uuid": "fbcbbbe3-e389-4f4c-b732-c28c84a8435a" }, { "type": "route", "uuid": "f94a7de2-0fa6-4712-9ad5-9720088cf89a" }, { "type": "route", "uuid": "d4d0fa40-df5e-423b-a782-bcacd9e50020" }, { "type": "route", "uuid": "0094babd-29aa-43e0-a38b-89bc940eded7" }, { "type": "route", "uuid": "587dc2cd-3f54-4976-973b-63832a0aa74c" } ] }