{ "components": { "examples": { "ActiveTasks": { "description": "Example ActiveTasks response.", "value": [ { "changes_done": 64438, "database": "products", "node": "nonode@nohost", "pid": "<0.12986.1>", "progress": 84, "started_on": 1376116576, "total_changes": 76215, "type": "database_compaction", "updated_on": 1376116619 }, { "changes_done": 14443, "database": "users", "design_document": "_design/c9753817b3ba7c674d92361f24f59b9f", "node": "nonode@nohost", "pid": "<0.10461.3>", "progress": 18, "started_on": 1376116621, "total_changes": 76215, "type": "indexer", "updated_on": 1376116650 } ] }, "ActivityTrackerEvents": { "description": "Example ActivityTrackerEvents request and response.", "value": { "types": [ "management", "data" ] } }, "AllDbsResult": { "description": "Example AllDbs response.", "value": [ "events", "orders", "products", "stores", "users" ] }, "AllDocsQueriesQuery": { "description": "Example AllDocsQueriesQuery request.", "value": { "queries": [ { "keys": [ "small-appliances:1000042", "small-appliances:1000043" ] }, { "limit": 3, "skip": 2 } ] } }, "AllDocsQueriesResult": { "description": "Example AllDocsQueriesResult response.", "value": { "results": [ { "offset": 0, "rows": [ { "id": "exampleid", "key": "exampleid", "value": { "rev": "1-5005d65514fe9e90f8eccf174af5dd64" } }, { "id": "exampleid2", "key": "exampleid2", "value": { "rev": "1-2d7810b054babeda4812b3924428d6d6" } } ], "total_rows": 5 }, { "offset": 2, "rows": [ { "id": "exampleid3", "key": "exampleid3", "value": { "rev": "1-5005d65514fe9e90f8eccf174af5dd64" } }, { "id": "exampleid4", "key": "exampleid4", "value": { "rev": "1-2d7810b054babeda4812b3924428d6d6" } } ], "total_rows": 5 } ] } }, "AllDocsQuery": { "description": "Example AllDocs request.", "value": { "limit": 10, "start_key": "0007741142412418284" } }, "AllDocsResult": { "description": "Example AllDocsResult response.", "value": { "offset": 0, "rows": [ { "doc": { "_id": "exampleid", "_rev": "1-967a00dff5e02add41819138abb3284d" }, "id": "exampleid", "key": "exampleid", "value": { "rev": "1-967a00dff5e02add41819138abb3284d" } } ], "total_rows": 1 } }, "AllDocsResultDesignDocs": { "description": "Example AllDocsResult response for design documents.", "value": { "offset": 0, "rows": [ { "id": "_design/ddoc01", "key": "_design/ddoc01", "value": { "rev": "1-7407569d54af5bc94c266e70cbf8a180" } }, { "id": "_design/ddoc02", "key": "_design/ddoc02", "value": { "rev": "1-d942f0ce01647aa0f46518b213b5628e" } }, { "id": "_design/ddoc03", "key": "_design/ddoc03", "value": { "rev": "1-721fead6e6c8d811a225d5a62d08dfd0" } }, { "id": "_design/ddoc04", "key": "_design/ddoc04", "value": { "rev": "1-32c76b46ca61351c75a84fbcbceece2f" } }, { "id": "_design/ddoc05", "key": "_design/ddoc05", "value": { "rev": "1-af856babf9cf746b48ae999645f9541e" } } ], "total_rows": 5 } }, "AllDocsResultLocalDocs": { "description": "Example AllDocsResult response for local documents.", "value": { "offset": null, "rows": [ { "id": "_local/0011a1cdda315e7dce2978ee157e4f5d", "key": "_local/0011a1cdda315e7dce2978ee157e4f5d", "value": { "rev": "0-1" } } ], "total_rows": null } }, "AllDocsResultPartition": { "description": "Example AllDocsResult response for a database partition.", "value": { "offset": 0, "rows": [ { "id": "small-appliances:1000042", "key": "small-appliances:1000042", "value": { "rev": "1-5005d65514fe9e90f8eccf174af5dd64" } }, { "id": "small-appliances:1000043", "key": "small-appliances:1000043", "value": { "rev": "1-2d7810b054babeda4812b3924428d6d6" } } ], "total_rows": 2 } }, "ApiKeysResult": { "description": "Example ApiKeysResult response.", "value": { "key": "apikey-examplegeneratedapikeyidentifier", "ok": true, "password": "abcdefABCDEFabcdefABCDEF" } }, "AttachmentContent": { "description": "Example AttachmentContent request and response.", "value": "This appliance includes..." }, "BulkDocs": { "description": "Example BulkDocs request: create and update documents", "value": { "docs": [ { "_id": "0007241142412418284", "date": "2019-01-28T10:44:22.000Z", "eventType": "addedToBasket", "productId": "1000042", "type": "event", "userid": "abc123" }, { "_id": "0008001142412418285", "date": "2019-01-28T12:30:00.000Z", "eventType": "addedToBasket", "productId": "1000043", "type": "event", "userid": "def456" } ] } }, "BulkDocsDelete": { "description": "Example BulkDocs request: delete documents", "value": { "docs": [ { "_deleted": true, "_id": "0007241142412418284", "_rev": "1-5005d65514fe9e90f8eccf174af5dd64" }, { "_deleted": true, "_id": "0008001142412418285", "_rev": "1-2d7810b054babeda4812b3924428d6d6" } ] } }, "BulkDocsResult": { "description": "Example BulkDocsResult response.", "value": [ { "id": "0007241142412418284", "ok": true, "rev": "1-5005d65514fe9e90f8eccf174af5dd64" }, { "id": "0008001142412418285", "ok": true, "rev": "1-2d7810b054babeda4812b3924428d6d6" } ] }, "BulkGetQuery": { "description": "Example BulkGetQuery request.", "value": { "docs": [ { "id": "order00067", "rev": "3-917fa2381192822767f010b95b45325b" }, { "id": "order00067", "rev": "4-a5be949eeb7296747cc271766e9a498b" } ] } }, "BulkGetResult": { "description": "Example BulkGetResult response.", "value": { "results": [ { "docs": [ { "ok": { "_id": "order00067", "_rev": "3-917fa2381192822767f010b95b45325b", "basket": [ { "name": "Salter - Digital Kitchen Scales", "price": 14.99 } ], "date": "2019-01-21T10:10:12.000Z", "delivered": false, "deliveryAddress": { "postcode": "DL5 1TY", "street": "19 Front St", "town": "Darlington" }, "orderid": "00067", "total": 14.99, "type": "order", "user": "Bob Smith", "userid": "abc123" } } ], "id": "order00067" }, { "docs": [ { "ok": { "_id": "order00067", "_rev": "4-a5be949eeb7296747cc271766e9a498b", "basket": [ { "name": "Salter - Digital Kitchen Scales", "price": 14.99 }, { "name": "Kenwood - Stand Mixer", "price": 199.99 } ], "courier": "UPS", "courierid": "15125425151261289", "date": "2019-01-28T10:44:22.000Z", "delivered": true, "deliveryAddress": { "postcode": "DL5 1TY", "street": "19 Front St", "town": "Darlington" }, "orderid": "00067", "total": 214.98, "type": "order", "user": "Bob Smith", "userid": "abc123" } } ], "id": "order00067" } ] } }, "BulkGetResultAttsSince": { "description": "Example BulkGetResult response for the `atts_since` alternative request.", "summary": "Response for the `atts_since` alternative request", "value": { "results": [ { "docs": [ { "ok": { "_attachments": { "att": { "content_type": "application/json", "digest": "md5-cCkGbCesb17xjWYNV0GXmg==", "length": 0, "revpos": 1, "stub": true } }, "_id": "order00058", "_rev": "1-99b02e08da151943c2dcb40090160bb8" } } ], "id": "order00058" } ] } }, "BulkGetResultMultipart": { "description": "Example multipart response for bulk get.", "value": { "results": [ { "document": { "_attachments": { "recipe.txt": { "content_type": "text/plain", "digest": "md5-HV9aXJdEnu0xnMQYTKgOFA==", "follows": true, "length": 86, "revpos": 2 } }, "_id": "secret", "_rev": "2-c1c6c44c4bc3c9344b037c8690468605", "_revisions": { "ids": [ "c1c6c44c4bc3c9344b037c8690468605", "967a00dff5e02add41819138abb3284d" ], "start": 2 } }, "documentAttachments": [ "1. Take R\n2. Take E\n3. Mix with L\n4. Add some A\n5. Serve with X" ] }, { "error": "not_found", "reason": "missing", "rev": "6-cf874ee0892013c7e10c1c3692a5afe2" } ] }, "x-raw-multipart": { "notes": "Raw multipart representation of the example", "value": "Content-Type: multipart/related; \\\nboundary=\"--65275f24d4e39d8a7c67fce95bebd740\"\n----65275f24d4e39d8a7c67fce95bebd740\nX-Doc-Id: secret\nX-Rev-Id: 2-c1c6c44c4bc3c9344b037c8690468605\nContent-Type: multipart/related; \\\nboundary=--04c914b11118c75ba14c3a76d4f334d2\n\n----04c914b11118c75ba14c3a76d4f334d2\nContent-Type: application/json\n\n{\n\"_id\":\"secret\",\n\"_rev\":\"2-c1c6c44c4bc3c9344b037c8690468605\",\n\"_attachments\":{\n \"recipe.txt\":{\n \"content_type\":\"text/plain\",\n \"revpos\":2,\n \"digest\":\"md5-HV9aXJdEnu0xnMQYTKgOFA==\",\n \"length\":86,\n \"follows\":true}\n }\n\"_revisions\":{\n \"start\":2,\n \"ids\":[\n \"c1c6c44c4bc3c9344b037c8690468605\",\n \"967a00dff5e02add41819138abb3284d\"]\n }\n}\n\n----04c914b11118c75ba14c3a76d4f334d2\nContent-Disposition: attachment; filename=\"recipe.txt\"\nContent-Type: text/plain\nContent-Length: 86\n\n1. Take R\n2. Take E\n3. Mix with L\n4. Add some A\n5. Serve with X\n\n----04c914b11118c75ba14c3a76d4f334d2--\n\n----65275f24d4e39d8a7c67fce95bebd740\nContent-Type: application/json; error=\"true\"\n\n{\n \"rev\":\"6-cf874ee0892013c7e10c1c3692a5afe2\",\n \"error\":\"not_found\",\n \"reason\":\"missing\"\n}\n----65275f24d4e39d8a7c67fce95bebd740--" } }, "BulkGetResultOpenRevs": { "description": "Example BulkGetResult response for the `open_revs=all` alternative request.", "summary": "Response for the `open_revs=all` alternative request", "value": { "results": [ { "docs": [ { "ok": { "_id": "order00067", "_rev": "3-917fa2381192822767f010b95b45325b", "basket": [ { "name": "Salter - Digital Kitchen Scales", "price": 14.99 } ], "date": "2019-01-21T10:10:12.000Z", "delivered": false, "deliveryAddress": { "postcode": "DL5 1TY", "street": "19 Front St", "town": "Darlington" }, "orderid": "00067", "total": 14.99, "type": "order", "user": "Bob Smith", "userid": "abc123" } }, { "ok": { "_id": "order00067", "_rev": "4-a5be949eeb7296747cc271766e9a498b", "basket": [ { "name": "Salter - Digital Kitchen Scales", "price": 14.99 }, { "name": "Kenwood - Stand Mixer", "price": 199.99 } ], "courier": "UPS", "courierid": "15125425151261289", "date": "2019-01-28T10:44:22.000Z", "delivered": true, "deliveryAddress": { "postcode": "DL5 1TY", "street": "19 Front St", "town": "Darlington" }, "orderid": "00067", "total": 214.98, "type": "order", "user": "Bob Smith", "userid": "abc123" } } ], "id": "order00067" } ] } }, "CapacityDatabasesInformation": { "value": { "current": { "databases": { "total": 200 } } } }, "CapacityThroughputConfiguration": { "description": "Example CapacityThroughputConfiguration request.", "value": { "blocks": 10 } }, "CapacityThroughputInformation": { "description": "Example CapacityThroughputInformation response.", "value": { "current": { "throughput": { "blocks": 5, "query": 25, "read": 500, "write": 250 } }, "target": { "throughput": { "blocks": 10, "query": 50, "read": 1000, "write": 500 } } } }, "CcmDiagnostics": { "description": "Example getCcmDiagnostics response.", "value": { "account": "5lll032-dd12-536e-09b3-432fg9f07e78-bluemix", "deny429History": [ { "lookup": 0, "query": 0, "ts": 1688993801, "write": 0 } ], "lookup": 0, "operationHistory": [ { "lookup": 0, "query": 0, "ts": 1688993801, "write": 0 } ], "query": 0, "ts": 1688993805, "write": 0 } }, "ChangesQueryFilterDocIds": { "description": "Example ChangesQuery request if `?filter=_doc_ids` is used.", "value": { "doc_ids": [ "0007741142412418284" ] } }, "ChangesQueryFilterSelector": { "description": "Example ChangesQuery request if `?filter=_selector` is used.", "value": { "fields": [ "type", "user" ], "selector": { "_id": { "$regex": "^0+7741142412418284" } } } }, "ChangesResult": { "description": "Example ChangesResult response.", "value": { "last_seq": "7-g1AAAAPveJy1kk9OAjEYxSuYGBO3nsCdC9LOP5yVXkGhB-jXdoKTsSQG1p7CKyj0Ep6CS3AGob5hwYSNMJOwek3T971fXr-KMXYz6Rt2Z0hP3-2ToWygq-ncKDfjXOzPA2dnFR73FKNbKcelYoe2-H9bbZJ07_2ynPTVxRvurjTPhU6i06YcpkVH0hDk6TGEbWtOmAKBddRwUpw-iKE4ByeCxlR6v2jNCdOSPkLY1JxsxykyLlKuDLueO2OLV2dNq6-tx23dJXuR8rMtD2wj2CDfqL5m6u2Ycp1HQ5N26e4ILaIWiIL8hvDTgXcDG-RZylXDm8V5IbLkPLwodgX58n7dgRfFriHYz9DsZpqQtQWdNqn8A1TdTOE", "pending": 3, "results": [ { "changes": [ { "rev": "7-7a5191bfeb2f6eed6b3b6fa83f4810f5" } ], "deleted": true, "id": "0007741142412418284", "seq": "1-g1AAAAMFeJydkcENgjAUhquYePHqBN48EEBj4klXUOgAbSExDUJi8OwUrqDQJZyCJZhBqD8XE0Iiwulvmvf1e68vJITMToZPFj4X8SXY-3xjijC--ixKLMv-ns0oSEIUjxnhc0o9yUgTW_3GaojypVKZPBlsdMbdVFhbW6yd_15p2pwOG0SK77SuevcJSHP06rbILicgj0ul0t5OQBm_aV22yI5l1FAVTciR0ntfKzAXGOKJz-prBpYCQ7y1fg1wl8AQB0rzAW4MnCMeShUD3Bi4QGDTGrT8AMkPBk0" } ] } }, "CloudantSecurityConfiguration": { "description": "Example Cloudant Security document.", "value": { "cloudant": { "antsellseadespecteposene": [ "_reader", "_writer", "_admin" ], "garbados": [ "_reader", "_writer" ], "nobody": [ "_reader" ] } } }, "CorsConfiguration": { "description": "Example CorsConfiguration request.", "value": { "allow_credentials": true, "enable_cors": true, "origins": [ "https://example.com", "https://www.example.com" ] } }, "CurrentDatabasesInformation": { "value": { "databases": { "total": 42 } } }, "CurrentThroughputInformation": { "description": "Example CurrentThroughputInformation response.", "value": { "throughput": { "query": 13, "read": 133, "write": 42 } } }, "DatabaseInformation": { "description": "Example DatabaseInformation response.", "value": { "cluster": { "n": 3, "q": 8, "r": 2, "w": 2 }, "compact_running": false, "db_name": "products", "disk_format_version": 8, "doc_count": 5, "doc_del_count": 1, "instance_start_time": "0", "partitioned_indexes": { "count": 4, "indexes": { "search": 2, "view": 2 }, "limit": 10 }, "props": { "partitioned": true }, "purge_seq": "8-g1AAAALReJyd0T8OgjAUBvCKjq6ewM2BQPyz6hUUeoAWSExDIDE4ewqvoNBLeAouwRmE58diQprY4PR16C9f-17KGJufpzFbxjLKL8khljs3SvNrLLLC8_zv2c2SIsVlRzC54DxUwhmyzW_WIy5XWldKTEYV9kjLPVFnSFsnEEn0Bob0LRIolErrUgk2lGuLBKrkjag1pK0TqMtm7MT53XivpRUsAEM8MSxjN5YJg5VgiDfRa-xmwVowxJHz-o9ufLhGPLRujJltrRofbhDYNGFq6gOYofZj", "sizes": { "active": 8887, "external": 1872, "file": 685680 }, "update_seq": "89-g1AAAAIjeJzLYWBg4MhgTmHQTklKzi9KdUhJMtbLzCtJTS9KLMnMzysuSS0uMTAw1EvOyS9NScwr0ctLLckBamLKYwGSDA-A1H8gyErkRDXFkBRTDkBMuY9hihEppiyAmLI_K1GQAh81QEyZn5XIRZaPkhKAZFI9tjAh0jdJDiAT4rGZQKRPkhRAJtiDTRAkyxeJDEnyEAdkAQCgLLsf" } }, "DbUpdates": { "description": "Example DbUpdates response.", "value": { "last_seq": "1-g1AAAAMFeJydkcENgjAUhquYePHqBN48EEBj4klXUOgAbSExDUJi8OwUrqDQJZyCJZhBqD8XE0Iiwulvmvf1e68vJITMToZPFj4X8SXY-3xjijC--ixKLMv-ns0oSEIUjxnhc0o9yUgTW_3GaojypVKZPBlsdMbdVFhbW6yd_15p2pwOG0SK77SuevcJSHP06rbILicgj0ul0t5OQBm_aV22yI5l1FAVTciR0ntfKzAXGOKJz-prBpYCQ7y1fg1wl8AQB0rzAW4MnCMeShUD3Bi4QGDTGrT8AMkPBk0", "results": [ { "db_name": "events", "seq": "1-g1AAAAMFeJydkcENgjAUhquYePHqBN48EEBj4klXUOgAbSExDUJi8OwUrqDQJZyCJZhBqD8XE0Iiwulvmvf1e68vJITMToZPFj4X8SXY-3xjijC--ixKLMv-ns0oSEIUjxnhc0o9yUgTW_3GaojypVKZPBlsdMbdVFhbW6yd_15p2pwOG0SK77SuevcJSHP06rbILicgj0ul0t5OQBm_aV22yI5l1FAVTciR0ntfKzAXGOKJz-prBpYCQ7y1fg1wl8AQB0rzAW4MnCMeShUD3Bi4QGDTGrT8AMkPBk0", "type": "created" } ] } }, "DbsInfoQuery": { "description": "Example DbsInfoQuery request.", "value": { "keys": [ "products", "users", "orders" ] } }, "DbsInfoResults": { "description": "Example DbsInfoResults response.", "value": [ { "info": { "cluster": { "n": 3, "q": 1, "r": 1, "w": 1 }, "compact_running": false, "db_name": "products", "disk_format_version": 8, "doc_count": 5, "doc_del_count": 1, "instance_start_time": "0", "partitioned_indexes": { "count": 4, "indexes": { "search": 2, "view": 2 }, "limit": 10 }, "props": { "partitioned": true }, "purge_seq": "8-g1AAAALReJyd0T8OgjAUBvCKjq6ewM2BQPyz6hUUeoAWSExDIDE4ewqvoNBLeAouwRmE58diQprY4PR16C9f-17KGJufpzFbxjLKL8khljs3SvNrLLLC8_zv2c2SIsVlRzC54DxUwhmyzW_WIy5XWldKTEYV9kjLPVFnSFsnEEn0Bob0LRIolErrUgk2lGuLBKrkjag1pK0TqMtm7MT53XivpRUsAEM8MSxjN5YJg5VgiDfRa-xmwVowxJHz-o9ufLhGPLRujJltrRofbhDYNGFq6gOYofZj", "sizes": { "active": 8887, "external": 1872, "file": 685680 }, "update_seq": "89-g1AAAALReJyd0T8OgjAUBvCKjq6ewM2BQPyz6hUUeoAWSExDIDE4ewqvoNBLeAouwRmE58diQprY4PR16C9f-17KGJufpzFbxjLKL8khljs3SvNrLLLC8_zv2c2SIsVlRzC54DxUwhmyzW_WIy5XWldKTEYV9kjLPVFnSFsnEEn0Bob0LRIolErrUgk2lGuLBKrkjag1pK0TqMtm7MT53XivpRUsAEM8MSxjN5YJg5VgiDfRa-xmwVowxJHz-o9ufLhGPLRujJltrRofbhDYNGFq6gOYofZj" }, "key": "products" }, { "info": { "cluster": { "n": 3, "q": 8, "r": 2, "w": 2 }, "compact_running": false, "db_name": "users", "disk_format_version": 8, "doc_count": 11, "doc_del_count": 0, "instance_start_time": "0", "props": {}, "purge_seq": "8-g1AAAALReJyd0T8OgjAUBvCKjq6ewM2BQPyz6hUUeoAWSExDIDE4ewqvoNBLeAouwRmE58diQprY4PR16C9f-17KGJufpzFbxjLKL8khljs3SvNrLLLC8_zv2c2SIsVlRzC54DxUwhmyzW_WIy5XWldKTEYV9kjLPVFnSFsnEEn0Bob0LRIolErrUgk2lGuLBKrkjag1pK0TqMtm7MT53XivpRUsAEM8MSxjN5YJg5VgiDfRa-xmwVowxJHz-o9ufLhGPLRujJltrRofbhDYNGFq6gOYofZj", "sizes": { "active": 67475, "external": 2339, "file": 3872387 }, "update_seq": "13-g1AAAALReJyd0T8OgjAUBvCKjq6ewM2BQPyz6hUUeoAWSExDIDE4ewqvoNBLeAouwRmE58diQprY4PR16C9f-17KGJufpzFbxjLKL8khljs3SvNrLLLC8_zv2c2SIsVlRzC54DxUwhmyzW_WIy5XWldKTEYV9kjLPVFnSFsnEEn0Bob0LRIolErrUgk2lGuLBKrkjag1pK0TqMtm7MT53XivpRUsAEM8MSxjN5YJg5VgiDfRa-xmwVowxJHz-o9ufLhGPLRujJltrRofbhDYNGFq6gOYofZj" }, "key": "users" }, { "info": { "cluster": { "n": 3, "q": 8, "r": 2, "w": 2 }, "compact_running": false, "db_name": "orders", "disk_format_version": 8, "doc_count": 5, "doc_del_count": 0, "instance_start_time": "0", "props": {}, "purge_seq": "8-g1AAAALReJyd0T8OgjAUBvCKjq6ewM2BQPyz6hUUeoAWSExDIDE4ewqvoNBLeAouwRmE58diQprY4PR16C9f-17KGJufpzFbxjLKL8khljs3SvNrLLLC8_zv2c2SIsVlRzC54DxUwhmyzW_WIy5XWldKTEYV9kjLPVFnSFsnEEn0Bob0LRIolErrUgk2lGuLBKrkjag1pK0TqMtm7MT53XivpRUsAEM8MSxjN5YJg5VgiDfRa-xmwVowxJHz-o9ufLhGPLRujJltrRofbhDYNGFq6gOYofZj", "sizes": { "active": 44475, "external": 1339, "file": 133970 }, "update_seq": "13-g1AAAALReJyd0T8OgjAUBvCKjq6ewM2BQPyz6hUUeoAWSExDIDE4ewqvoNBLeAouwRmE58diQprY4PR16C9f-17KGJufpzFbxjLKL8khljs3SvNrLLLC8_zv2c2SIsVlRzC54DxUwhmyzW_WIy5XWldKTEYV9kjLPVFnSFsnEEn0Bob0LRIolErrUgk2lGuLBKrkjag1pK0TqMtm7MT53XivpRUsAEM8MSxjN5YJg5VgiDfRa-xmwVowxJHz-o9ufLhGPLRujJltrRofbhDYNGFq6gOYofZj" }, "key": "orders" } ] }, "DesignDocument": { "description": "Example DesignDocument.", "value": { "_id": "_design/appliances", "_rev": "8-7e2537e5989294471061e0cfd7292725", "indexes": { "findByPrice": { "analyzer": { "name": "standard" }, "index": "function (doc) {\n index(\"price\", doc.price);\n}" } }, "views": { "byApplianceProdId": { "map": "function(doc) {\n emit(doc.productId, [doc.brand, doc.name, doc.description])\n}" } } } }, "DesignDocumentInformation": { "description": "Example DesignDocumentInformation response.", "value": { "name": "appliances", "view_index": { "collator_versions": [ "153.72" ], "compact_running": false, "language": "javascript", "purge_seq": 0, "signature": "a85901c6c0c027ab8f319f9995b6d951", "sizes": { "active": 593, "external": 703, "file": 70340 }, "update_seq": 47, "updater_running": false, "updates_pending": { "minimum": 42, "preferred": 42, "total": 42 }, "waiting_clients": 0, "waiting_commit": false } } }, "DesignDocumentPartition": { "description": "Example DesignDocument for a database partition.", "value": { "_id": "_design/partitioned_appliances", "_rev": "8-7e2537e5989294471061e0cfd7292725", "indexes": { "findByBrand": { "analyzer": { "name": "standard" }, "index": "function (doc) {\n index(\"brand\", doc.brand);\n}" } }, "language": "javascript", "options": { "partitioned": true } } }, "Document": { "description": "Example Document.", "value": { "_id": "exampleid", "brand": "Foo", "colours": [ "red", "green", "black", "blue" ], "description": "Slim Colourful Design Electronic Cooking Appliance for ...", "image": "assets/img/0gmsnghhew.jpg", "keywords": [ "Foo", "Scales", "Weight", "Digital", "Kitchen" ], "name": "Digital Kitchen Scales", "price": 14.99, "productId": "1000042", "taxonomy": [ "Home", "Kitchen", "Small Appliances" ], "type": "product" } }, "DocumentMultipartRequest": { "description": "Example multipart request of document with attachments.", "value": { "document": { "_attachments": { "bar.txt": { "content_type": "text/plain", "follows": true, "length": 20 }, "foo.txt": { "content_type": "text/plain", "follows": true, "length": 21 } }, "body": "This is a body" }, "documentAttachments": [ "this is 21 chars long", "this is 20 chars lon" ] }, "x-raw-multipart": { "notes": "Raw multipart representation of the example", "value": "Content-Type: multipart/related;boundary=\"abc123\"\n\n--abc123\nContent-Type: application/json\n\n{\n \"body\": \"This is a body.\",\n \"_attachments\": {\n \"foo.txt\": {\n \"follows\": true,\n \"content_type\": \"text/plain\",\n \"length\": 21\n },\n \"bar.txt\": {\n \"follows\": true,\n \"content_type\": \"text/plain\",\n \"length\": 20\n }\n }\n}\n\n--abc123\n\nthis is 21 chars long\n--abc123\n\nthis is 20 chars lon\n--abc123--" } }, "DocumentMultipartResponse": { "description": "Example multipart response of document with attachments.", "value": { "document": { "_attachments": { "recipe.txt": { "content_type": "text/plain", "digest": "md5-HV9aXJdEnu0xnMQYTKgOFA==", "follows": true, "length": 86, "revpos": 2 } }, "_id": "secret", "_rev": "2-c1c6c44c4bc3c9344b037c8690468605" }, "documentAttachments": [ "1. Take R\n2. Take E\n3. Mix with L\n4. Add some A\n5. Serve with X" ] }, "x-raw-multipart": { "notes": "Raw multipart representation of the example", "value": "Content-Type: multipart/related; \\\nboundary=\"e89b3e29388aef23453450d10e5aaed0\"\n\n--e89b3e29388aef23453450d10e5aaed0\nContent-Type: application/json\n\n{\n\"_id\":\"secret\",\n\"_rev\":\"2-c1c6c44c4bc3c9344b037c8690468605\",\n\"_attachments\":{\n \"recipe.txt\":{\n \"content_type\":\"text/plain\",\n \"revpos\":2,\n \"digest\":\"md5-HV9aXJdEnu0xnMQYTKgOFA==\",\n \"length\":86,\n \"follows\":true}\n }\n}\n--e89b3e29388aef23453450d10e5aaed0\nContent-Disposition: attachment; filename=\"recipe.txt\"\nContent-Type: text/plain\nContent-Length: 86\n\n1. Take R\n2. Take E\n3. Mix with L\n4. Add some A\n5. Serve with X\n\n--e89b3e29388aef23453450d10e5aaed0--" } }, "DocumentResult": { "description": "Example DocumentResult for a creation.", "value": { "id": "exampleid", "ok": true, "rev": "2-056f5f44046ecafc08a2bc2b9c229e20" } }, "DocumentResultDeleted": { "description": "Example DocumentResult for a deletion.", "value": { "id": "exampleid", "ok": true, "rev": "3-056f5f44046ecafc08a2bc2b9c229e20" } }, "DocumentResultUpdated": { "description": "Example DocumentResult for an update.", "value": { "id": "exampleid", "ok": true, "rev": "2-9c65296036141e575d32ba9c034dd3ee" } }, "DocumentRevisions": { "description": "Example DocumentRevisions request.", "value": { "order00077": [ "3-b06fcd1c1c9e0ec7c480ee8aa467bf3b", "3-0e871ef78849b0c206091f1a7af6ec41" ] } }, "DocumentShardInfo": { "description": "Example document shard information response.", "value": { "nodes": [ "dbcore@db1.example", "dbcore@db2.example", "dbcore@db3.example" ], "range": "d0000000-dfffffff" } }, "EnsureFullCommitInformation": { "description": "Example EnsureFullCommitInformation response.", "value": { "instance_start_time": "0", "ok": true } }, "Error400AuthHeaderInvalid": { "description": "Example error response for an invalid base64 header value.", "summary": "Authorization header is invalid", "value": { "error": "bad_request", "reason": "Authorization header has invalid base64 value" } }, "Error400BadRequest": { "description": "Example error response for a bad request.", "summary": "Invalid request structure", "value": { "error": "bad_request", "reason": "Bad request." } }, "Error400CountParameterTooLarge": { "description": "Example error response for a bad request for too many UUIDs.", "summary": "Too many UUIDs requested", "value": { "error": "bad_request", "reason": "count parameter too large" } }, "Error400DatabaseDeletedWithRev": { "description": "Example error response for a bad request deleting a database with a document rev.", "summary": "Invalid parameter rev specified for operation", "value": { "error": "bad_request", "reason": "You tried to DELETE a database with a ?=rev parameter. Did you mean to DELETE a document instead?" } }, "Error400DbsInfoMissingKeys": { "description": "Example error response for a bad request missing keys.", "summary": "Missing keys parameter", "value": { "error": "bad_request", "reason": "`keys` member must exist." } }, "Error400InvalidDatabaseName": { "description": "Example error response for an invalid database name.", "summary": "Invalid database name", "value": { "error": "illegal_database_name", "reason": "Only lowercase characters (a-z), digits (0-9), and any of the characters _, $, (, ), +, -, and / are allowed. Must begin with a letter." } }, "Error400InvalidJson": { "description": "Example error response for a bad request with invalid UTF-8 JSON.", "summary": "Invalid JSON", "value": { "error": "bad_request", "reason": "invalid UTF-8 JSON" } }, "Error400InvalidPartition": { "description": "Example error response for a bad request with an invalid partition name.", "summary": "Invalid partition name", "value": { "error": "bad_request", "reason": "invalid_partition_req" } }, "Error400NotSupportedOption": { "description": "Example error response for a bad request with an unsupported option.", "summary": "Unsupported option", "value": { "error": "bad_request", "reason": "`partition` is not supported on this search index" } }, "Error401AdminPrivilegesRequired": { "description": "Example error response for administrator privileges required.", "summary": "Admin privileges are required", "value": { "error": "unauthorized", "reason": "You are not a server admin." } }, "Error401ReaderPrivilegesRequired": { "description": "Example error response for reader access is required for this request.", "summary": "Reader access is required", "value": { "error": "unauthorized", "reason": "_reader access is required for this request." } }, "Error401Unauthorized": { "description": "Example error response for incorrect credentials.", "summary": "Incorrect credentials", "value": { "error": "unauthorized", "reason": "Name or password is incorrect." } }, "Error401WriterOrCreatorPrivilegesRequired": { "description": "Example error response for writer or creator access is required.", "summary": "Writer or creator access is required", "value": { "error": "unauthorized", "reason": "one of _writer, _creator is required for this request." } }, "Error401WriterPrivilegesRequired": { "description": "Example error response for writer access is required.", "summary": "Writer access is required", "value": { "error": "unauthorized", "reason": "_writer access is required for this request." } }, "Error402OverDataQuota": { "description": "Example error response when the data quota of the plan is exceeded.\n", "summary": "Data is over quota", "value": { "error": "over_data_quota", "reason": "Account has exceeded its data usage quota. An upgrade to a paid plan is required." } }, "Error402PaymentRequired": { "description": "Example error response when payment is required.\nFor example, if the data quota of the plan is exceeded.\n", "summary": "Payment is required", "value": { "error": "payment_required", "reason": "Payment required" } }, "Error403Forbidden": { "description": "Example error response for a forbidden request.", "summary": "Access is forbidden", "value": { "error": "forbidden", "reason": "server_admin access is required for this request" } }, "Error403TempAccountLockout": { "description": "Example error response for an account temporarily locked out.", "summary": "Account is temporarily locked", "value": { "error": "forbidden", "reason": "Account is temporarily locked due to multiple authentication failures" } }, "Error404DatabaseDoesNotExist": { "description": "Example error response for a database does not exist.", "summary": "Database not found", "value": { "error": "not_found", "reason": "Database does not exist." } }, "Error404DocumentDoesNotExist": { "description": "Example error response for a document ID does not exist.", "summary": "Document not found", "value": { "error": "not_found", "reason": "missing" } }, "Error404MissingNamedView": { "description": "Example error response for a missing view.", "summary": "Missing named view", "value": { "error": "not_found", "reason": "missing_named_view" } }, "Error404NotFound": { "description": "Example error response for a not found request.", "summary": "The requested path was not found", "value": { "error": "not_found", "reason": "missing" } }, "Error408RequestTimeout": { "description": "Example error response for timeout reading client request.", "summary": "Request timeout", "value": { "error": "request_timeout", "reason": "Request timeout" } }, "Error409DocumentConflict": { "description": "Example error response for a document update conflict.", "summary": "Document update conflict", "value": { "error": "conflict", "reason": "Document update conflict." } }, "Error410Gone": { "description": "Example error response for gone.", "summary": "Requested resource is no longer available", "value": { "error": "gone", "reason": "The requested resource is no longer located here, verify your DNS settings." } }, "Error412DatabaseAlreadyExists": { "description": "Example error response for a database already existing.", "summary": "Database already exits", "value": { "error": "file_exists", "reason": "The database could not be created, the file already exists." } }, "Error413AttachmentTooLarge": { "description": "Example error response for a request with an attachment size that\nexceeds the allowable limit.\n", "summary": "Attachment too large", "value": { "error": "attachment_too_large", "reason": "attachment_name" } }, "Error413DocumentTooLarge": { "description": "Example error response for a request with a document size that exceeds\nthe allowable limit.\n", "summary": "Document too large", "value": { "error": "document_too_large", "reason": "doc_id" } }, "Error413TooLarge": { "description": "Example error response for a request size that exceeds the limit.", "summary": "Request is too large", "value": { "error": "too_large", "reason": "the request entity is too large" } }, "Error415UnsupportedMediaType": { "description": "Example error response for unsupported media type.", "summary": "Unsupported media type", "value": { "error": "bad_content_type", "reason": "Content-Type must be application/json" } }, "Error416RangeNotSatisfiable": { "description": "Example error response for requested range not satisfiable.", "summary": "Range not satisfiable", "value": { "error": "requested_range_not_satisfiable", "reason": "Requested range not satisfiable" } }, "Error429TooManyRequests": { "description": "Example error response for too many requests.", "summary": "Rate limit allowance is over quota", "value": { "error": "too_many_requests", "reason": "You've exceeded your rate limit allowance. Please try again later." } }, "Error500UnknownError": { "description": "Example error response for an unknown server error.", "summary": "Unknown server error", "value": { "error": "unknown_error", "reason": "function_clause", "ref": 2632214382 } }, "Error502BadGateway": { "description": "Example error response for bad gateway.", "summary": "Bad gateway", "value": { "error": "bad_gateway", "reason": "Bad gateway" } }, "Error503ServiceUnavailable": { "description": "Example error response for service unavailable.", "summary": "Service is unavailable", "value": { "error": "service_unavailable", "reason": "Service unavailable" } }, "Error504GatewayTimeout": { "description": "Example error response for gateway timeout.", "summary": "Gateway timeout", "value": { "error": "gateway_timeout", "reason": "Gateway timeout" } }, "Error507InsufficientStorage": { "description": "Example error response for insufficient storage.", "summary": "Insufficient storage", "value": { "error": "insufficient_storage", "reason": "database_dir is too full" } }, "ExplainResult": { "description": "Example ExplainResult response.", "value": { "covering": false, "dbname": "users", "fields": [ "surname", "email" ], "index": { "ddoc": "_design/id-index", "def": { "fields": [ { "_id": "asc" } ] }, "name": "d479bdddf50865e520a0193704c8b93a3bd48f77", "type": "json" }, "index_candidates": [ { "analysis": { "covering": null, "ranking": 1, "reasons": [ { "name": "unfavored_type" } ], "usable": false }, "index": { "ddoc": null, "def": { "fields": [ { "_id": "asc" } ] }, "name": "_all_docs", "type": "special" } }, { "analysis": { "covering": false, "ranking": 2, "reasons": [ { "name": "field_mismatch" } ], "usable": false }, "index": { "ddoc": "_design/json-index", "def": { "fields": [ { "name": "asc" } ] }, "name": "getUserByName", "partitioned": false, "type": "json" } } ], "limit": 10, "mrargs": { "conflicts": "undefined", "direction": "fwd", "end_key": [ "" ], "include_docs": true, "partition": null, "reduce": false, "stable": false, "start_key": [], "update": true, "view_type": "map" }, "opts": { "bookmark": "nil", "conflicts": false, "execution_stats": true, "fields": [], "limit": 10, "partition": "", "r": 1, "skip": 0, "sort": {}, "stable": false, "stale": false, "update": false, "use_index": [] }, "partitioned": true, "selector": { "type": { "$eq": "user" } }, "selector_hints": [ { "indexable_fields": [ "email" ], "type": "json", "unindexable_fields": [ "surname" ] } ], "skip": 0 } }, "FindQuery": { "description": "Example FindQuery request.", "value": { "fields": [ "_id", "type", "name", "email" ], "limit": 3, "selector": { "email_verified": { "$eq": true } } } }, "FindResult": { "description": "Example FindResult response.", "value": { "bookmark": "g1AAAABCeJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzJSYlGxoZg2Q5YLI5QHFGJMmsLABByhEQ", "docs": [ { "_id": "exampleid", "description": "A professional, high powered innovative kitchen tool", "email": "amelie.smith@aol.com", "name": "Amelie Smith", "productId": "1000043", "productName": "1100", "type": "user" }, { "_id": "exampleid2", "description": "New and improved kitchen blender", "email": "bob.smith@aol.com", "name": "Bob Smith", "productId": "1000044", "productName": "Pro System 3000", "type": "user" } ], "execution_stats": { "execution_time_ms": 4.37, "results_returned": 2, "total_docs_examined": 4, "total_keys_examined": 0, "total_quorum_docs_examined": 0 } } }, "FindResultPartition": { "description": "Example FindResult response for a database partition.", "value": { "bookmark": "g1AAAABgeJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYpLFOcm5uToJhYU5GQm5iWnFlsZGgCBiQlIPQdMPV6VWQBXehzX", "docs": [ { "description": "Slim Colourful Design Electronic Cooking...", "name": "Digital Kitchen Scales", "productId": "1000042" }, { "description": "Easily make delicious and fluffy omelets...", "name": "Housewares Omelet Maker", "productId": "1000044" } ], "warning": "No matching index found, create an index to optimize query time." } }, "IamSessionConfiguration": { "description": "Example IamSessionConfiguration request.", "value": { "access_token": "a2.b3.c4" } }, "IamSessionInformation": { "description": "Example IamSessionInformation response.", "value": { "id": "abc-123", "ok": true, "scope": "ibm openid", "type": "user" } }, "IndexConfiguration": { "description": "Example IndexConfiguration request.", "value": { "ddoc": "json-index", "index": { "fields": [ { "name": "asc" } ] }, "name": "getUserByName", "type": "json" } }, "IndexResult": { "description": "Example IndexResult response.", "value": { "id": "_design/json-index", "name": "getUserByName", "result": "created" } }, "IndexesInformation": { "description": "Example IndexInformation response.", "value": { "indexes": [ { "ddoc": null, "def": { "fields": [ { "_id": "asc" } ] }, "name": "_all_docs", "type": "special" }, { "ddoc": "_design/json-index", "def": { "fields": [ { "name": "asc" } ] }, "name": "getUserByName", "partitioned": false, "type": "json" } ], "total_rows": 2 } }, "MembershipInformation": { "description": "Example MembershipInformation response.", "value": { "all_nodes": [ "node1@127.0.0.1", "node2@127.0.0.1", "node3@127.0.0.1" ], "cluster_nodes": [ "node1@127.0.0.1", "node2@127.0.0.1", "node3@127.0.0.1" ] } }, "MissingRevsResult": { "description": "Example MissingRevsResult response.", "value": { "missing_revs": { "order00077": [ "2-b06fcd1c1c9e0ec7c480ee8aa467bf3b" ] } } }, "NodeStatsInformation": { "description": "Example NodeStatsInformation response.", "value": { "couch_log": {}, "couch_replicator": {}, "couchdb": {}, "dbcopy": {}, "ddoc_cache": {}, "dreyfus": {}, "fabric": {}, "global_changes": { "db_writes": { "desc": "number of db writes performed by global changes", "type": "counter", "value": 95100 }, "event_doc_conflict": { "desc": "number of conflicted event docs encountered by global changes", "type": "counter", "value": 0 }, "listener_pending_updates": { "desc": "number of global changes updates pending writes in global_changes_listener", "type": "gauge", "value": 0 }, "rpcs": { "desc": "number of rpc operations performed by global_changes", "type": "counter", "value": 340161 }, "server_pending_updates": { "desc": "number of global changes updates pending writes in global_changes_server", "type": "gauge", "value": 0 } }, "mango": { "docs_examined": { "desc": "number of documents examined by mango queries coordinated by this node", "type": "counter", "value": 0 }, "evaluate_selector": { "desc": "number of mango selector evaluations", "type": "counter", "value": 0 }, "query_invalid_index": { "desc": "number of mango queries that generated an invalid index warning", "type": "counter", "value": 0 }, "query_time": { "desc": "length of time processing a mango query", "type": "histogram", "value": {} }, "quorum_docs_examined": { "desc": "number of documents examined by mango queries, using cluster quorum", "type": "counter", "value": 0 }, "results_returned": { "desc": "number of rows returned by mango queries", "type": "counter", "value": 0 }, "too_many_docs_scanned": { "desc": "number of mango queries that generated an index scan warning", "type": "counter", "value": 0 }, "unindexed_queries": { "desc": "number of mango queries that could not use an index", "type": "counter", "value": 0 } }, "mem3": { "shard_cache": { "eviction": { "desc": "number of shard cache evictions", "type": "counter", "value": 58040 }, "hit": { "desc": "number of shard cache hits", "type": "counter", "value": 209241424 }, "miss": { "desc": "number of shard cache misses", "type": "counter", "value": 105016 } } }, "pread": {}, "rexi": {} } }, "NodeSystemInformation": { "description": "Example NodeSystemInformation response.", "value": { "context_switches": 62570, "distribution": { "clouseau@192.0.2.3": { "recv_avg": 59, "recv_cnt": 201145, "recv_dvi": 3, "recv_max": 1092, "recv_oct": 11915505, "send_avg": 150, "send_cnt": 517599, "send_max": 645, "send_oct": 78061898, "send_pend": 0 }, "node1@192.0.2.1": { "recv_avg": 2368, "recv_cnt": 153463822, "recv_dvi": 47, "recv_max": 3829916, "recv_oct": 363548809101, "send_avg": 2538, "send_cnt": 141966830, "send_max": 3829916, "send_oct": 360332607798, "send_pend": 0 }, "node2@192.0.2.2": { "recv_avg": 2368, "recv_cnt": 153463822, "recv_dvi": 47, "recv_max": 3829916, "recv_oct": 363548809101, "send_avg": 2538, "send_cnt": 141966830, "send_max": 3829916, "send_oct": 360332607798, "send_pend": 0 } }, "ets_table_count": 177, "garbage_collection_count": 5897, "internal_replication_jobs": 0, "io_input": 244, "io_output": 6582, "memory": { "atom": 590033, "atom_used": 579683, "binary": 132304, "code": 12953030, "ets": 1893128, "other": 14750185, "processes": 9127336, "processes_used": 9125960 }, "message_queues": { "alarm_handler": 0, "application_controller": 0, "chttpd": 0, "chttpd_auth_cache": 0, "chttpd_auth_cache_lru": 0, "chttpd_sup": 0, "code_server": 0, "config": 0, "config_event": 0, "config_sup": 0, "couch_db_updater": { "50": 0, "90": 0, "99": 0, "count": 40, "max": 0, "min": 0 }, "couch_epi_data_gen_dreyfus_black_list": 0, "couch_epi_data_gen_flags_config": 0, "couch_epi_functions_gen_chttpd": 0, "couch_epi_functions_gen_chttpd_auth": 0, "couch_epi_functions_gen_chttpd_handlers": 0, "couch_epi_functions_gen_couch_db": 0, "couch_epi_functions_gen_couch_index": 0, "couch_epi_functions_gen_feature_flags": 0, "couch_epi_functions_gen_global_changes": 0, "couch_epi_sup": 0, "couch_event_server": 0, "couch_event_sup2": 0, "couch_file": { "50": 0, "90": 0, "99": 0, "count": 43, "max": 0, "min": 0 }, "couch_httpd_vhost": 0, "couch_index_sup": 0, "couch_log_server": 0, "couch_log_sup": 0, "couch_password_hasher": 0, "couch_peruser": 0, "couch_peruser_sup": 0, "couch_plugin": 0, "couch_primary_services": 0, "couch_proc_manager": 0, "couch_prometheus_server": 0, "couch_prometheus_sup": 0, "couch_replication": 0, "couch_replicator_clustering": 0, "couch_replicator_connection": 0, "couch_replicator_doc_processor": 0, "couch_replicator_pg": 0, "couch_replicator_rate_limiter": 0, "couch_replicator_scheduler": 0, "couch_replicator_scheduler_sup": 0, "couch_replicator_sup": 0, "couch_secondary_services": 0, "couch_server": 0, "couch_server_1": 0, "couch_server_2": 0, "couch_server_3": 0, "couch_server_4": 0, "couch_server_5": 0, "couch_server_6": 0, "couch_server_7": 0, "couch_server_8": 0, "couch_stats_aggregator": 0, "couch_stats_process_tracker": 0, "couch_stats_sup": 0, "couch_sup": 0, "couch_task_status": 0, "couch_uuids": 0, "custodian_db_checker": 0, "custodian_server": 0, "custodian_sup": 0, "ddoc_cache_lru": 0, "ddoc_cache_sup": 0, "dreyfus_index_manager": 0, "dreyfus_sup": 0, "dtls_connection_sup": 0, "dtls_listener_sup": 0, "dtls_server_session_cache_sup": 0, "dtls_server_sup": 0, "dtls_sup": 0, "erl_prim_loader": 0, "erl_signal_server": 0, "error_logger": 0, "erts_code_purger": 0, "file_server_2": 0, "folsom_meter_timer_server": 0, "folsom_metrics_histogram_ets": 0, "folsom_sample_slide_sup": 0, "folsom_sup": 0, "global_changes_server": 0, "global_changes_sup": 0, "global_group": 0, "global_name_server": 0, "httpc_handler_sup": 0, "httpc_manager": 0, "httpc_profile_sup": 0, "httpc_sup": 0, "httpd_sup": 0, "ibrowse": 0, "ibrowse_sup": 0, "index_server": 0, "index_server_1": 0, "index_server_2": 0, "index_server_3": 0, "index_server_4": 0, "index_server_5": 0, "index_server_6": 0, "index_server_7": 0, "index_server_8": 0, "inet_db": 0, "inets_sup": 0, "init": 0, "ioq": 0, "ioq_sup": 0, "jwtf_keystore": 0, "jwtf_sup": 0, "ken_server": 0, "ken_sup": 0, "kernel_refc": 0, "kernel_safe_sup": 0, "kernel_sup": 0, "logger": 0, "logger_handler_watcher": 0, "logger_proxy": 0, "logger_std_h_ssl_handler": 0, "logger_sup": 0, "mango_sup": 0, "mem3_distribution": 0, "mem3_events": 0, "mem3_nodes": 0, "mem3_reshard": 0, "mem3_reshard_dbdoc": 0, "mem3_reshard_job_sup": 0, "mem3_reshard_sup": 0, "mem3_seeds": 0, "mem3_shards": 0, "mem3_sup": 0, "mem3_sync": 0, "mem3_sync_nodes": 0, "mochiweb_clock": 0, "release_handler": 0, "rex": 0, "rexi_buffer_mon": 0, "rexi_buffer_nonode@nohost": 0, "rexi_buffer_sup": 0, "rexi_server": 0, "rexi_server_mon": 0, "rexi_server_nonode@nohost": 0, "rexi_server_sup": 0, "rexi_sup": 0, "runtime_tools_sup": 0, "sasl_safe_sup": 0, "sasl_sup": 0, "setup_sup": 0, "smoosh_server": 0, "smoosh_sup": 0, "socket_registry": 0, "ssl_admin_sup": 0, "ssl_connection_sup": 0, "ssl_listen_tracker_sup": 0, "ssl_manager": 0, "ssl_pem_cache": 0, "ssl_server_session_cache_sup": 0, "ssl_sup": 0, "ssl_upgrade_server_session_cache_sup": 0, "standard_error": 0, "standard_error_sup": 0, "timer_server": 0, "tls_client_ticket_store": 0, "tls_connection_sup": 0, "tls_server_session_ticket_sup": 0, "tls_server_sup": 0, "tls_sup": 0, "user": 0 }, "os_proc_count": 0, "process_count": 374, "process_limit": 262144, "reductions": 23271197, "run_queue": 0, "run_queue_dirty_cpu": 0, "stale_proc_count": 0, "uptime": 42, "words_reclaimed": 20305358 } }, "Ok": { "description": "Example Ok response.", "value": { "ok": true } }, "PartitionFindQuery": { "description": "Example PartitionFindQuery request.", "value": { "fields": [ "productId", "name", "description" ], "selector": { "type": { "$eq": "product" } } } }, "PartitionInformation": { "description": "Example PartitionInformation response.", "value": { "db_name": "products", "doc_count": 3, "doc_del_count": 1, "partition": "small-appliances", "partitioned_indexes": { "count": 1, "indexes": { "search": 0, "view": 1 }, "limit": 10 }, "sizes": { "active": 1539, "external": 1286 } } }, "ReplicationDocument": { "description": "Example ReplicationDocument request.", "value": { "cancel": false, "checkpoint_interval": 4500, "connection_timeout": 15000, "continuous": true, "create_target": true, "create_target_params": { "q": 1 }, "doc_ids": [ "badger", "lemur", "llama" ], "filter": "ddoc/my_filter", "http_connections": 10, "retries_per_request": 3, "selector": { "_id": { "$regex": "docid" } }, "since_seq": "34-g1AAAAGjeJzLYWBgYMlgTmGQT0lKzi9KdU", "socket_options": "[{keepalive, true}, {nodelay, false}]", "source": { "url": "https://my-source-instance.cloudantnosqldb.appdomain.cloud.example/animaldb" }, "target": { "auth": { "iam": { "api_key": "iam_api_key" } }, "url": "https://my-target-instance.cloudantnosqldb.appdomain.cloud.example/animaldb-target" }, "use_checkpoints": false, "user_ctx": { "name": "john", "roles": [ "_replicator" ] }, "worker_batch_size": 400, "worker_processes": 3 } }, "ReplicationInformation": { "description": "Example ReplicationInformation response.", "value": { "_local_id": "460b3a44135318afce548ec26b604e6f+continuous", "ok": true } }, "ReplicationResult": { "description": "Example ReplicationResult response.", "value": { "history": [ { "doc_write_failures": 0, "docs_read": 10, "docs_written": 10, "end_last_seq": "28-abcdefghijklmnopqrstuvwxyz", "end_time": "Sun, 11 Aug 2019 20:38:50 GMT", "missing_checked": 10, "missing_found": 10, "recorded_seq": "28-abcdefghijklmnopqrstuvwxyz", "session_id": "142a35854a08e205c47174d91b1f9628", "start_last_seq": "1-abcdefghijklmnopqrstuvwxyz", "start_time": "Sun, 11 Aug 2019 20:38:50 GMT" } ], "ok": true, "replication_id_version": 3, "session_id": "142a35854a08e205c47174d91b1f9628", "source_last_seq": "28-abcdefghijklmnopqrstuvwxyz" } }, "ReshardInformation": { "description": "Example ReshardInformation response.", "value": { "completed": 3, "failed": 4, "running": 0, "state": "stopped", "state_reason": "Manual rebalancing.", "stopped": 0, "total": 7 } }, "ReshardJobInformation": { "description": "Example ReshardJobInformation response.", "value": { "history": [ { "detail": null, "timestamp": "2019-02-06T22:28:06Z", "type": "new" }, { "detail": null, "timestamp": "2019-02-06T22:28:10Z", "type": "completed" } ], "id": "001-0a308ef9f7bd24bd4887d6e619682a6d3bb3d0fd94625866c5216ec1167b4e23", "job_state": "completed", "node": "node1@127.0.0.1", "source": "shards/00000000-ffffffff/db1.1549492084", "split_state": "completed", "start_time": "2019-02-06T22:28:06Z", "state_info": {}, "target": [ "shards/00000000-7fffffff/db1.1549492084", "shards/80000000-ffffffff/db1.1549492084" ], "type": "split", "update_time": "2019-02-06T22:28:10Z" } }, "ReshardJobsConfiguration": { "description": "Example ReshardJobs request.", "value": { "db": "db1", "node": "node1@127.0.0.1", "range": "80000000-bfffffff", "type": "split" } }, "ReshardJobsInformation": { "description": "Example ReshardJobsInformation response.", "value": { "jobs": [ { "history": [ { "detail": null, "timestamp": "2019-02-06T22:28:06Z", "type": "new" }, { "detail": null, "timestamp": "2019-02-06T22:28:10Z", "type": "completed" } ], "id": "001-0a308ef9f7bd24bd4887d6e619682a6d3bb3d0fd94625866c5216ec1167b4e23", "job_state": "completed", "node": "node1@127.0.0.1", "source": "shards/00000000-ffffffff/db1.1549492084", "split_state": "completed", "start_time": "2019-02-06T22:28:06Z", "state_info": {}, "target": [ "shards/00000000-7fffffff/db1.1549492084", "shards/80000000-ffffffff/db1.1549492084" ], "type": "split", "update_time": "2019-02-06T22:28:10Z" } ], "offset": 0, "total_rows": 1 } }, "ReshardJobsResult": { "description": "Example postReshardJobsConfiguration response.", "value": [ { "id": "001-30d7848a6feeb826d5e3ea5bb7773d672af226fd34fd84a8fb1ca736285df557", "node": "node1@127.0.0.1", "ok": true, "shard": "shards/80000000-ffffffff/db3.1554148353" }, { "id": "001-40d7848a6feeb826d5e3ea5bb7773d672af226fd34fd84a8fb1ca736285df600", "node": "node2@127.0.0.1", "ok": true, "shard": "shards/80000000-ffffffff/db3.1554148353" } ] }, "ReshardStateCluster": { "description": "Example request or response body for the state of cluster resharding.", "value": { "reason": "Pause resharding across the cluster.", "state": "stopped" } }, "ReshardStateJob": { "description": "Example request or response body for the state of a reshard job.", "value": { "reason": "Pause this job for now.", "state": "stopped" } }, "RevsDiffResult": { "description": "Example RevsDiffResult response.", "value": { "order00077": { "missing": [ "3-bb72a7682290f94a985f7afac8b27137", "5-067a00dff5e02add41819138abb3284d" ], "possible_ancestors": [ "4-10265e5a26d807a3cfa459cf1a82ef2e" ] } } }, "RevsLimit": { "description": "Example RevsLimit response.", "value": 1000 }, "SchedulerDocsResult": { "description": "Example SchedulerDocsResult response.", "value": { "docs": [ { "database": "_replicator", "doc_id": "repldoc-example", "error_count": 0, "id": null, "info": { "changes_pending": null, "checkpointed_source_seq": "14-g1AAAAGjeJzLYWBgYMlgTmGQT0lKzi9KdUhJMtFLykxPyilN1UvOyS9NScwr0ctLLckBKmRKZEiy____f1YGcyJrLlCAPS3RKM0wOZWwdlQrDHFbkeQAJJPqobYwgm2xMDIzTUuxJGwCqi2muG3JYwGSDA1ACmjRfoR_Uo2NUxOTzQmbQrR_IDYdgNgE9hMz2CZLc9MkC4tkwqZkAQCT-Yfn", "doc_write_failures": 0, "docs_read": 15, "docs_written": 15, "missing_revisions_found": 15, "revisions_checked": 15 }, "last_updated": "2020-06-04T20:05:30Z", "source": "https://my-source-instance.cloudantnosqldb.appdomain.cloud.example/animaldb/", "start_time": "2020-06-04T20:05:24Z", "state": "completed", "target": "https://my-target-instance.cloudantnosqldb.appdomain.cloud.example/animaldb-target/" } ], "offset": 0, "total_rows": 1 } }, "SchedulerDocument": { "description": "Example SchedulerDocResult response.", "value": { "database": "_replicator", "doc_id": "repldoc-example", "error_count": 0, "id": null, "info": { "changes_pending": null, "checkpointed_source_seq": "14-g1AAAAGjeJzLYWBgYMlgTmGQT0lKzi9KdUhJMtFLykxPyilN1UvOyS9NScwr0ctLLckBKmRKZEiy____f1YGcyJrLlCAPS3RKM0wOZWwdlQrDHFbkeQAJJPqobYwgm2xMDIzTUuxJGwCqi2muG3JYwGSDA1ACmjRfoR_Uo2NUxOTzQmbQrR_IDYdgNgE9hMz2CZLc9MkC4tkwqZkAQCT-Yfn", "doc_write_failures": 0, "docs_read": 15, "docs_written": 15, "missing_revisions_found": 15, "revisions_checked": 15 }, "last_updated": "2017-04-29T05:01:37.000Z", "source": "https://my-source-instance.cloudantnosqldb.appdomain.cloud.example/animaldb/", "start_time": "2020-06-04T20:05:24Z", "state": "completed", "target": "https://my-target-instance.cloudantnosqldb.appdomain.cloud.example/animaldb-target/" } }, "SchedulerJob": { "description": "Example SchedulerJob response.", "value": { "database": "_replicator", "doc_id": "15972f3ef583b3cd6b6620ae4a91b6c5", "history": [ { "timestamp": "2022-04-29T05:01:37Z", "type": "started" }, { "timestamp": "2022-04-29T05:01:37Z", "type": "added" } ], "id": "935c58f9ff98aabe5340d8cb8946f5ca+create_target", "info": { "changes_pending": null, "checkpointed_source_seq": "1-g1AAAARheJzLYWBgEMhgTmHQTElKzi9KdUhJMtJLyt__VNTtYtLdYtzi8tydA1stBLzskvTUnMK9HLSy3JAWphSmRI4v", "doc_write_failures": 0, "docs_read": 2710, "docs_written": 2710, "missing_revisions_found": 12, "revisions_checked": 12, "source_seq": "1037-g1AAAACTeJzLYWBgYMpgTmHgz8tPSTV0MDQy1zMAQsMckEQiQ1L9___szKYE1lzgQLsBsZm5pZJJpjKcRqRxwIkGRqA1H-oSexgk4yMkhITjS0wdWUBADfEJBg", "through_seq": "667-g1AAAACTeJzLYWBgYMpgTmHgz8tPSTV0MDQy1zMAQsMckEQiQ1L9____szKYE1lzgQLsBsZm5pZJJpjKcRqRxwIkGRqA1H-oSexgk4yMkhITjS0wdWUBADfEJB" }, "node": "node1@127.0.0.1", "pid": "<0.1850.0>", "source": "https://mysourceserver.example/db/", "start_time": "2017-04-29T05:01:37Z", "target": "https://mytargetserver.example/mydb/", "user": null } }, "SchedulerJobsResult": { "description": "Example SchedulerJobsResult response.", "value": { "jobs": [ { "database": "_replicator", "doc_id": "cdyno-0000001-0000003", "history": [ { "timestamp": "2017-04-29T05:01:37Z", "type": "started" }, { "timestamp": "2017-04-29T05:01:37Z", "type": "added" } ], "id": "8f5b1bd0be6f9166ccfd36fc8be8fc22+continuous", "info": { "changes_pending": null, "checkpointed_source_seq": "1-g1AAAARheJzLYWBgEMhgTmHQTElKzi9KdUhJMtJLytVNTtYtLdYtzi8tydA1stBLzskvTUnMK9HLSy3JAWphSmRI4v", "doc_write_failures": 0, "docs_read": 12, "docs_written": 12, "missing_revisions_found": 12, "revisions_checked": 12, "source_seq": "12-g1AAAACTeJzLYWBgYMpgTmHgz8tPSTV0MDQy1zMAQsMckEQiQ1L9____szKYE1lzgQLsBsZm5pZJJpjKcRqRxwIkGRqA1H-oSexgk4yMkhITjS0wdWUBADfEJBg", "through_seq": "12-g1AAAACTeJzLYWBgYMpgTmHgz8tPSTV0MDQy1zMAQsMckEQiQ1L9____szKYE1lzgQLsBsZm5pZJJpjKcRqRxwIkGRqA1H-oSexgk4yMkhITjS0wdWUBADfEJBg" }, "node": "node1@127.0.0.1", "pid": "<0.1850.0>", "source": "https://mysourceserver.example/db/", "start_time": "2017-04-29T05:01:37Z", "target": "https://mytargetserver.example/mydb3/", "user": null }, { "database": "_replicator", "doc_id": "cdyno-0000001-0000002", "history": [ { "timestamp": "2017-04-29T05:01:37Z", "type": "started" }, { "timestamp": "2017-04-29T05:01:37Z", "type": "added" } ], "id": "e327d79214831ca4c11550b4a453c9ba+continuous", "info": { "changes_pending": null, "checkpointed_source_seq": "1-g1AAAASbeJzLYWBgEMhgTmHQTElKzi9KdUhJMtJLytVNTtYtLdYtzi8tydA1stBLzskvTUnMK9HLSy3JAWphSmRI4v", "doc_write_failures": 0, "docs_read": 12, "docs_written": 12, "missing_revisions_found": 12, "revisions_checked": 12, "source_seq": "12-g1AAAACTeJzLYWBgYMpgTmHgz8tPSTV0MDQy1zMAQsMckEQiQ1L9____szKYE1lzgQLsBsZm5pZJJpjKcRqRxwIkGRqA1H-oSexgk4yMkhITjS0wdWUBADfEJBg", "through_seq": "12-g1AAAACTeJzLYWBgYMpgTmHgz8tPSTV0MDQy1zMAQsMckEQiQ1L9____szKYE1lzgQLsBsZm5pZJJpjKcRqRxwIkGRqA1H-oSexgk4yMkhITjS0wdWUBADfEJBg" }, "node": "node2@127.0.0.1", "pid": "<0.1757.0>", "source": "https://mysourceserver.example/db/", "start_time": "2017-04-29T05:01:37Z", "target": "https://mytargetserver.example/mydb2/", "user": null } ], "offset": 0, "total_rows": 2 } }, "SearchAnalyzeQuery": { "description": "Example SearchAnalyzeQuery request.", "value": { "analyzer": "english", "text": "running is fun" } }, "SearchAnalyzeResult": { "description": "Example SearchAnalyzeResult response.", "value": { "tokens": [ "run", "fun" ] } }, "SearchDiskSizeInformation": { "description": "Example SearchDiskSizeInformation response.", "value": { "name": "_design/appliances/findByPrice", "search_index": { "disk_size": 2889 } } }, "SearchInfoResult": { "description": "Example SearchInfoResult response.", "value": { "name": "_design/appliances/findByPrice", "search_index": { "committed_seq": 47, "disk_size": 2889, "doc_count": 3, "doc_del_count": 0, "pending_seq": 47, "signature": "bedc44e56c2ba97902aeaac2b51ad77c" } } }, "SearchQuery": { "description": "Example SearchQuery request.", "value": { "limit": 3, "query": "name:Jane* AND active:True" } }, "SearchResult": { "description": "Example SearchResult response.", "value": { "bookmark": "g2wAAAEPeJzLYWBgYMlgTmGQT0lKzi9KdUhJMtFLykxPyilN1UvOyS9NScwr0ctLLckBKmRKZEiy____f1YGk5v9iztMQCGGRGZU3Wa4dSc5AMmkepgBlxdXgQ1gINr6PBaQhgYgBTRjP9iQDwxgkMhEtCsghhyAGAJxybeak2BDGLMAi8FWFQ", "rows": [ { "fields": {}, "id": "exampleid", "order": [ "0.8410536050796509", "1" ] } ], "total_rows": 1 } }, "SearchResultPartition": { "description": "Example SearchResult response for a database partition.", "value": { "bookmark": "g1AAAAEPeJzLYWBgYMlgTmGQT0lKzi9KdUhJMtFLykxPyilN1UvOyS9NScwr0ctLLckBKmRKZEiy____f1YGk5v9iztMQCGGRGZU3Wa4dSc5AMmkepgBlxdXgQ1gINr6PBaQhgYgBTRjP9iQDwxgkMhEtCsghhyAGAJxybeak2BDGLMAi8FWFQ", "rows": [ { "fields": {}, "id": "small-appliances:1000042", "order": [ "1.2277607917785645", "0" ] } ], "total_rows": 1 } }, "Security": { "description": "Example Security document.", "value": { "admins": { "names": [ "superuser" ], "roles": [ "admins" ] }, "cloudant": { "antsellseadespecteposene": [ "_reader", "_writer", "_admin" ] }, "members": { "names": [ "user1", "user2" ], "roles": [ "developers" ] } } }, "SecurityResult": { "description": "Example Cloudant Security response.", "value": { "cloudant": { "nobody": [ "_replicator", "_reader" ] } } }, "ServerInformation": { "description": "Example ServerInformation response.", "value": { "couchdb": "Welcome", "features": [ "access-ready", "iam", "partitioned", "pluggable-storage-engines", "scheduler" ], "features_flags": [ "partitioned" ], "vendor": { "name": "IBM Cloudant", "variant": "paas", "version": "8162" }, "version": "2.1.1" } }, "SessionInformation": { "description": "Example SessionInformation response.", "value": { "info": { "authenticated": "default", "authentication_db": "_users", "authentication_handlers": [ "iam", "cookie", "default", "local" ] }, "ok": true, "userCtx": { "name": "user", "roles": [ "_admin", "_reader", "_writer" ] } } }, "SessionResult": { "description": "Example SessionResult response.", "value": { "name": "user", "ok": true, "roles": [ "_reader", "_writer" ] } }, "SetCookieIamSession": { "description": "Example SetCookie response header for IAM.", "value": "IAMSession=aWJtIG9wZW5pZDp1c2VyOklCTWlkLTMxMDAwMERVNlI6UE1SRlEwOtsBU7LGVZo50V4uRRWiEzUHyhoTYj8QAYoNvXiVpCZE; Version=1; Expires=Mon, 11-Feb-2019 11:54:00 GMT; Max-Age=3380; Secure; Path=/; HttpOnly; Secure" }, "SetCookieSession": { "description": "Example SetCookie response header.", "value": "AuthSession=abcdABCD12344321DCBAdcba; Path=/; HttpOnly; Secure" }, "ShardsInformation": { "description": "Example ShardsInformation response.", "value": { "shards": { "00000000-3fffffff": [ "node1@xxx.xxx.xxx.xxx", "node2@xxx.xxx.xxx.xxx", "node3@xxx.xxx.xxx.xxx" ], "40000000-7fffffff": [ "node1@xxx.xxx.xxx.xxx", "node2@xxx.xxx.xxx.xxx", "node3@xxx.xxx.xxx.xxx" ], "80000000-bfffffff": [ "node1@xxx.xxx.xxx.xxx", "node2@xxx.xxx.xxx.xxx", "node3@xxx.xxx.xxx.xxx" ], "c0000000-ffffffff": [ "node1@xxx.xxx.xxx.xxx", "node2@xxx.xxx.xxx.xxx", "node3@xxx.xxx.xxx.xxx" ] } } }, "UpInformationOk": { "description": "Example UpInformation response.", "value": { "cluster": "bm-cc-us-east-01", "status": "ok" } }, "UsageDataVolume": { "description": "Example getUsageDataVolume response.", "value": { "data_vol": { "2023-07-01T00:00:00+00:00": { "dbs": 1303887, "search": 2040705, "views": 259119 }, "2023-07-01T12:00:00+00:00": { "dbs": 1303887, "search": 2058488, "views": 259119 }, "2023-07-02T00:00:00+00:00": { "dbs": 1303887, "search": 2054713, "views": 259119 }, "2023-07-02T12:00:00+00:00": { "dbs": 1303887, "search": 2042348, "views": 259119 } }, "end": "2023-07-02T00:00:00+00:00", "granularity": "12h", "start": "2023-07-01T00:00:00+00:00" } }, "UserInformation": { "description": "Example getUserInformation response.", "value": { "activity_tracker_event_types": [ "management" ], "admin": false, "admin_clusters": [], "cluster": "bm-cc-us-east-01", "cluster_type": "multitenant", "company": null, "cross_cloud_connector": false, "date": "2023-02-24 19:15:37", "disabled": {}, "domains": [ { "domain": "5lll032-dd12-536e-09b3-432fg9f07e78-bluemix.cloudant.com", "preferred": false, "type": "external" }, { "domain": "5lll032-dd12-536e-09b3-432fg9f07e78-bluemix.cloudantnosqldb.appdomain.cloud", "preferred": true, "type": "external" } ], "email": "dev@us.ibm.com", "features": {}, "first_name": "Bluemix", "last_name": "User", "last_pw_change": "2023-02-24 19:15:37", "over_quota": false, "partners": { "bluemix": { "bss_account_id": "167e0247e28648128b4a30db9238c2d1 crn: 'crn:v1:bluemix:public:cloudantnosqldb:us-south:a/167e0247e28648128b4a30db9238c2d1:4cdba765-34ee-4517-9c6a-11d342f13dbf::'", "iam_enabled": true, "legacy_credentials": true, "name": "example-cloudant", "resource_group_crn": "crn:v1:bluemix:public:resource-controller::a/167e0247e28648128b4a30db9238c2d1::resource-group:856cfc09382f45e9a86604fa8908b9e9", "root_credential_status": "active" } }, "plan": "billing.tiered.bluemix.lite", "plan_multiple": null, "shared_databases": [], "stripe_enabled": false, "support_level": "basic", "target_plan_multiple": null, "target_throughput": null, "throughput": null, "username": "5lll032-dd12-536e-09b3-432fg9f07e78-bluemix" } }, "UserPlan": { "description": "Example getUserPlan response.", "value": { "data_charging_model": "capped", "data_quota": "1GB", "history": [ [ "2023-01-16T19:01:03.000Z", "metered" ], [ "2016-03-14T20:56:00.000Z", "billing.tiered.standard.1" ] ], "name": "Bluemix Lite Plan", "throughput": { "lookup": 20, "query": 5, "write": 10 } } }, "UserPlanConfiguration": { "description": "Example putUserPlan request.", "value": { "plan": "billing.tiered.bluemix.standard", "plan_multiple": 25 } }, "UuidsResult": { "description": "Example UuidsResult response.", "value": { "uuids": [ "75480ca477454894678e22eec6002413", "75480ca477454894678e22eec600250b", "75480ca477454894678e22eec6002c41", "75480ca477454894678e22eec6003b90", "75480ca477454894678e22eec6003fca", "75480ca477454894678e22eec6004bef", "75480ca477454894678e22eec600528f", "75480ca477454894678e22eec6005e0b", "75480ca477454894678e22eec6006158", "75480ca477454894678e22eec6006161" ] } }, "ViewQueriesQuery": { "description": "Example ViewQueriesQuery request.", "value": { "queries": [ { "include_docs": true, "limit": 5 }, { "descending": true, "skip": 1 } ] } }, "ViewQueriesResult": { "description": "Example ViewQueriesResult response.", "value": { "results": [ { "offset": 0, "rows": [ { "id": "abc125", "key": "amelie.smith@aol.com", "value": [ "Amelie Smith", true, "2020-04-24T10:42:59.000Z" ] }, { "id": "abc123", "key": "bob.smith@aol.com", "value": [ "Bob Smith", true, "2019-01-24T10:42:59.000Z" ] } ], "total_rows": 2 }, { "offset": 1, "rows": [ { "id": "abc125", "key": "amelie.smith@aol.com", "value": [ "Amelie Smith", true, "2020-04-24T10:42:59.000Z" ] } ], "total_rows": 2 } ] } }, "ViewQuery": { "description": "Example ViewQuery request.", "value": { "include_docs": true, "keys": [ "examplekey" ], "limit": 10 } }, "ViewResult": { "description": "Example ViewResult response.", "value": { "offset": 0, "rows": [ { "id": "abc125", "key": "amelie.smith@aol.com", "value": [ "Amelie Smith", true, "2020-04-24T10:42:59.000Z" ] }, { "id": "abc123", "key": "bob.smith@aol.com", "value": [ "Bob Smith", true, "2019-01-24T10:42:59.000Z" ] } ], "total_rows": 2 } }, "ViewResultPartition": { "description": "Example ViewResult response for a database partition.", "value": { "offset": 0, "rows": [ { "id": "small-appliances:1000042", "key": "1000042", "value": [ "Foo", "Digital Kitchen Scales", "Slim Colourful Design Electronic Cooking Appliance for Home / Kitchen, Weigh up to 5kg + Aquatronic for Liquids ml + fl. oz. 15Yr Guarantee - Green" ] }, { "id": "small-appliances:1000043", "key": "1000043", "value": [ "Bar", "1100", "A professional, high powered innovative tool with a sleek design and outstanding performance" ] }, { "id": "small-appliances:1000044", "key": "1000044", "value": [ "Holstein", "Housewares Omelet Maker", "Easily make delicious and fluffy omelets without flipping - Innovative design - Cooking and cleaning is easy" ] } ], "total_rows": 3 } } }, "headers": { "AcceptRanges": { "description": "Header returning the range information for making range requests with application/octet-stream attachments.", "schema": { "description": "HTTP standard accept-ranges header value.", "maxLength": 5, "minLength": 4, "pattern": "^(bytes|none)$", "type": "string" } }, "CacheControl": { "description": "Header returning the cache-control directive for the response.", "schema": { "description": "HTTP standard cache-control header value.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "ContentEncoding": { "description": "Header for returning the compression codec used if an attachment's content_type is in list of compressible types.", "schema": { "description": "HTTP standard content-encoding header value.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "ContentLength": { "description": "Header returning the attachment size. If a compression codec is used, this value is the compressed size.", "schema": { "description": "HTTP standard content-length header value.", "format": "int64", "maximum": 10485760, "minimum": 0, "type": "integer" } }, "ContentRange": { "description": "Response header in the form of `bytes /` returning the bytes requested by the `Range` header supplied on the request and the total range.", "schema": { "description": "HTTP standard content-range header value.", "maxLength": 23, "minLength": 9, "pattern": "^.+$", "type": "string" } }, "Date": { "description": "Header returning the server response date-time.", "schema": { "allOf": [ { "$ref": "#/components/schemas/DateTimeRFC2822" }, { "description": "HTTP standard header date header value." } ] } }, "ETag": { "description": "Header returning the ETag for a resource.", "examples": { "Attachment": { "description": "Double quoted base64 encoded attachment digest.", "value": "\"MEHlNHhicVt9efOzyvsz0Q==\"" }, "DocumentRevision": { "description": "Double quoted document revision identifier.", "value": "\"2-240fc93fad07083c338c7e0ea55791b3\"" }, "LocalDocument": { "description": "Double quoted local document tag.", "value": "\"6APCCGX4B76OFFD5972MSBFHD\"" } }, "schema": { "$ref": "#/components/schemas/ETag" } }, "Location": { "description": "Header returning a location URI.", "schema": { "description": "HTTP standard location header value.", "maxLength": 8000, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "Server": { "description": "Header returning the server information.", "schema": { "description": "HTTP standard server header value.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "SetCookie": { "description": "Header returning the session cookie.", "examples": { "IamSession": { "$ref": "#/components/examples/SetCookieIamSession" }, "Session": { "$ref": "#/components/examples/SetCookieSession" } }, "schema": { "description": "HTTP standard set-cookie header value.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "TransferEncoding": { "description": "Header describing the transfer encoding.", "schema": { "description": "HTTP standard transfer-encoding header value.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "Via": { "description": "Header added by proxies through which the response was sent.", "schema": { "description": "HTTP standard via header value.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "XCloudantAction": { "description": "Header returning the Cloudant IAM action of the request.", "schema": { "description": "IAM action name.", "maxLength": 7168, "minLength": 1, "pattern": "^cloudantnosqldb\\..+$", "type": "string" } }, "XCloudantBackend": { "description": "Header returning the Cloudant backend that handled the request.", "schema": { "description": "Cloudant backend name.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "XCloudantCostLookup": { "description": "Header returning the Cloudant lookup cost of the request.", "schema": { "description": "Number of lookup units consumed by the request.", "format": "int64", "maximum": 4337916968, "minimum": 0, "type": "integer" } }, "XCloudantCostWrite": { "description": "Header returning the Cloudant write cost of the request.", "schema": { "description": "Number of write units consumed by the request.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "XCloudantRequestClass": { "description": "Header returning the Cloudant class of the request.", "schema": { "description": "Name of cost class of the request.", "enum": [ "lookup", "query", "unlimited", "write" ], "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "XRequestId": { "description": "Unique request trace identifier generated by the server or retains the value supplied in the same header on the request.", "schema": { "$ref": "#/components/schemas/RequestId" } } }, "parameters": { "Granularity": { "description": "Query parameter to specify the granularity of report interval for data usage.", "in": "query", "name": "granularity", "schema": { "default": 12, "enum": [ 1, 2, 3, 4, 6, 8, 12, 24 ], "format": "int64", "maximum": 24, "minimum": 1, "type": "integer" } }, "HeaderDestination": { "description": "Header parameter to specify the destination document URL. May be appended with rev query parameter for a specific revision.", "in": "header", "name": "Destination", "schema": { "maxLength": 8000, "minLength": 1, "pattern": "^([^_]|_(design|local)\\/).+(\\?rev=[1-9]\\d*-[\\da-f]{32})?$", "type": "string" } }, "HeaderIfMatch": { "description": "Header parameter for a conditional HTTP request matching an ETag.", "in": "header", "name": "If-Match", "schema": { "$ref": "#/components/schemas/ETag" } }, "HeaderIfNoneMatch": { "description": "Header parameter for a conditional HTTP request not matching an ETag.", "in": "header", "name": "If-None-Match", "schema": { "$ref": "#/components/schemas/ETag" } }, "HeaderLastEventId": { "description": "Header parameter to specify the ID of the last events received by the server on a previous connection. Overrides `since` query parameter.", "in": "header", "name": "Last-Event-ID", "schema": { "$ref": "#/components/schemas/Since" }, "x-alias": "since parameter" }, "HeaderRange": { "description": "Header parameter to specify the byte range for a request. This allows the implementation of resumable downloads and skippable streams. This is available for all attachments inside CouchDB.", "in": "header", "name": "Range", "schema": { "maxLength": 23, "minLength": 7, "pattern": "^bytes=(?:-\\d+)|(?:\\d+-)|(?:\\d+-\\d+)(?:,\\d+-\\d+)*$", "type": "string" } }, "HeaderXRequestId": { "description": "Set a unique identifier to trace a request.", "in": "header", "name": "X-Request-ID", "schema": { "$ref": "#/components/schemas/RequestId" }, "x-sdk-exclude": true }, "MonitoringCluster": { "description": "Name of the cluster for which metrics are to be returned user must be an admin for this cluster.", "in": "query", "name": "cluster", "required": true, "schema": { "description": "Name of the cluster.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "MonitoringDuration": { "description": "A string representing the duration of the desired timeseries query, must be paired with either `start` or `end`.", "in": "query", "name": "duration", "schema": { "description": "Duration of the desired timeseries query.", "enum": [ "5min", "30min", "1h", "12h", "24h", "1d", "3d", "7d", "1w", "1m", "3m", "6m", "12m", "1y" ], "type": "string" } }, "MonitoringEnd": { "description": "UTC timestamp in ISO-8601 or integer seconds since epoch format specifies end point of a timeseries query mutually exclusive with `start` param.", "in": "query", "name": "end", "schema": { "description": "End of the monitoring interval.", "format": "date-time", "maxLength": 26, "minLength": 1, "type": "string" } }, "MonitoringFormat": { "description": "Response format. Could be `raw` or `json`.", "in": "query", "name": "format", "schema": { "default": "json", "description": "Response format.", "enum": [ "json", "raw" ], "type": "string" } }, "MonitoringStart": { "description": "UTC timestamp in ISO-8601 or integer seconds since epoch format specifies starting point of a timeseries query mutually exclusive with `end` param.", "in": "query", "name": "start", "schema": { "description": "Start of the monitoring interval.", "format": "date-time", "maxLength": 26, "minLength": 1, "type": "string" } }, "PathAttachmentName": { "description": "Path parameter to specify the attachment name.", "in": "path", "name": "attachment_name", "required": true, "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^[^_].*$", "type": "string" } }, "PathConfigKey": { "description": "Path parameter to specify the config key.", "in": "path", "name": "config_key", "required": true, "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "PathConfigSection": { "description": "Path parameter to specify the config section.", "in": "path", "name": "config_section", "required": true, "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "PathDb": { "description": "Path parameter to specify the database name.", "in": "path", "name": "db", "required": true, "schema": { "$ref": "#/components/schemas/DatabaseName" } }, "PathDesignDocumentName": { "description": "Path parameter to specify the design document name. The design document name is the design document ID excluding the `_design/` prefix.", "in": "path", "name": "ddoc", "required": true, "schema": { "$ref": "#/components/schemas/PathDocumentId" } }, "PathDocId": { "description": "Path parameter to specify the document ID.", "in": "path", "name": "doc_id", "required": true, "schema": { "$ref": "#/components/schemas/PathDocumentId" } }, "PathEndpoint": { "description": "Path parameter to specify the endpoint for monitoring.", "in": "path", "name": "endpoint", "required": true, "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^https:\\/\\/.*$", "type": "string" } }, "PathIndex": { "description": "Path parameter to specify the index name.", "in": "path", "name": "index", "required": true, "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "PathJobId": { "description": "Path parameter to specify the replication job id.", "in": "path", "name": "job_id", "required": true, "schema": { "$ref": "#/components/schemas/JobId" } }, "PathMonth": { "description": "Path parameter to specify the month.", "in": "path", "name": "month", "required": true, "schema": { "description": "Schema for a two digits month representation.", "maxLength": 2, "minLength": 2, "pattern": "^0?[1-9]|1[012]$", "type": "string" } }, "PathNodeName": { "description": "Path parameter to specify the node name.", "in": "path", "name": "node_name", "required": true, "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^\\w+@.+$", "type": "string" } }, "PathPartitionKey": { "description": "Path parameter to specify the database partition key.", "in": "path", "name": "partition_key", "required": true, "schema": { "$ref": "#/components/schemas/PartitionKey" } }, "PathReplicatorDb": { "description": "Path parameter to specify the replicator database name.", "in": "path", "name": "replicator_db", "required": true, "schema": { "$ref": "#/components/schemas/DatabaseName" } }, "PathReplicatorDocId": { "description": "Path parameter to specify the ID of the stored replication configuration in the `_replicator` database.", "in": "path", "name": "doc_id", "required": true, "schema": { "$ref": "#/components/schemas/PathDocumentId" } }, "PathReshardJobId": { "description": "Path parameter to specify the shard splitting job ID.", "in": "path", "name": "reshard_job_id", "required": true, "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "PathType": { "description": "Path parameter to specify the index type.", "in": "path", "name": "type", "required": true, "schema": { "$ref": "#/components/schemas/IndexType" } }, "PathUpdateName": { "description": "Path parameter to specify the update function name.", "in": "path", "name": "update_name", "required": true, "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "PathView": { "description": "Path parameter to specify the map reduce view function name.", "in": "path", "name": "view", "required": true, "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^[a-z][a-z0-9_$()+/-]*$", "type": "string" } }, "PathYear": { "description": "Path parameter to specify the year.", "in": "path", "name": "year", "required": true, "schema": { "description": "Schema for a four digits year representation.", "maxLength": 4, "minLength": 4, "pattern": "^\\d{3}[1-9]$", "type": "string" } }, "QueryAttEncodingInfo": { "description": "Query parameter to specify whether to include the encoding information for compressed attachments. Note that when used with a view-style query or changes feed this only applies when requesting documents in the response.", "in": "query", "name": "att_encoding_info", "schema": { "default": false, "type": "boolean" } }, "QueryAttachments": { "description": "Query parameter to specify whether to include attachment content in the response. Note that when used with a view-style query or changes feed this only applies when requesting documents in the response.", "in": "query", "name": "attachments", "schema": { "default": false, "type": "boolean" } }, "QueryAttsSince": { "description": "Query parameter to specify whether to include attachments only since specified revisions. Note this does not include the attachments for the specified revisions.", "example": [ "1-99b02e08da151943c2dcb40090160bb8" ], "in": "query", "name": "atts_since", "schema": { "items": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" }, "maxItems": 162, "minItems": 1, "type": "array" }, "x-sdk-exclude": true }, "QueryBatch": { "description": "Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.", "in": "query", "name": "batch", "schema": { "enum": [ "ok" ], "type": "string" } }, "QueryBookmark": { "description": "Query parameter to specify a bookmark that was received from a previous request. This parameter enables paging through the results. If there are no more results after the bookmark, you get a response containing no further results and the same bookmark, confirming the end of the result list.", "in": "query", "name": "bookmark", "schema": { "$ref": "#/components/schemas/Bookmark" } }, "QueryConflicts": { "description": "Query parameter to specify whether to include a list of conflicted revisions in each returned document. Note that when used with a view-style query or changes feed this only applies when requesting documents in the response.", "in": "query", "name": "conflicts", "schema": { "default": false, "type": "boolean" } }, "QueryCount": { "description": "Query parameter to specify the number of UUIDs to return.", "in": "query", "name": "count", "schema": { "default": 1, "format": "int64", "maximum": 1000, "minimum": 0, "type": "integer" } }, "QueryCounts": { "description": "Query parameter to specify an array of names of string fields, for which counts are requested. The response contains counts for each unique value of the string field name among the documents that match the search query. Faceting must be enabled for this parameter to function.", "in": "query", "name": "counts", "schema": { "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "QueryDeletedConflicts": { "description": "Query parameter to specify whether to include a list of deleted conflicted revisions in the `_deleted_conflicts` property of the returned document.", "in": "query", "name": "deleted_conflicts", "schema": { "default": false, "type": "boolean" } }, "QueryDescending": { "description": "Query parameter to specify whether to return rows in descending by key order.", "in": "query", "name": "descending", "schema": { "default": false, "type": "boolean" } }, "QueryDescendingChanges": { "description": "Query parameter to specify whether to return changes in the descending order with most recent change first. The `since` parameter has no effect when using descending order.", "in": "query", "name": "descending", "schema": { "default": false, "type": "boolean" } }, "QueryDocIds": { "description": "Query parameter to specify a JSON array list of document IDs to restrict the changes feed to. Used with the `_doc_ids` filter. Since length of URL is limited, it is better to use POST `/{db}/_changes` instead.", "in": "query", "name": "doc_ids", "schema": { "items": { "maxLength": 7168, "minLength": 1, "pattern": "^[^_].*$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "QueryDrilldown": { "description": "Restrict results to documents with a dimension equal to the specified label(s). The search matches only documents containing the value that was provided in the named field. It differs from using \"fieldname:value\" in the q parameter only in that the values are not analyzed. Faceting must be enabled for this parameter to function.", "in": "query", "name": "drilldown", "schema": { "items": { "$ref": "#/components/schemas/DrilldownQuery" }, "maxItems": 65535, "minItems": 1, "type": "array" } }, "QueryEndKey": { "description": "Query parameter to specify to stop returning records when the specified key is reached. String representation of any JSON type that matches the key type emitted by the view function.", "in": "query", "name": "end_key", "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "x-alias": "endkey" }, "QueryEndKeyDocId": { "description": "Query parameter to stop returning rows at the specified document ID. No effect if using `group` or not providing end key.", "in": "query", "name": "end_key_doc_id", "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^[^_].*$", "type": "string" }, "x-alias": "endkey_docid" }, "QueryFeed": { "description": "Query parameter to specify the changes feed type.", "in": "query", "name": "feed", "schema": { "default": "normal", "enum": [ "continuous", "eventsource", "longpoll", "normal" ], "type": "string" } }, "QueryFilter": { "description": "Query parameter to specify a filter to emit only specific events\nfrom the changes stream.\n\nThe built-in filter types are:\n * `_design` - Returns only changes to design documents.\n * `_doc_ids` - Returns changes for documents with an ID matching one\n specified in `doc_ids` request body parameter. (`POST` only)\n * `_selector` - Returns changes for documents that match the\n `selector` request body parameter. The selector syntax is the same\n as used for `_find`. (`POST` only)\n * `_view` - Returns changes for documents that match an existing map\n function in the view specified by the query parameter `view`.\n\nAdditionally, the value can be the name of a JS filter function from a\ndesign document. For example: `design_doc/filtername`.\n\n**Note:** For better performance use the built-in `_selector`, `_design`\nor `_doc_ids` filters rather than JS based `_view` or design document\nfilters.\nIf you need to pass values to change the filtered content use the\n`_selector` filter type.", "in": "query", "name": "filter", "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^_design|_docs_ids|_selector|_view|.*\\/.*$", "type": "string" } }, "QueryGroup": { "description": "Query parameter to specify whether to group reduced results by key. Valid only if a reduce function is defined in the view. If the view emits keys in JSON array format, then it is possible to reduce groups further based on the number of array elements with the `group_level` parameter.", "in": "query", "name": "group", "schema": { "default": false, "type": "boolean" } }, "QueryGroupField": { "description": "Query parameter to specify the field name by which to group search matches. It must be a string that contains the name of a string field. Fields containing other data such as numbers, objects, or arrays cannot be used.", "in": "query", "name": "group_field", "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "QueryGroupLevel": { "description": "Query parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. Implies group is `true`. Group level groups the reduced results by the specified number of array elements. If unset, results are grouped by the entire array key, returning a reduced value for each complete key.", "in": "query", "name": "group_level", "schema": { "format": "int64", "maximum": 4294967295, "minimum": 1, "type": "integer" } }, "QueryGroupLimit": { "description": "Query parameter to specify the maximum group count. This parameter can be used only if group_field is specified.", "in": "query", "name": "group_limit", "schema": { "format": "int64", "maximum": 4294967295, "minimum": 1, "type": "integer" } }, "QueryGroupSort": { "description": "Query parameter to specify the order of the groups in a search that uses group_field. The default sort order is relevance. This parameter can have the same values as the sort field, so single fields and arrays of fields are supported.", "in": "query", "name": "group_sort", "schema": { "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "QueryHeartbeat": { "description": "Query parameter to specify the period in milliseconds after\nwhich an empty line is sent in the results. Off by default and only\napplicable for `continuous` and `eventsource` feeds. Overrides any\ntimeout to keep the feed alive indefinitely. May also be `true` to use a\nvalue of `60000`.\n\n**Note:** Delivery of heartbeats cannot be relied on at specific\nintervals.\nIf your application runs in an environment where idle network\nconnections may break, `heartbeat` is not suitable as a keepalive\nmechanism.\nInstead, consider one of the following options:\n * Use the `timeout` parameter with a value that is compatible with\n your network environment.\n * Switch to scheduled usage of one of the non-continuous changes feed\n types (`normal` or `longpoll`).\n * Use TCP keepalive.", "in": "query", "name": "heartbeat", "schema": { "format": "int64", "maximum": 60000, "minimum": 1, "type": "integer" } }, "QueryHighlightFields": { "description": "Query parameter to specify which fields to highlight. If specified, the result object contains a highlights field with an entry for each specified field.", "in": "query", "name": "highlight_fields", "schema": { "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "QueryHighlightNumber": { "description": "Query parameter to specify the number of fragments that are returned in highlights. If the search term occurs less often than the number of fragments that are specified, longer fragments are returned.", "in": "query", "name": "highlight_number", "schema": { "default": 1, "format": "int64", "maximum": 1048521, "minimum": 1, "type": "integer" } }, "QueryHighlightPostTag": { "description": "Query parameter to specify a string that is inserted after the highlighted word in the highlights output.", "in": "query", "name": "highlight_post_tag", "schema": { "default": "", "maxLength": 7168, "minLength": 1, "pattern": "^$", "type": "string" } }, "QueryHighlightPreTag": { "description": "Query parameter to specify a string that is inserted before the highlighted word in the highlights output.", "in": "query", "name": "highlight_pre_tag", "schema": { "default": "", "maxLength": 7168, "minLength": 1, "pattern": "^<.*>$", "type": "string" } }, "QueryHighlightSize": { "description": "Query parameter to specify the number of characters in each fragment for highlights.", "in": "query", "name": "highlight_size", "schema": { "default": 100, "format": "int64", "maximum": 1048521, "minimum": 1, "type": "integer" } }, "QueryIncludeDocs": { "description": "Query parameter to specify whether to include the full content of the documents in the response.", "in": "query", "name": "include_docs", "schema": { "default": false, "description": "Include the full content of the documents in the response.", "type": "boolean" } }, "QueryIncludeFields": { "description": "Query parameter to specify a JSON array of field names to include in search results. Any fields that are included must be indexed with the `store:true` option. The default is all fields.", "in": "query", "name": "include_fields", "schema": { "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "QueryInclusiveEnd": { "description": "Query parameter to specify whether the specified end key should be included in the result.", "in": "query", "name": "inclusive_end", "schema": { "default": true, "type": "boolean" } }, "QueryKey": { "description": "Query parameter to specify to return only rows that match the specified key. String representation of any JSON type that matches the key type emitted by the view function.", "in": "query", "name": "key", "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "QueryKeys": { "description": "Query parameter to specify returning only rows that match any of the specified keys. String representation of a JSON array of keys that match the key type emitted by the view function. Must be URL encoded.", "in": "query", "name": "keys", "schema": { "maxLength": 7168, "minLength": 2, "pattern": "^\\[(\".*\")*\\]$", "type": "string" } }, "QueryLastEventId": { "description": "Query parameter to specify the ID of the last events received by the server on a previous connection. Alias of `Last-Event-ID` header.", "in": "query", "name": "last_event_id", "schema": { "$ref": "#/components/schemas/Since" }, "x-alias": "since parameter", "x-sdk-exclude": true }, "QueryLatest": { "description": "Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was requested.", "in": "query", "name": "latest", "schema": { "default": false, "type": "boolean" } }, "QueryLimit": { "description": "Query parameter to specify the number of returned documents to limit the result to.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "QueryLocalSeq": { "description": "Query parameter to specify whether to include the last update sequence for the document.", "in": "query", "name": "local_seq", "schema": { "default": false, "type": "boolean" } }, "QueryMeta": { "description": "Query parameter to specify whether to include document meta information. Acts the same as specifying all of the conflicts, deleted_conflicts and open_revs query parameters.", "in": "query", "name": "meta", "schema": { "default": false, "type": "boolean" } }, "QueryN": { "description": "The number of replicas of the database in the cluster. The default is 3, unless overridden in the `cluster config`.", "in": "query", "name": "n", "required": false, "schema": { "$ref": "#/components/schemas/ReplicaCount" }, "x-sdk-exclude": true }, "QueryNewEdits": { "description": "Query parameter to specify whether to prevent insertion of\nconflicting document revisions. If false, a well-formed _rev must be\nincluded in the document. False is used by the replicator to insert\ndocuments into the target database even if that leads to the creation of\nconflicts.\n\nAvoid using this parameter, since this option applies document revisions\nwithout checking for conflicts, so it is very easy to accidentally end\nup with a large number of conflicts.", "in": "query", "name": "new_edits", "schema": { "default": false, "type": "boolean" } }, "QueryNext": { "description": "Enforces redirect after successful login to the specified location. This location is relative from server root.", "in": "query", "name": "next", "schema": { "maxLength": 8000, "minLength": 1, "pattern": "^.+$", "type": "string" }, "x-sdk-exclude": true }, "QueryOpenRevs": { "description": "Query parameter to specify leaf revisions to retrieve. Additionally, it accepts a value of `all` to return all leaf revisions.", "in": "query", "name": "open_revs", "schema": { "items": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" }, "maxItems": 162, "minItems": 1, "type": "array" }, "x-sdk-exclude": true }, "QueryPartitioned": { "description": "Query parameter to specify whether to enable database partitions when creating a database.\n\nBefore using read the\n[FAQs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-database-partitioning#partitioned-databases-database-partitioning)\nto understand the limitations and appropriate use cases.", "in": "query", "name": "partitioned", "schema": { "default": false, "type": "boolean" } }, "QueryQ": { "description": "The number of shards in the database. Each shard is a\npartition of the hash value range. Cloudant recommends using the\ndefault value for most databases. However, if your database\nis expected to be larger than 250 GB or have a lot\nof indexes, you may need to adjust the settings. In these cases,\nit's best to reach out to IBM Cloudant customer support for guidance\non how to meet your specific needs and requirements.", "in": "query", "name": "q", "required": false, "schema": { "$ref": "#/components/schemas/ShardCount" } }, "QueryQuery": { "description": "Query parameter to specify a Lucene search query. Alias of `q`.", "in": "query", "name": "query", "required": true, "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "x-alias": "q" }, "QueryRanges": { "description": "Query parameter to specify ranges for faceted, numeric search fields. The value is a JSON object where the fields names are faceted numeric search fields, and the values of the fields are JSON objects. For each of these objects the field names of the JSON objects are names for ranges. The values are strings that describe the range, for example \"[0 TO 10]\".", "in": "query", "name": "ranges", "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^{.+}$", "type": "string" } }, "QueryReduce": { "description": "Query parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce function is defined.\nA default `reduce` view type can be disabled to behave like a `map` by setting `reduce=false` explicitly.\nBe aware that `include_docs=true` is only for `map` views. Reduced views do not include document IDs in view rows.", "in": "query", "name": "reduce", "schema": { "default": true, "type": "boolean" } }, "QueryRev": { "description": "Query parameter to specify a document revision.", "in": "query", "name": "rev", "schema": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" } }, "QueryRevs": { "description": "Query parameter to specify whether to include a list of all known document revisions.", "in": "query", "name": "revs", "schema": { "default": false, "type": "boolean" } }, "QueryRevsInfo": { "description": "Query parameter to specify whether to includes detailed information for all known document revisions.", "in": "query", "name": "revs_info", "schema": { "default": false, "type": "boolean" } }, "QuerySchedulerJobsLimit": { "description": "Query parameter to specify the number of returned jobs to limit the result to.", "in": "query", "name": "limit", "schema": { "default": 25, "format": "int64", "maximum": 200, "minimum": 0, "type": "integer" } }, "QuerySearchAnalyzer": { "description": "Query parameter to specify search analyzer type.", "in": "query", "name": "analyzer", "required": true, "schema": { "$ref": "#/components/schemas/SearchAnalyzer" } }, "QuerySearchAnalyzerText": { "description": "Query parameter to specify search analyzer text.", "in": "query", "name": "text", "required": true, "schema": { "$ref": "#/components/schemas/SearchAnalyzerText" } }, "QuerySeqInterval": { "description": "Query parameter to specify that the update seq should only be calculated with every Nth result returned. When fetching changes in a batch, setting seq_interval=<batch size>, where <batch size> is the number of results requested per batch, load can be reduced on the source database as computing the seq value across many shards (especially in highly-sharded databases) is expensive.", "in": "query", "name": "seq_interval", "schema": { "format": "int64", "maximum": 4294967295, "minimum": 1, "type": "integer" } }, "QuerySince": { "description": "Query parameter to specify to start the results from the change\nimmediately after the given update sequence. Possible values are:\n * `0` for all available changes (default).\n * `now` for future changes.\n * A valid update sequence, for example, from the `seq` value of a\n change received before.", "example": "0", "in": "query", "name": "since", "schema": { "$ref": "#/components/schemas/Since" } }, "QuerySkip": { "description": "Query parameter to specify the number of records before starting to return the results.", "in": "query", "name": "skip", "schema": { "default": 0, "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "QuerySort": { "description": "Query parameter to specify the sort order of the results. In a grouped search (when group_field is used), this parameter specifies the sort order within a group. The default sort order is relevance. A JSON string of the form \"fieldname<type>\" or -fieldname<type> for descending order, where fieldname is the name of a string or number field, and type is either a number, a string, or a JSON array of strings. The type part is optional, and defaults to number. Some examples are \"foo\", \"-foo\", \"bar<string>\", \"-foo<number>\" and [\"-foo<number>\", \"bar<string>\"]. String fields that are used for sorting must not be analyzed fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.", "in": "query", "name": "sort", "schema": { "items": { "$ref": "#/components/schemas/SearchSort" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "QuerySorted": { "deprecated": true, "description": "Query parameter to specify whether to sort the returned rows. Setting this to false offers a performance boost. The total_rows and offset fields are not available when this is set to false.", "in": "query", "name": "sorted", "schema": { "default": true, "type": "boolean" }, "x-sdk-exclude": true }, "QueryStable": { "description": "Query parameter to specify whether use the same replica of the index\non each request. The default value `false` contacts all replicas and\nreturns the result from the first, fastest, responder.\nSetting it to `true` when used in conjunction with `update=false` may\nimprove consistency at the expense of increased latency and decreased\nthroughput, if the selected replica is not the fastest of the available\nreplicas.\n\n**Note:** In general setting `true` is discouraged and is strictly not\nrecommended when using `update=true`.", "in": "query", "name": "stable", "schema": { "default": false, "type": "boolean" } }, "QueryStale": { "deprecated": true, "description": "**Note:** `stale` is deprecated, use `stable` and `update` instead.\n\nQuery parameter to specify whether to allow the results from a\nstale view to be used, without triggering a rebuild of all views within\nthe encompassing design doc.\n\n* `ok` is equivalent to `stable=true&update=false`\n* `update_after` is equivalent to `stable=true&update=lazy`\n\nFor more details on the use cases of `stale`, `update`, and `stable` parameters, see [this blog post](https://blog.cloudant.com/2018/11/06/What-is-stale-update-and-stable.html).", "in": "query", "name": "stale", "schema": { "enum": [ "ok", "update_after" ], "type": "string" }, "x-sdk-exclude": true }, "QueryStaleSearch": { "description": "Query parameter to specify to not wait for the index to finish building before returning results.", "in": "query", "name": "stale", "schema": { "enum": [ "ok" ], "type": "string" } }, "QueryStartKey": { "description": "Query parameter to specify to start returning records from the specified key. String representation of any JSON type that matches the key type emitted by the view function.", "in": "query", "name": "start_key", "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "x-alias": "startkey" }, "QueryStartKeyDocId": { "description": "Query parameter to start returning rows at the specified document ID. No effect if using `group` or not providing start key.", "in": "query", "name": "start_key_doc_id", "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^[^_].*$", "type": "string" }, "x-alias": "startkey_docid" }, "QueryStates": { "description": "Query parameter to include only replication documents in the specified states. String must be a comma-delimited string.", "explode": false, "in": "query", "name": "states", "schema": { "items": { "$ref": "#/components/schemas/ReplicationState" }, "maxItems": 7, "minItems": 1, "type": "array" }, "style": "form" }, "QueryStyle": { "description": "Query parameter to specify how many revisions are returned in the changes array. The default, `main_only`, will only return the current \"winning\" revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts).", "in": "query", "name": "style", "schema": { "default": "main_only", "enum": [ "main_only", "all_docs" ], "type": "string" } }, "QueryTimeout": { "description": "Query parameter to specify the maximum period in milliseconds to wait for a change before the response is sent, even if there are no results. Only applicable for `longpoll` or `continuous` feeds. Default value is specified by `httpd/changes_timeout` configuration option. Note that `60000` value is also the default maximum timeout to prevent undetected dead connections.", "in": "query", "name": "timeout", "schema": { "default": 60000, "format": "int64", "maximum": 60000, "minimum": 0, "type": "integer" } }, "QueryUpdate": { "description": "Query parameter to specify whether or not the view in question\nshould be updated prior to responding to the user.\n\n* `true` - Return results after the view is updated.\n* `false` - Return results without updating the view.\n* `lazy` - Return the view results without waiting for an update, but\n update them immediately after the request.", "in": "query", "name": "update", "schema": { "default": "true", "enum": [ "true", "false", "lazy" ], "type": "string" } }, "QueryUpdateSeq": { "description": "Query parameter to specify whether to include in the response an update_seq value indicating the sequence id of the database the view reflects.", "in": "query", "name": "update_seq", "schema": { "default": false, "type": "boolean" } }, "QueryView": { "description": "Query parameter to specify a view function as a filter. Documents pass the filter if the view's map function emits at least one record for them.", "in": "query", "name": "view", "schema": { "maxLength": 7168, "minLength": 1, "pattern": "^[^_].*$", "type": "string" } }, "UserPlanHistory": { "description": "Return user's plan history if true.", "in": "query", "name": "history", "schema": { "default": true, "type": "boolean" } }, "UserPlanStartDate": { "description": "Earliest date from which to include plan changes in history", "in": "query", "name": "start_date", "schema": { "format": "date-time", "maxLength": 26, "minLength": 1, "type": "string" } } }, "requestBodies": { "ActivityTrackerEvents": { "content": { "application/json": { "examples": { "ActivityTrackerEvents": { "$ref": "#/components/examples/ActivityTrackerEvents" } }, "schema": { "$ref": "#/components/schemas/ActivityTrackerEvents" } } }, "description": "HTTP request body for postActivityTrackerEvents.", "required": true }, "AllDocsQueriesQuery": { "content": { "application/json": { "examples": { "AllDocsQueriesQuery": { "$ref": "#/components/examples/AllDocsQueriesQuery" } }, "schema": { "$ref": "#/components/schemas/AllDocsQueriesQuery" } } }, "description": "HTTP request body for allDocsQueriesQuery, designDocsQueriesQuery and localDocsQueriesQuery.", "required": true }, "AllDocsQuery": { "content": { "application/json": { "examples": { "AllDocsQuery": { "$ref": "#/components/examples/AllDocsQuery" } }, "schema": { "$ref": "#/components/schemas/AllDocsQuery" } } }, "description": "HTTP request body for postAllDocs and postPartitionAllDocs.", "required": true }, "Attachment": { "content": { "*/*": { "examples": { "AttachmentContent": { "$ref": "#/components/examples/AttachmentContent" } }, "schema": { "$ref": "#/components/schemas/AttachmentContent" } } }, "description": "HTTP request body for attachment operations.", "required": true }, "BulkDocs": { "content": { "application/json": { "examples": { "BulkDocs": { "$ref": "#/components/examples/BulkDocs" }, "BulkDocsDelete": { "$ref": "#/components/examples/BulkDocsDelete" } }, "schema": { "$ref": "#/components/schemas/BulkDocs" } } }, "description": "HTTP request body for postBulkDocs.", "required": true }, "BulkGetQuery": { "content": { "application/json": { "examples": { "BulkGetQuery": { "$ref": "#/components/examples/BulkGetQuery" } }, "schema": { "$ref": "#/components/schemas/BulkGetQuery" } } }, "description": "HTTP request body for postBulkGet.", "required": true }, "CapacityThroughputConfiguration": { "content": { "application/json": { "examples": { "CapacityThroughputConfiguration": { "$ref": "#/components/examples/CapacityThroughputConfiguration" } }, "schema": { "$ref": "#/components/schemas/CapacityThroughputConfiguration" } } }, "description": "HTTP request body for putCapacityThroughputConfiguration.", "required": true }, "ChangesQuery": { "content": { "application/json": { "examples": { "ChangesFilterDocIds": { "$ref": "#/components/examples/ChangesQueryFilterDocIds" }, "ChangesFilterSelector": { "$ref": "#/components/examples/ChangesQueryFilterSelector" } }, "schema": { "$ref": "#/components/schemas/ChangesQuery" } } }, "description": "HTTP request body for postChanges.", "required": true }, "CloudantSecurityConfiguration": { "content": { "application/json": { "examples": { "CloudantSecurityConfiguration": { "$ref": "#/components/examples/CloudantSecurityConfiguration" } }, "schema": { "$ref": "#/components/schemas/CloudantSecurityConfiguration" } } }, "description": "HTTP request body for putCloudantSecurityConfiguration.", "required": true }, "CorsConfiguration": { "content": { "application/json": { "examples": { "CorsConfiguration": { "$ref": "#/components/examples/CorsConfiguration" } }, "schema": { "$ref": "#/components/schemas/CorsConfiguration" } } }, "description": "HTTP request body for putCorsConfiguration.", "required": true }, "DbsInfoQuery": { "content": { "application/json": { "examples": { "DbsInfoQuery": { "$ref": "#/components/examples/DbsInfoQuery" } }, "schema": { "$ref": "#/components/schemas/DbsInfoQuery" } } }, "description": "HTTP request body for postDbsInfo.", "required": true }, "DesignDocument": { "content": { "application/json": { "examples": { "DesignDocument": { "$ref": "#/components/examples/DesignDocument" } }, "schema": { "$ref": "#/components/schemas/DesignDocument" } } }, "description": "HTTP request body for DesignDocument operations.", "required": true }, "Document": { "content": { "application/json": { "examples": { "Document": { "$ref": "#/components/examples/Document" } }, "schema": { "$ref": "#/components/schemas/Document" } }, "multipart/mixed": { "schema": { "$ref": "#/components/schemas/DocumentMultipart" } }, "multipart/related": { "examples": { "DocumentMultipart": { "$ref": "#/components/examples/DocumentMultipartRequest" } }, "schema": { "$ref": "#/components/schemas/DocumentMultipart" } } }, "description": "HTTP request body for Document operations.", "required": true }, "DocumentRevisions": { "content": { "application/json": { "examples": { "DocumentRevisions": { "$ref": "#/components/examples/DocumentRevisions" } }, "schema": { "$ref": "#/components/schemas/DocumentRevisions" } } }, "description": "HTTP request body for operations with Document revisions.", "required": true }, "FindQuery": { "content": { "application/json": { "examples": { "FindQuery": { "$ref": "#/components/examples/FindQuery" } }, "schema": { "$ref": "#/components/schemas/FindQuery" } } }, "description": "HTTP request body for postFind and postExplain.", "required": true }, "IamSessionConfiguration": { "content": { "application/json": { "examples": { "IamSessionConfiguration": { "$ref": "#/components/examples/IamSessionConfiguration" } }, "schema": { "$ref": "#/components/schemas/IamSessionConfiguration" } } }, "description": "HTTP request body for postIamSession.", "required": true }, "IndexConfiguration": { "content": { "application/json": { "examples": { "IndexConfiguration": { "$ref": "#/components/examples/IndexConfiguration" } }, "schema": { "$ref": "#/components/schemas/IndexConfiguration" } } }, "description": "HTTP request body for postIndex.", "required": true }, "PartitionFindQuery": { "content": { "application/json": { "examples": { "PartitionFindQuery": { "$ref": "#/components/examples/PartitionFindQuery" } }, "schema": { "$ref": "#/components/schemas/PartitionFindQuery" } } }, "description": "HTTP request body for postPartitionFind.", "required": true }, "PartitionSearchQuery": { "content": { "application/json": { "examples": { "Search": { "$ref": "#/components/examples/SearchQuery" } }, "schema": { "$ref": "#/components/schemas/PartitionSearchQuery" } } }, "description": "HTTP request body for postPartitionSearch.", "required": true }, "PartitionViewQuery": { "content": { "application/json": { "examples": { "ViewQuery": { "$ref": "#/components/examples/ViewQuery" } }, "schema": { "$ref": "#/components/schemas/PartitionViewQuery" } } }, "description": "HTTP request body for postPartitionView.", "required": true }, "ReplicationDocument": { "content": { "application/json": { "examples": { "ReplicationDocument": { "$ref": "#/components/examples/ReplicationDocument" } }, "schema": { "$ref": "#/components/schemas/ReplicationDocument" } } }, "description": "HTTP request body for replication operations.", "required": true }, "ReshardJobsConfiguration": { "content": { "application/json": { "examples": { "ReshardJobsConfiguration": { "$ref": "#/components/examples/ReshardJobsConfiguration" } }, "schema": { "$ref": "#/components/schemas/ReshardJobsConfiguration" } } }, "description": "HTTP request body for postReshardJobsConfiguration.", "required": true }, "ReshardState": { "content": { "application/json": { "examples": { "ReshardStateCluster": { "$ref": "#/components/examples/ReshardStateCluster" }, "ReshardStateJob": { "$ref": "#/components/examples/ReshardStateJob" } }, "schema": { "$ref": "#/components/schemas/ReshardState" } } }, "description": "HTTP request body for putReshardState or putReshardJobState.", "required": true }, "RevsLimit": { "content": { "application/json": { "examples": { "RevsLimit": { "$ref": "#/components/examples/RevsLimit" } }, "schema": { "$ref": "#/components/schemas/RevsLimit" } } }, "description": "HTTP request body for putRevsLimit.", "required": true }, "SearchAnalyzeQuery": { "content": { "application/json": { "examples": { "SearchAnalyzeQuery": { "$ref": "#/components/examples/SearchAnalyzeQuery" } }, "schema": { "$ref": "#/components/schemas/SearchAnalyzeQuery" } } }, "description": "HTTP request body for postSearchAnalyze.", "required": true }, "SearchQuery": { "content": { "application/json": { "examples": { "SearchQuery": { "$ref": "#/components/examples/SearchQuery" } }, "schema": { "$ref": "#/components/schemas/SearchQuery" } } }, "description": "HTTP request body for postSearch.", "required": true }, "Security": { "content": { "application/json": { "examples": { "Security": { "$ref": "#/components/examples/Security" } }, "schema": { "$ref": "#/components/schemas/Security" } } }, "description": "HTTP request body for putSecurity.", "required": true }, "SessionConfiguration": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionConfiguration" } } }, "description": "HTTP request body for postSession.", "required": true }, "UserPlanConfiguration": { "content": { "application/json": { "examples": { "UserPlanConfiguration": { "$ref": "#/components/examples/UserPlanConfiguration" } }, "schema": { "$ref": "#/components/schemas/UserPlanConfiguration" } } }, "description": "HTTP request body for putUserPlan.", "required": true }, "ViewQueriesQuery": { "content": { "application/json": { "examples": { "ViewQueriesQuery": { "$ref": "#/components/examples/ViewQueriesQuery" } }, "schema": { "$ref": "#/components/schemas/ViewQueriesQuery" } } }, "description": "HTTP request body for postViewQueries.", "required": true }, "ViewQuery": { "content": { "application/json": { "examples": { "ViewQuery": { "$ref": "#/components/examples/ViewQuery" } }, "schema": { "$ref": "#/components/schemas/ViewQuery" } } }, "description": "HTTP request body for postView and postPartitionView.", "required": true } }, "responses": { "ActiveTasks": { "content": { "application/json": { "examples": { "ActiveTasks": { "$ref": "#/components/examples/ActiveTasks" } }, "schema": { "$ref": "#/components/schemas/ActiveTasks" } } }, "description": "HTTP response for `/_active_tasks` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ActiveTasksHead": { "description": "HTTP response for `/_active_tasks` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ActivityTrackerEvents": { "content": { "application/json": { "examples": { "ActivityTrackerEvents": { "$ref": "#/components/examples/ActivityTrackerEvents" } }, "schema": { "$ref": "#/components/schemas/ActivityTrackerEvents" } } }, "description": "HTTP response for getActivityTrackerEvents.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "AllDbs": { "content": { "application/json": { "examples": { "AllDbsResult": { "$ref": "#/components/examples/AllDbsResult" } }, "schema": { "$ref": "#/components/schemas/AllDbs" } } }, "description": "HTTP response for `/_all_dbs` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "AllDbsHead": { "description": "HTTP response for `/_all_dbs` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "AllDocsQueriesResult": { "content": { "application/json": { "examples": { "AllDocsQueriesResult": { "$ref": "#/components/examples/AllDocsQueriesResult" } }, "schema": { "$ref": "#/components/schemas/AllDocsQueriesResult" } } }, "description": "HTTP response for `/_all_docs/queries` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "AllDocsResult": { "content": { "application/json": { "examples": { "AllDocsResult": { "$ref": "#/components/examples/AllDocsResult" } }, "schema": { "$ref": "#/components/schemas/AllDocsResult" } } }, "description": "HTTP response for getAllDocs and postAllDocs.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "AllDocsResultDesign": { "content": { "application/json": { "examples": { "AllDocsResultDesignDocs": { "$ref": "#/components/examples/AllDocsResultDesignDocs" } }, "schema": { "$ref": "#/components/schemas/AllDocsResult" } } }, "description": "HTTP response for getDesignDocs and postDesignDocs.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "AllDocsResultHead": { "description": "HTTP response for `/_all_docs` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "AllDocsResultLocal": { "content": { "application/json": { "examples": { "AllDocsResultLocalDocs": { "$ref": "#/components/examples/AllDocsResultLocalDocs" } }, "schema": { "$ref": "#/components/schemas/AllDocsResult" } } }, "description": "HTTP response for getLocalDocs and postLocalDocs.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "AllDocsResultPartition": { "content": { "application/json": { "examples": { "AllDocsResultPartition": { "$ref": "#/components/examples/AllDocsResultPartition" } }, "schema": { "$ref": "#/components/schemas/AllDocsResult" } } }, "description": "HTTP response for getPartitionAllDocs and postPartitionAllDocs.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "AnyJsonObject": { "content": { "application/json": { "examples": { "EmptyJsonObject": { "description": "Example of an empty json object", "value": {} } }, "schema": { "additionalProperties": true, "description": "Any json object", "type": "object" } } }, "description": "HTTP response for arbitrary JSON object.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ApiKeysResult": { "content": { "application/json": { "examples": { "ApiKeysResult": { "$ref": "#/components/examples/ApiKeysResult" } }, "schema": { "$ref": "#/components/schemas/ApiKeysResult" } } }, "description": "HTTP response for postApiKeys.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Attachment": { "content": { "*/*": { "examples": { "AttachmentContent": { "$ref": "#/components/examples/AttachmentContent" } }, "schema": { "$ref": "#/components/schemas/AttachmentContent" } } }, "description": "HTTP response for Attachment.", "headers": { "Accept-Ranges": { "$ref": "#/components/headers/AcceptRanges" }, "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Content-Range": { "$ref": "#/components/headers/ContentRange" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "AttachmentHead": { "description": "HTTP response for Attachment.", "headers": { "Accept-Ranges": { "$ref": "#/components/headers/AcceptRanges" }, "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Content-Range": { "$ref": "#/components/headers/ContentRange" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "BulkDocsResult": { "content": { "application/json": { "examples": { "BulkDocsResult": { "$ref": "#/components/examples/BulkDocsResult" } }, "schema": { "$ref": "#/components/schemas/BulkDocsResult" } } }, "description": "HTTP response for postBulkDocs.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Cost-Write": { "$ref": "#/components/headers/XCloudantCostWrite" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "BulkGetResult": { "content": { "application/json": { "examples": { "BulkGetResult": { "$ref": "#/components/examples/BulkGetResult" }, "BulkGetResultAttsSince": { "$ref": "#/components/examples/BulkGetResultAttsSince" }, "BulkGetResultOpenRevs": { "$ref": "#/components/examples/BulkGetResultOpenRevs" } }, "schema": { "$ref": "#/components/schemas/BulkGetResult" } }, "multipart/mixed": { "encoding": { "results": { "contentType": "multipart/mixed", "headers": { "X-Doc-Id": { "description": "Header returning a document ID.", "schema": { "$ref": "#/components/schemas/DocumentId" } }, "X-Rev-Id": { "description": "Header returning a document revision identifier.", "schema": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" } } } } }, "schema": { "$ref": "#/components/schemas/BulkGetResultMultipart" } }, "multipart/related": { "encoding": { "results": { "contentType": "multipart/related", "headers": { "X-Doc-Id": { "description": "Header returning a document ID.", "schema": { "$ref": "#/components/schemas/DocumentId" } }, "X-Rev-Id": { "description": "Header returning a document revision identifier.", "schema": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" } } } } }, "examples": { "BulkGetResult": { "$ref": "#/components/examples/BulkGetResultMultipart" } }, "schema": { "$ref": "#/components/schemas/BulkGetResultMultipart" } } }, "description": "HTTP response for postBulkGet.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Cost-Lookup": { "$ref": "#/components/headers/XCloudantCostLookup" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "CapacityDatabasesInformation": { "content": { "application/json": { "examples": { "CapacityDatabasesInformation": { "$ref": "#/components/examples/CapacityDatabasesInformation" } }, "schema": { "$ref": "#/components/schemas/CapacityDatabasesInformation" } } }, "description": "HTTP response for maximum number of databases allowed in an instance.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "CapacityThroughputInformation": { "content": { "application/json": { "examples": { "CapacityThroughputInformation": { "$ref": "#/components/examples/CapacityThroughputInformation" } }, "schema": { "$ref": "#/components/schemas/CapacityThroughputInformation" } } }, "description": "HTTP response for getCapacityThroughputInformation.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "CcmDiagnostics": { "content": { "application/json": { "examples": { "CcmDiagnositics": { "$ref": "#/components/examples/CcmDiagnostics" } }, "schema": { "$ref": "#/components/schemas/CcmDiagnostics" } } }, "description": "HTTP response for getCcmDiagnostics.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ChangesResult": { "content": { "application/json": { "examples": { "ChangesResult": { "$ref": "#/components/examples/ChangesResult" } }, "schema": { "$ref": "#/components/schemas/ChangesResult" } } }, "description": "HTTP response for `/{db}/_changes` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ChangesResultHead": { "description": "HTTP response for `/{db}/_changes` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "CorsInformation": { "content": { "application/json": { "examples": { "CorsInformation": { "$ref": "#/components/examples/CorsConfiguration" } }, "schema": { "$ref": "#/components/schemas/CorsInformation" } } }, "description": "HTTP response for getCorsInformation.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "CurrentDatabasesInformation": { "content": { "application/json": { "examples": { "CurrentDatabasesInformation": { "$ref": "#/components/examples/CurrentDatabasesInformation" } }, "schema": { "$ref": "#/components/schemas/CurrentDatabasesInformation" } } }, "description": "HTTP response for current database count.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "CurrentThroughputInformation": { "content": { "application/json": { "examples": { "CurrentThroughputInformation": { "$ref": "#/components/examples/CurrentThroughputInformation" } }, "schema": { "$ref": "#/components/schemas/CurrentThroughputInformation" } } }, "description": "HTTP response for getCurrentThroughputInformation.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DatabaseInformation": { "content": { "application/json": { "examples": { "DatabaseInformation": { "$ref": "#/components/examples/DatabaseInformation" } }, "schema": { "$ref": "#/components/schemas/DatabaseInformation" } } }, "description": "HTTP response for DatabaseInformation.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DatabaseInformationHead": { "description": "HTTP response for DatabaseInformation.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DatabaseResult": { "content": { "application/json": { "examples": { "Ok": { "$ref": "#/components/examples/Ok" } }, "schema": { "$ref": "#/components/schemas/Ok" } } }, "description": "HTTP response for database creation operation.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Location": { "$ref": "#/components/headers/Location" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DbUpdates": { "content": { "application/json": { "examples": { "DbUpdates": { "$ref": "#/components/examples/DbUpdates" } }, "schema": { "$ref": "#/components/schemas/DbUpdates" } } }, "description": "HTTP response for `/_db_updates` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DbUpdatesHead": { "description": "HTTP response for `/_db_updates` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DbsInfoResults": { "content": { "application/json": { "examples": { "DbsInfoResults": { "$ref": "#/components/examples/DbsInfoResults" } }, "schema": { "$ref": "#/components/schemas/DbsInfoResults" } } }, "description": "HTTP response for postDbsInfo.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DesignDocument": { "content": { "application/json": { "examples": { "DesignDocument": { "$ref": "#/components/examples/DesignDocument" }, "DesignDocumentPartition": { "$ref": "#/components/examples/DesignDocumentPartition" } }, "schema": { "$ref": "#/components/schemas/DesignDocument" } } }, "description": "HTTP response for DesignDocument.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DesignDocumentHead": { "description": "HTTP response for DesignDocument.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DesignDocumentInformation": { "content": { "application/json": { "examples": { "DesignDocumentInformation": { "$ref": "#/components/examples/DesignDocumentInformation" } }, "schema": { "$ref": "#/components/schemas/DesignDocumentInformation" } } }, "description": "HTTP response for `/{db}/_design/{ddoc}/_info` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DesignDocumentInformationHead": { "description": "HTTP response for `/{db}/_design/{ddoc}/_info` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Document": { "content": { "application/json": { "examples": { "Document": { "$ref": "#/components/examples/Document" } }, "schema": { "$ref": "#/components/schemas/Document" } }, "multipart/mixed": { "schema": { "$ref": "#/components/schemas/DocumentMultipart" } }, "multipart/related": { "examples": { "DocumentMultipart": { "$ref": "#/components/examples/DocumentMultipartResponse" } }, "schema": { "$ref": "#/components/schemas/DocumentMultipart" } } }, "description": "HTTP response for Document.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DocumentHead": { "description": "HTTP response for Document.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DocumentResult": { "content": { "application/json": { "examples": { "DocumentResult": { "$ref": "#/components/examples/DocumentResult" }, "DocumentResultDeleted": { "$ref": "#/components/examples/DocumentResultDeleted" }, "DocumentResultUpdated": { "$ref": "#/components/examples/DocumentResultUpdated" } }, "schema": { "$ref": "#/components/schemas/DocumentResult" } } }, "description": "HTTP response for Document modification operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DocumentShardInfo": { "content": { "application/json": { "examples": { "DocumentShardInfo": { "$ref": "#/components/examples/DocumentShardInfo" } }, "schema": { "$ref": "#/components/schemas/DocumentShardInfo" } } }, "description": "HTTP response for `/{db}/_shards/{doc_id}` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "DocumentShardInfoHead": { "description": "HTTP response for `/{db}/_shards/{doc_id}` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "EnsureFullCommitInformation": { "content": { "application/json": { "examples": { "EnsureFullCommitInformation": { "$ref": "#/components/examples/EnsureFullCommitInformation" } }, "schema": { "$ref": "#/components/schemas/EnsureFullCommitInformation" } } }, "description": "HTTP response for postEnsureFullCommit.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error400AuthHeaderInvalid": { "content": { "application/json": { "examples": { "Error400AuthHeaderInvalid": { "$ref": "#/components/examples/Error400AuthHeaderInvalid" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for bad request.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error400BadRequest": { "content": { "application/json": { "examples": { "Error400BadRequest": { "$ref": "#/components/examples/Error400BadRequest" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for bad request.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error400CountParameterTooLarge": { "content": { "application/json": { "examples": { "Error400CountParameterTooLarge": { "$ref": "#/components/examples/Error400CountParameterTooLarge" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for bad request.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error400DatabaseDeletedWithRev": { "content": { "application/json": { "examples": { "Error400DatabaseDeletedWithRev": { "$ref": "#/components/examples/Error400DatabaseDeletedWithRev" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for bad request.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error400DbsInfoMissingKeys": { "content": { "application/json": { "examples": { "Error400DbsInfoMissingKeys": { "$ref": "#/components/examples/Error400DbsInfoMissingKeys" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for bad request.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error400InvalidDatabaseName": { "content": { "application/json": { "examples": { "Error400InvalidDatabaseName": { "$ref": "#/components/examples/Error400InvalidDatabaseName" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for bad request.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error400InvalidJson": { "content": { "application/json": { "examples": { "Error400InvalidJson": { "$ref": "#/components/examples/Error400InvalidJson" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for bad request.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error400InvalidPartition": { "content": { "application/json": { "examples": { "Error400InvalidPartition": { "$ref": "#/components/examples/Error400InvalidPartition" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for bad request.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error400NotSupportedOption": { "content": { "application/json": { "examples": { "Error400NotSupportedOption": { "$ref": "#/components/examples/Error400NotSupportedOption" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for bad request.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error401AdminPrivilegesRequired": { "content": { "application/json": { "examples": { "Error401AdminPrivilegesRequired": { "$ref": "#/components/examples/Error401AdminPrivilegesRequired" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for unauthorized.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error401Unauthorized": { "content": { "application/json": { "examples": { "Error401ReaderPrivilegesRequired": { "$ref": "#/components/examples/Error401ReaderPrivilegesRequired" }, "Error401Unauthorized": { "$ref": "#/components/examples/Error401Unauthorized" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for unauthorized.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error401WriterOrCreatorPrivilegesRequired": { "content": { "application/json": { "examples": { "Error401WriterOrCreatorPrivilegesRequired": { "$ref": "#/components/examples/Error401WriterOrCreatorPrivilegesRequired" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for unauthorized.", "headers": { "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" } } }, "Error401WriterPrivilegesRequired": { "content": { "application/json": { "examples": { "ErrorWriterPrivilegesRequired": { "$ref": "#/components/examples/Error401WriterPrivilegesRequired" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for unauthorized.", "headers": { "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" } } }, "Error402OverDataQuota": { "content": { "application/json": { "examples": { "Error402OverDataQuota": { "$ref": "#/components/examples/Error402OverDataQuota" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for exceeded data usage quota.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error402PaymentRequired": { "content": { "application/json": { "examples": { "Error402PaymentRequired": { "$ref": "#/components/examples/Error402PaymentRequired" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for payment required.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error403Forbidden": { "content": { "application/json": { "examples": { "Error403Forbidden": { "$ref": "#/components/examples/Error403Forbidden" }, "Error403TempAccountLockout": { "$ref": "#/components/examples/Error403TempAccountLockout" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for forbidden.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error404DatabaseDoesNotExist": { "content": { "application/json": { "examples": { "Error404DatabaseDoesNotExist": { "$ref": "#/components/examples/Error404DatabaseDoesNotExist" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for not found.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error404DocumentDoesNotExist": { "content": { "application/json": { "examples": { "Error404DocumentDoesNotExist": { "$ref": "#/components/examples/Error404DocumentDoesNotExist" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for not found.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error404MissingNamedView": { "content": { "application/json": { "examples": { "Error404MissingNamedView": { "$ref": "#/components/examples/Error404MissingNamedView" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for not found.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error404NotFound": { "content": { "application/json": { "examples": { "Error404NotFound": { "$ref": "#/components/examples/Error404NotFound" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for not found.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error408RequestTimeout": { "content": { "application/json": { "examples": { "Error408RequestTimeout": { "$ref": "#/components/examples/Error408RequestTimeout" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for timeout reading client request.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error409DocumentConflict": { "content": { "application/json": { "examples": { "Error409DocumentConflict": { "$ref": "#/components/examples/Error409DocumentConflict" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for conflict.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error410Gone": { "content": { "application/json": { "examples": { "Erro410Gone": { "$ref": "#/components/examples/Error410Gone" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for gone.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error412DatabaseAlreadyExists": { "content": { "application/json": { "examples": { "Error412DatabaseAlreadyExists": { "$ref": "#/components/examples/Error412DatabaseAlreadyExists" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for precondition failed.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error413AttachmentTooLarge": { "content": { "application/json": { "examples": { "Error413AttachmentTooLarge": { "$ref": "#/components/examples/Error413AttachmentTooLarge" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for payload too large.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error413DocumentTooLarge": { "content": { "application/json": { "examples": { "Error413DocumentTooLarge": { "$ref": "#/components/examples/Error413DocumentTooLarge" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for payload too large.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error413TooLarge": { "content": { "application/json": { "examples": { "Error413TooLarge": { "$ref": "#/components/examples/Error413TooLarge" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for payload too large.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error415UnsupportedMediaType": { "content": { "application/json": { "examples": { "Error415UnsupportedMediaType": { "$ref": "#/components/examples/Error415UnsupportedMediaType" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for unsupported media type.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error416RangeNotSatisfiable": { "content": { "application/json": { "examples": { "Error416RangeNotSatisfiable": { "$ref": "#/components/examples/Error416RangeNotSatisfiable" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for range not satisfiable.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error429TooManyRequests": { "content": { "application/json": { "examples": { "Error429TooManyRequests": { "$ref": "#/components/examples/Error429TooManyRequests" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for too many requests.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error500UnknownError": { "content": { "application/json": { "examples": { "Error500UnknownError": { "$ref": "#/components/examples/Error500UnknownError" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for internal server error.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error502BadGateway": { "content": { "application/json": { "examples": { "Error502BadGateway": { "$ref": "#/components/examples/Error502BadGateway" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for bad gateway.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error503ServiceUnavailable": { "content": { "application/json": { "examples": { "Error503ServiceUnavailable": { "$ref": "#/components/examples/Error503ServiceUnavailable" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for service unavailable.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error504GatewayTimeout": { "content": { "application/json": { "examples": { "Error504GatewayTimeout": { "$ref": "#/components/examples/Error504GatewayTimeout" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "HTTP error for gateway timeout.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Error507InsufficientStorage": { "content": { "application/json": { "examples": { "Error507InsufficientStorage": { "$ref": "#/components/examples/Error507InsufficientStorage" } }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "There is insufficient storage space to complete the request.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ExplainResult": { "content": { "application/json": { "examples": { "ExplainResult": { "$ref": "#/components/examples/ExplainResult" } }, "schema": { "$ref": "#/components/schemas/ExplainResult" } } }, "description": "HTTP response for postExplain.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "FindResult": { "content": { "application/json": { "examples": { "FindResult": { "$ref": "#/components/examples/FindResult" } }, "schema": { "$ref": "#/components/schemas/FindResult" } } }, "description": "HTTP response for postFind.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "FindResultPartition": { "content": { "application/json": { "examples": { "FindResultPartition": { "$ref": "#/components/examples/FindResultPartition" } }, "schema": { "$ref": "#/components/schemas/FindResult" } } }, "description": "HTTP response for postPartitionFind.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "IamSessionInformation": { "content": { "application/json": { "examples": { "IamSessionInformation": { "$ref": "#/components/examples/IamSessionInformation" } }, "schema": { "$ref": "#/components/schemas/IamSessionInformation" } } }, "description": "HTTP response for getIamSessionInformation.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "IamSessionResult": { "content": { "application/json": { "examples": { "IamSessionResult": { "$ref": "#/components/examples/Ok" } }, "schema": { "$ref": "#/components/schemas/Ok" } } }, "description": "HTTP response for postIamSession.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "IndexResult": { "content": { "application/json": { "examples": { "IndexResult": { "$ref": "#/components/examples/IndexResult" } }, "schema": { "$ref": "#/components/schemas/IndexResult" } } }, "description": "HTTP response for postIndex.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "IndexesInformation": { "content": { "application/json": { "examples": { "IndexInformation": { "$ref": "#/components/examples/IndexesInformation" } }, "schema": { "$ref": "#/components/schemas/IndexesInformation" } } }, "description": "HTTP response for `/{db}/_index` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "IndexesInformationHead": { "description": "HTTP response for `/{db}/_index` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "MembershipInformation": { "content": { "application/json": { "examples": { "MembershipInformation": { "$ref": "#/components/examples/MembershipInformation" } }, "schema": { "$ref": "#/components/schemas/MembershipInformation" } } }, "description": "HTTP response for `/_membership` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "MembershipInformationHead": { "description": "HTTP response for `/_membership` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "MissingRevsResult": { "content": { "application/json": { "examples": { "MissingRevsResult": { "$ref": "#/components/examples/MissingRevsResult" } }, "schema": { "$ref": "#/components/schemas/MissingRevsResult" } } }, "description": "HTTP response for postMissingRevs.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "NodeStatsInformation": { "content": { "application/json": { "examples": { "NodeStats": { "$ref": "#/components/examples/NodeStatsInformation" } }, "schema": { "$ref": "#/components/schemas/NodeStatsInformation" } } }, "description": "HTTP response for `/_node/{node_name}/_stats` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "NodeStatsInformationHead": { "description": "HTTP response for `/_node/{node_name}/_stats` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "NodeSystemInformation": { "content": { "application/json": { "examples": { "NodeSystem": { "$ref": "#/components/examples/NodeSystemInformation" } }, "schema": { "$ref": "#/components/schemas/NodeSystemInformation" } } }, "description": "HTTP response for `/_node/{node_name}/_system` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "NodeSystemInformationHead": { "description": "HTTP response for `/_node/{node_name}/_system` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "NotModified": { "description": "HTTP response for not modified client redirect.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Ok": { "content": { "application/json": { "examples": { "OkTrue": { "$ref": "#/components/examples/Ok" } }, "schema": { "$ref": "#/components/schemas/Ok" } } }, "description": "HTTP response for Ok operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "PartitionInformation": { "content": { "application/json": { "examples": { "PartitionInformation": { "$ref": "#/components/examples/PartitionInformation" } }, "schema": { "$ref": "#/components/schemas/PartitionInformation" } } }, "description": "HTTP response for `/{db}/_partition/{partition_key}` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "PartitionInformationHead": { "description": "HTTP response for `/{db}/_partition/{partition_key}` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReplicationDocument": { "content": { "application/json": { "examples": { "ReplicationDocument": { "$ref": "#/components/examples/ReplicationDocument" } }, "schema": { "$ref": "#/components/schemas/ReplicationDocument" } } }, "description": "HTTP response for ReplicationDocument.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReplicationDocumentHead": { "description": "HTTP response for ReplicationDocument.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReplicationInformation": { "content": { "application/json": { "examples": { "ReplicationInformation": { "$ref": "#/components/examples/ReplicationInformation" } }, "schema": { "$ref": "#/components/schemas/ReplicationInformation" } } }, "description": "HTTP response for postReplicate.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReplicationResult": { "content": { "application/json": { "examples": { "ReplicationResult": { "$ref": "#/components/examples/ReplicationResult" } }, "schema": { "$ref": "#/components/schemas/ReplicationResult" } } }, "description": "HTTP response for postReplicate.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReshardInformation": { "content": { "application/json": { "examples": { "ReshardInformation": { "$ref": "#/components/examples/ReshardInformation" } }, "schema": { "$ref": "#/components/schemas/ReshardInformation" } } }, "description": "HTTP response for `/_reshard` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReshardInformationHead": { "description": "HTTP response for `/_reshard` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReshardJobInformation": { "content": { "application/json": { "examples": { "ReshardJobInformation": { "$ref": "#/components/examples/ReshardJobInformation" } }, "schema": { "$ref": "#/components/schemas/ReshardJobInformation" } } }, "description": "HTTP response for `/_reshard/jobs/{reshard_job_id}` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReshardJobInformationHead": { "description": "HTTP response for `/_reshard/jobs/{reshard_job_id}` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReshardJobsInformation": { "content": { "application/json": { "examples": { "ReshardJobsInformation": { "$ref": "#/components/examples/ReshardJobsInformation" } }, "schema": { "$ref": "#/components/schemas/ReshardJobsInformation" } } }, "description": "HTTP response for `/_reshard/jobs` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReshardJobsInformationHead": { "description": "HTTP response for `/_reshard/jobs` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReshardJobsResult": { "content": { "application/json": { "examples": { "ReshardJobsResult": { "$ref": "#/components/examples/ReshardJobsResult" } }, "schema": { "$ref": "#/components/schemas/ReshardJobsResult" } } }, "description": "HTTP response for postReshardJobsConfiguration.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReshardState": { "content": { "application/json": { "examples": { "ReshardStateCluster": { "$ref": "#/components/examples/ReshardStateCluster" }, "ReshardStateJob": { "$ref": "#/components/examples/ReshardStateJob" } }, "schema": { "$ref": "#/components/schemas/ReshardState" } } }, "description": "HTTP response for `/_reshard/state` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ReshardStateHead": { "description": "HTTP response for `/_reshard/state` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "RevsDiffResult": { "content": { "application/json": { "examples": { "RevsDiffResult": { "$ref": "#/components/examples/RevsDiffResult" } }, "schema": { "$ref": "#/components/schemas/RevsDiffResult" } } }, "description": "HTTP response for postRevsDiff.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "RevsLimit": { "content": { "application/json": { "examples": { "RevsLimit": { "$ref": "#/components/examples/RevsLimit" } }, "schema": { "$ref": "#/components/schemas/RevsLimit" } } }, "description": "HTTP response for `/{db}/_revs_limit` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "RevsLimitHead": { "description": "HTTP response for `/{db}/_revs_limit` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SchedulerDocsResult": { "content": { "application/json": { "examples": { "SchedulerDocsResult": { "$ref": "#/components/examples/SchedulerDocsResult" } }, "schema": { "$ref": "#/components/schemas/SchedulerDocsResult" } } }, "description": "HTTP response for `/_scheduler/docs` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SchedulerDocsResultHead": { "description": "HTTP response for `/_scheduler/docs` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SchedulerDocument": { "content": { "application/json": { "examples": { "SchedulerDocResult": { "$ref": "#/components/examples/SchedulerDocument" } }, "schema": { "$ref": "#/components/schemas/SchedulerDocument" } } }, "description": "HTTP response for `/_scheduler/docs/_replicator/{doc_id}` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SchedulerDocumentHead": { "description": "HTTP response for `/_scheduler/docs/_replicator/{doc_id}` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SchedulerJob": { "content": { "application/json": { "examples": { "SchedulerDocResult": { "$ref": "#/components/examples/SchedulerJob" } }, "schema": { "$ref": "#/components/schemas/SchedulerJob" } } }, "description": "HTTP response for SchedulerJob.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SchedulerJobHead": { "description": "HTTP response for SchedulerJob.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SchedulerJobsResult": { "content": { "application/json": { "examples": { "SchedulerJobsResult": { "$ref": "#/components/examples/SchedulerJobsResult" } }, "schema": { "$ref": "#/components/schemas/SchedulerJobsResult" } } }, "description": "HTTP response for `/_scheduler/jobs` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SchedulerJobsResultHead": { "description": "HTTP response for `/_scheduler/jobs` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SearchAnalyzeResult": { "content": { "application/json": { "examples": { "SearchAnalyzeResult": { "$ref": "#/components/examples/SearchAnalyzeResult" } }, "schema": { "$ref": "#/components/schemas/SearchAnalyzeResult" } } }, "description": "HTTP response for postSearchAnalyzer.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SearchAnalyzeResultHead": { "description": "HTTP response for search analyze operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SearchDiskSizeInformation": { "content": { "application/json": { "examples": { "SearchDiskSizeInformation": { "$ref": "#/components/examples/SearchDiskSizeInformation" } }, "schema": { "$ref": "#/components/schemas/SearchDiskSizeInformation" } } }, "description": "HTTP response for search disk size operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SearchDiskSizeInformationHead": { "description": "HTTP response for search disk size operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SearchInfoResult": { "content": { "application/json": { "examples": { "SearchInfoResult": { "$ref": "#/components/examples/SearchInfoResult" } }, "schema": { "$ref": "#/components/schemas/SearchInfoResult" } } }, "description": "HTTP response for search index info operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SearchInfoResultHead": { "description": "HTTP response for search index info operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SearchResult": { "content": { "application/json": { "examples": { "SearchResult": { "$ref": "#/components/examples/SearchResult" } }, "schema": { "$ref": "#/components/schemas/SearchResult" } } }, "description": "HTTP response for search operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SearchResultHead": { "description": "HTTP response for search operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SearchResultPartition": { "content": { "application/json": { "examples": { "SearchResultPartition": { "$ref": "#/components/examples/SearchResultPartition" } }, "schema": { "$ref": "#/components/schemas/SearchResult" } } }, "description": "HTTP response for search operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "Security": { "content": { "application/json": { "examples": { "Security": { "$ref": "#/components/examples/SecurityResult" } }, "schema": { "$ref": "#/components/schemas/Security" } } }, "description": "HTTP response for security information.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SecurityHead": { "description": "HTTP response for `/{db}/_security` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ServerInformation": { "content": { "application/json": { "examples": { "ServerInformation": { "$ref": "#/components/examples/ServerInformation" } }, "schema": { "$ref": "#/components/schemas/ServerInformation" } } }, "description": "HTTP response for `/` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ServerInformationHead": { "description": "HTTP response for `/` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SessionInformation": { "content": { "application/json": { "examples": { "SessionInformation": { "$ref": "#/components/examples/SessionInformation" } }, "schema": { "$ref": "#/components/schemas/SessionInformation" } } }, "description": "HTTP response for `/_session` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SessionInformationHead": { "description": "HTTP response for `/_session` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "SessionResult": { "content": { "application/json": { "examples": { "SessionResult": { "$ref": "#/components/examples/SessionResult" } }, "schema": { "$ref": "#/components/schemas/SessionResult" } } }, "description": "HTTP response for postSession.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Set-Cookie": { "$ref": "#/components/headers/SetCookie" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ShardsInformation": { "content": { "application/json": { "examples": { "ShardsInformation": { "$ref": "#/components/examples/ShardsInformation" } }, "schema": { "$ref": "#/components/schemas/ShardsInformation" } } }, "description": "HTTP response for `/{db}/_shards` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ShardsInformationHead": { "description": "HTTP response for `/{db}/_shards` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "UpInformation": { "content": { "application/json": { "examples": { "UpInformationOk": { "$ref": "#/components/examples/UpInformationOk" } }, "schema": { "$ref": "#/components/schemas/UpInformation" } } }, "description": "HTTP response for `/_up` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "UpInformationHead": { "description": "HTTP response for `/_up` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "UsageDataVolume": { "content": { "application/json": { "examples": { "UsageDataVolume": { "$ref": "#/components/examples/UsageDataVolume" } }, "schema": { "$ref": "#/components/schemas/UsageDataVolume" } } }, "description": "HTTP response for getUsageDataVolume.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "UserInformation": { "content": { "application/json": { "examples": { "UserInformation": { "$ref": "#/components/examples/UserInformation" } }, "schema": { "$ref": "#/components/schemas/UserInformation" } } }, "description": "HTTP response for getUserInformation.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "UserPlan": { "content": { "application/json": { "examples": { "UserPlan": { "$ref": "#/components/examples/UserPlan" } }, "schema": { "$ref": "#/components/schemas/UserPlan" } } }, "description": "HTTP response for putUserPlan.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "UuidsResult": { "content": { "application/json": { "examples": { "UuidsResult": { "$ref": "#/components/examples/UuidsResult" } }, "schema": { "$ref": "#/components/schemas/UuidsResult" } } }, "description": "HTTP response for `/_uuids` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "UuidsResultHead": { "description": "HTTP response for `/_uuids` style operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "ETag": { "$ref": "#/components/headers/ETag" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ViewQueriesResult": { "content": { "application/json": { "examples": { "ViewQueriesResult": { "$ref": "#/components/examples/ViewQueriesResult" } }, "schema": { "$ref": "#/components/schemas/ViewQueriesResult" } } }, "description": "HTTP response for postViewQueries.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ViewResult": { "content": { "application/json": { "examples": { "ViewResult": { "$ref": "#/components/examples/ViewResult" } }, "schema": { "$ref": "#/components/schemas/ViewResult" } } }, "description": "HTTP response for view operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ViewResultHead": { "description": "HTTP response for view operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Content-Length": { "$ref": "#/components/headers/ContentLength" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } }, "ViewResultPartition": { "content": { "application/json": { "examples": { "ViewResultPartition": { "$ref": "#/components/examples/ViewResultPartition" } }, "schema": { "$ref": "#/components/schemas/ViewResult" } } }, "description": "HTTP response for view operations.", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Content-Encoding": { "$ref": "#/components/headers/ContentEncoding" }, "Date": { "$ref": "#/components/headers/Date" }, "Server": { "$ref": "#/components/headers/Server" }, "Transfer-Encoding": { "$ref": "#/components/headers/TransferEncoding" }, "Via": { "$ref": "#/components/headers/Via" }, "X-Cloudant-Action": { "$ref": "#/components/headers/XCloudantAction" }, "X-Cloudant-Backend": { "$ref": "#/components/headers/XCloudantBackend" }, "X-Cloudant-Request-Class": { "$ref": "#/components/headers/XCloudantRequestClass" }, "X-Request-ID": { "$ref": "#/components/headers/XRequestId" } } } }, "schemas": { "ActiveTask": { "additionalProperties": false, "description": "Schema for information about a running task.", "properties": { "bulk_get_attempts": { "description": "The total count of attempted doc revisions fetched with `_bulk_get`. Available for `replication` type tasks.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "bulk_get_docs": { "description": "The total count of successful docs fetched with `_bulk_get`. Available for `replication` type tasks.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "changes_done": { "description": "Processed changes. Available for `database_compaction`, `indexer`, `search_indexer`, `view_compaction` type tasks.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "changes_pending": { "description": "The count of changes not yet replicated. Available for `replication` type tasks.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "checkpoint_interval": { "default": 30000, "description": "Specifies the checkpoint interval in ms. Available for `replication` type tasks.", "format": "int64", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "checkpointed_source_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "The source sequence id which was last successfully replicated. Available for `replication` type tasks." } ] }, "continuous": { "default": false, "description": "The replication configured to be continuous. Available for `replication` type tasks.", "type": "boolean" }, "database": { "allOf": [ { "$ref": "#/components/schemas/DatabaseName" }, { "description": "Source database." } ] }, "design_document": { "allOf": [ { "$ref": "#/components/schemas/DesignDocumentId" }, { "description": "The design document that belongs to this task. Available for `indexer`, `search_indexer`, `view_compaction` type tasks." } ] }, "doc_id": { "allOf": [ { "$ref": "#/components/schemas/DocumentId" }, { "description": "Replication document ID. Available for `replication` type tasks." } ] }, "doc_write_failures": { "description": "Number of document write failures. Available for `replication` type tasks.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "docs_read": { "description": "Number of documents read. Available for `replication` type tasks.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "docs_written": { "description": "Number of documents written to target. Available for `replication` type tasks.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "index": { "allOf": [ { "$ref": "#/components/schemas/IndexName" }, { "description": "The search index that belongs to this task. Available for `search_indexer` type tasks." } ] }, "indexer_pid": { "description": "Indexer process ID. Available for `indexer` type tasks.", "maxLength": 34, "minLength": 1, "pattern": "^.+$", "type": "string" }, "missing_revisions_found": { "description": "The count of docs which have been read from the source. Available for `replication` type tasks.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "node": { "description": "Cluster node where the task is running.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "phase": { "description": "The phase the active task is in. `docid_sort`, `docid_copy`, `document_copy` phases are available for `database_compaction`, while `ids` and `view` phases are available for `view_compaction` type tasks.", "enum": [ "docid_sort", "docid_copy", "document_copy", "ids", "view" ], "type": "string" }, "pid": { "description": "Process ID.", "maxLength": 34, "minLength": 1, "pattern": "^.+$", "type": "string" }, "process_status": { "description": "Process status.", "enum": [ "exiting", "garbage_collecting", "runnable", "running", "suspended", "waiting" ], "type": "string" }, "progress": { "description": "Current percentage progress. Available for `database_compaction`, `indexer`, `search_indexer`, `view_compaction` type tasks.", "format": "int64", "maximum": 100, "minimum": 0, "type": "integer" }, "replication_id": { "description": "Replication ID. Available for `replication` type tasks.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "retry": { "description": "Indicates whether a compaction retry is currently running on the database. Available for `database_compaction` type tasks.", "type": "boolean" }, "revisions_checked": { "description": "The count of revisions which have been checked since this replication began. Available for `replication` type tasks.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "source": { "allOf": [ { "$ref": "#/components/schemas/DatabaseUrl" }, { "description": "Replication source. Available for `replication` type tasks." } ] }, "source_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "The last sequence number obtained from the source database changes feed. Available for `replication` type tasks." } ] }, "started_on": { "$ref": "#/components/schemas/Timestamp" }, "target": { "allOf": [ { "$ref": "#/components/schemas/DatabaseUrl" }, { "description": "Replication target. Available for `replication` type tasks." } ] }, "through_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "The last sequence number processed by the replicator. Available for `replication` type tasks." } ] }, "total_changes": { "description": "Total changes to process. Available for `database_compaction`, `indexer`, `search_indexer`, `view_compaction` type tasks.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "type": { "description": "Operation type.", "enum": [ "database_compaction", "indexer", "replication", "search_indexer", "view_compaction" ], "type": "string" }, "updated_on": { "$ref": "#/components/schemas/Timestamp" }, "user": { "$ref": "#/components/schemas/UsernameNullable" }, "view": { "description": "Number of view indexes. Available for `view_compaction` type tasks.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "database", "node", "pid", "started_on", "type", "updated_on" ], "type": "object" }, "ActiveTasks": { "description": "Schema for a list of ActiveTask elements.", "items": { "$ref": "#/components/schemas/ActiveTask" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "ActivityTrackerEvents": { "additionalProperties": false, "description": "Schema for activity tracking events.", "properties": { "types": { "description": "An array of event types sent to IBM Cloud Activity Tracker Event Routing for the IBM Cloudant instance. \"management\" is a required element of this array.", "items": { "enum": [ "management", "data" ], "type": "string" }, "maxItems": 2, "minItems": 1, "type": "array", "uniqueItems": true, "x-cli-description": "An array of event types sent to IBM Cloud Activity Tracker Event Routing for the IBM Cloudant instance. \"management\" is a required element of this array." } }, "required": [ "types" ], "x-terraform-datasource-name": "cloudant_activity_tracker_events", "x-terraform-resource-id": "types", "x-terraform-resource-name": "cloudant_activity_tracker_events", "x-terraform-resource-operations": { "create": "postActivityTrackerEvents", "delete": "postActivityTrackerEvents", "read": "getActivityTrackerEvents" } }, "AllDbs": { "description": "Schema for a list of database names.", "items": { "$ref": "#/components/schemas/DatabaseName" }, "maxItems": 200, "minItems": 0, "type": "array" }, "AllDocsQueriesQuery": { "additionalProperties": false, "description": "Schema for an all documents queries operation.", "properties": { "queries": { "description": "An array of query objects with fields for the parameters of each individual view query to be executed. The field names and their meaning are the same as the query parameters of a regular `/_all_docs` request.", "items": { "$ref": "#/components/schemas/AllDocsQuery" }, "maxItems": 65535, "minItems": 1, "type": "array" } }, "required": [ "queries" ], "type": "object" }, "AllDocsQueriesResult": { "additionalProperties": false, "description": "Schema for the result of an all documents queries operation.", "properties": { "results": { "description": "An array of result objects - one for each query. Each result object contains the same fields as the response to a regular `/_all_docs` request.", "items": { "$ref": "#/components/schemas/AllDocsResult" }, "maxItems": 65535, "minItems": 1, "type": "array" } }, "required": [ "results" ], "type": "object" }, "AllDocsQuery": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/CommonViewQuery" }, { "additionalProperties": false, "description": "Schema for an all documents query operation.", "properties": { "end_key": { "$ref": "#/components/schemas/DocumentId" }, "key": { "$ref": "#/components/schemas/DocumentId" }, "keys": { "$ref": "#/components/schemas/DocumentIds" }, "start_key": { "$ref": "#/components/schemas/DocumentId" } }, "type": "object", "x-alias": { "end_key": "endkey", "start_key": "startkey" } } ], "description": "Schema for an all documents query operation.", "type": "object" }, "AllDocsResult": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/DocsResult" }, { "$ref": "#/components/schemas/CommonViewResultUpdateSeq" } ], "description": "Schema for the result of an all documents operation." }, "Analyzer": { "additionalProperties": false, "description": "Schema for a full text search analyzer.", "properties": { "name": { "$ref": "#/components/schemas/AnalyzerName" }, "stopwords": { "description": "Custom stopwords to use with the named analyzer where supported. Not used for `keyword`, `simple`, `whitespace`, `simple_asciifolding` or `perfield` analyzers. Ensure stopwords match the folded case for analyzers that perform folding.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "required": [ "name" ], "type": "object" }, "AnalyzerConfiguration": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/Analyzer" }, { "additionalProperties": false, "properties": { "default": { "$ref": "#/components/schemas/Analyzer" }, "fields": { "$ref": "#/components/schemas/AnalyzerFields" } }, "type": "object" } ], "description": "Analyzer configuration for search indexes. The default and fields properties are only applicable for the `perfield` analyzer name." }, "AnalyzerFields": { "additionalProperties": { "$ref": "#/components/schemas/Analyzer" }, "description": "Schema for mapping a field name to a per field analyzer.", "type": "object" }, "AnalyzerName": { "description": "Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies depending on the analyzer usage:\n* For search indexes the default is `standard`\n* For query text indexes the default is `keyword`\n* For a query text index default_field the default is `standard`", "enum": [ "classic", "email", "keyword", "perfield", "simple", "simple_asciifolding", "standard", "whitespace", "arabic", "armenian", "basque", "brazilian", "bulgarian", "catalan", "chinese", "cjk", "czech", "danish", "dutch", "english", "finnish", "french", "galician", "german", "greek", "hindi", "hungarian", "indonesian", "irish", "italian", "japanese", "latvian", "norwegian", "persian", "polish", "portuguese", "romanian", "russian", "spanish", "swedish", "thai", "turkish" ], "type": "string" }, "AnyJsonType": { "description": "Schema for any JSON type", "nullable": true }, "ApiKeysResult": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/Ok" }, { "additionalProperties": false, "properties": { "key": { "description": "The generated api key.", "maxLength": 44, "minLength": 1, "pattern": "^[A-Za-z0-9_-]{2,}$", "type": "string" }, "password": { "description": "The password associated with the api key.", "maxLength": 7168, "minLength": 40, "pattern": "^[\\da-f]+$", "type": "string" } } } ], "description": "Schema for api keys.", "required": [ "key", "ok", "password" ], "type": "object" }, "Attachment": { "additionalProperties": false, "description": "Schema for an attachment.", "properties": { "content_type": { "description": "Attachment MIME type.", "maxLength": 7168, "minLength": 1, "pattern": "^.+\\/.+(?:;.+=.+)*$", "type": "string" }, "data": { "description": "Base64-encoded content. Available when requested with `attachments=true` or `atts_since`. When retrieving attachments for a single document this field is only avialable when accepting an application/json response. For multipart responses each attachment is instead included in a separate part of the response (see `follows`).\n\nNote that SDK deserialization of documents with included attachments automatically decodes the Base64 encoded attachment content string to bytes.", "format": "byte", "maxLength": 13981014, "minLength": 1, "pattern": "^[A-Za-z0-9+\\/]{2,}={0,3}$", "type": "string" }, "digest": { "description": "Content hash digest. It starts with prefix declaring the hash type, `md5-` for example, and continues with the Base64-encoded hash digest.", "maxLength": 7168, "minLength": 28, "pattern": "^[\\w\\d]+-[A-Za-z0-9+\\/]{2,}={0,3}$", "type": "string" }, "encoded_length": { "description": "Compressed attachment size in bytes. Available for compressed attachments when requested with `att_encoding_info`. The database compresses attachments if the content_type is in the list of compressible types when added.", "format": "int64", "maximum": 10485760, "minimum": 0, "type": "integer" }, "encoding": { "description": "Compression codec. Available for compressed attachments when requested with `att_encoding_info`. The database compresses attachments if the content_type is in the list of compressible types when added.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "follows": { "description": "True if the attachment follows in a multipart request or response.", "type": "boolean" }, "length": { "description": "Real attachment size in bytes. Not available if inline attachment content requested.", "format": "int64", "maximum": 10485760, "minimum": 0, "type": "integer" }, "revpos": { "description": "Revision number at attachment addition.", "format": "int64", "maximum": 4294967295, "minimum": 1, "type": "integer" }, "stub": { "description": "Has `true` value if object has stub attachment metadata, but not attachment content. Otherwise omitted in response.", "type": "boolean" } }, "type": "object" }, "AttachmentContent": { "description": "Schema for the data in an attachment.", "format": "binary", "maxLength": 10485760, "minLength": 0, "pattern": "^(?:.|\\r?\\n)*$", "type": "string" }, "Attachments": { "additionalProperties": { "$ref": "#/components/schemas/Attachment" }, "description": "Schema for a map of attachment name to attachment metadata.", "type": "object" }, "Bookmark": { "description": "Opaque bookmark token used when paginating results.", "maxLength": 7168, "minLength": 3, "pattern": "^[A-Za-z0-9=_-]*$", "type": "string" }, "BulkDocs": { "additionalProperties": false, "description": "Schema for submitting documents for bulk modifications.", "properties": { "docs": { "description": "Array of documents", "items": { "$ref": "#/components/schemas/Document" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "new_edits": { "default": true, "description": "If `false`, prevents the database from assigning them new\nrevision IDs. Default is `true`.\n\nAvoid using this parameter, since this option applies document\nrevisions without checking for conflicts, so it is very easy to\naccidentally end up with a large number of conflicts.", "type": "boolean" } }, "required": [ "docs" ], "type": "object" }, "BulkDocsResult": { "description": "Schema for a list of response statuses for each document in a bulk documents operation.", "items": { "$ref": "#/components/schemas/DocumentResult" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "BulkGetQuery": { "additionalProperties": false, "description": "Schema for requesting information about multiple documents.", "properties": { "docs": { "description": "List of document items to get in bulk.", "items": { "$ref": "#/components/schemas/BulkGetQueryDocument" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "required": [ "docs" ], "type": "object" }, "BulkGetQueryDocument": { "additionalProperties": false, "description": "Schema for a document item in a bulk get query.", "properties": { "atts_since": { "description": "Includes attachments only since specified revisions.", "example": [ "1-99b02e08da151943c2dcb40090160bb8" ], "items": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "id": { "$ref": "#/components/schemas/DocumentId" }, "rev": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" } }, "required": [ "id" ], "type": "object" }, "BulkGetResult": { "additionalProperties": false, "description": "Schema for the results object of a bulk get operation.", "properties": { "results": { "description": "Results", "items": { "$ref": "#/components/schemas/BulkGetResultItem" }, "maxItems": 4294967295, "minItems": 0, "type": "array" } }, "required": [ "results" ], "type": "object" }, "BulkGetResultDocument": { "additionalProperties": false, "description": "Schema for BulkGetResult object containing a successfully retrieved document or error information.", "properties": { "error": { "$ref": "#/components/schemas/DocumentResult" }, "ok": { "$ref": "#/components/schemas/Document" } }, "type": "object" }, "BulkGetResultItem": { "additionalProperties": false, "description": "Schema for the document revisions information from a bulk get operation.", "properties": { "docs": { "description": "Array of document revisions or error information", "items": { "$ref": "#/components/schemas/BulkGetResultDocument" }, "maxItems": 4294967295, "minItems": 1, "type": "array" }, "id": { "$ref": "#/components/schemas/DocumentId" } }, "required": [ "docs", "id" ], "type": "object" }, "BulkGetResultMultipart": { "additionalProperties": false, "description": "Schema for a multipart bulk get result.", "properties": { "results": { "description": "Schema for results of a multipart bulk get.", "items": { "$ref": "#/components/schemas/BulkGetResultMultipartItem" }, "maxItems": 4294967295, "minItems": 0, "type": "array" } }, "required": [ "results" ], "type": "object" }, "BulkGetResultMultipartItem": { "additionalProperties": false, "description": "Schema for multipart bulk get items. It can be either a multipart document response or an error document result.", "oneOf": [ { "$ref": "#/components/schemas/DocumentMultipart" }, { "$ref": "#/components/schemas/DocumentResult" } ] }, "CapacityDatabasesInformation": { "additionalProperties": false, "description": "Schema for information about maximum total database count.", "properties": { "current": { "$ref": "#/components/schemas/CapacityDatabasesInformationCurrent" } }, "type": "object" }, "CapacityDatabasesInformationCurrent": { "additionalProperties": false, "description": "Schema for information about the current database capacity.", "properties": { "databases": { "$ref": "#/components/schemas/DatabasesCountInformation" } }, "type": "object" }, "CapacityThroughputConfiguration": { "additionalProperties": false, "description": "Schema for setting a throughput capacity.", "properties": { "blocks": { "$ref": "#/components/schemas/ThroughputBlocks" } }, "required": [ "blocks" ], "type": "object" }, "CapacityThroughputInformation": { "additionalProperties": false, "description": "Schema for information about the currently provisioned and target throughput capacity.", "properties": { "current": { "$ref": "#/components/schemas/CapacityThroughputInformationCurrent" }, "target": { "$ref": "#/components/schemas/CapacityThroughputInformationTarget" } }, "required": [ "current" ], "type": "object", "x-terraform-datasource-name": "cloudant_capacity_throughput", "x-terraform-resource-id": "current", "x-terraform-resource-name": "cloudant_capacity_throughput", "x-terraform-resource-operations": { "create": "putCapacityThroughputConfiguration", "delete": "putCapacityThroughputConfiguration", "read": "getCapacityThroughputInformation" } }, "CapacityThroughputInformationCurrent": { "additionalProperties": false, "description": "Detailed information about provisioned throughput capacity.", "properties": { "throughput": { "$ref": "#/components/schemas/ThroughputInformation" } }, "required": [ "throughput" ], "type": "object" }, "CapacityThroughputInformationTarget": { "additionalProperties": false, "description": "Detailed information about target throughput capacity.", "properties": { "throughput": { "$ref": "#/components/schemas/ThroughputInformation" } }, "required": [ "throughput" ], "type": "object", "x-terraform-exclude": true }, "CcmDiagnostics": { "additionalProperties": false, "description": "Schema for CcmDiagnostics.", "properties": { "account": { "allOf": [ { "$ref": "#/components/schemas/Username" }, { "description": "The account name for the authenticated user." } ] }, "deny429History": { "$ref": "#/components/schemas/CcmDiagnosticsHistory" }, "lookup": { "description": "Lookup count from HAProxy for the user.", "format": "int64", "maximum": 21689584840, "minimum": 0, "type": "integer" }, "operationHistory": { "$ref": "#/components/schemas/CcmDiagnosticsHistory" }, "query": { "description": "Query count from HAProxy for the user.", "format": "int64", "maximum": 21474836475, "minimum": 0, "type": "integer" }, "ts": { "$ref": "#/components/schemas/Timestamp" }, "write": { "description": "Write count from HAProxy for the user.", "format": "int64", "maximum": 21474836475, "minimum": 0, "type": "integer" } }, "required": [ "deny429History", "operationHistory" ], "type": "object" }, "CcmDiagnosticsDataPoint": { "additionalProperties": false, "description": "Schema for CcmDiagnosticsDataPoint.", "properties": { "lookup": { "description": "Lookup count from HAProxy for the user.", "format": "int64", "maximum": 4337916968, "minimum": 0, "type": "integer" }, "query": { "description": "Query count from HAProxy for the user.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "ts": { "$ref": "#/components/schemas/Timestamp" }, "write": { "description": "Write count from HAProxy for the user.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "type": "object" }, "CcmDiagnosticsHistory": { "description": "Schema for a history of requests.", "items": { "$ref": "#/components/schemas/CcmDiagnosticsDataPoint" }, "maxItems": 5, "minItems": 0, "type": "array" }, "CcmDiagnosticsThroughputInformation": { "additionalProperties": false, "description": "Schema for CcmDiagnostics version of throughput information.", "properties": { "lookup": { "description": "Provisioned reads capacity in operations per second", "format": "int64", "maximum": 50000, "minimum": 0, "type": "integer" }, "query": { "description": "Provisioned global queries capacity in operations per second", "format": "int64", "maximum": 2500, "minimum": 0, "type": "integer" }, "write": { "description": "Provisioned writes capacity in operations per second", "format": "int64", "maximum": 25000, "minimum": 0, "type": "integer" } }, "required": [ "lookup", "query", "write" ], "type": "object" }, "Change": { "additionalProperties": false, "description": "Schema for a document leaf with single field rev.", "properties": { "rev": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" } }, "required": [ "rev" ], "type": "object" }, "ChangesQuery": { "additionalProperties": false, "description": "Schema for filtering a list of document changes with built-in filter query. Use the property corresponding to the chosen built-in filter. Use `doc_ids` for `_doc_ids`. Use `selector` for `_selector`. Other filter values do not require any body content.", "properties": { "doc_ids": { "$ref": "#/components/schemas/DocumentIds" }, "fields": { "$ref": "#/components/schemas/Fields" }, "selector": { "$ref": "#/components/schemas/Selector" } }, "type": "object" }, "ChangesResult": { "additionalProperties": false, "description": "Schema for normal changes feed result.", "properties": { "last_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "last_seq" } ] }, "pending": { "description": "pending", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "results": { "description": "results", "items": { "$ref": "#/components/schemas/ChangesResultItem" }, "maxItems": 4294967295, "minItems": 0, "type": "array" } }, "required": [ "last_seq", "pending", "results" ], "type": "object" }, "ChangesResultItem": { "additionalProperties": false, "description": "Schema for an item in the changes results array.", "properties": { "changes": { "description": "List of document's leaves with single field rev.", "items": { "$ref": "#/components/schemas/Change" }, "maxItems": 4294967295, "minItems": 1, "type": "array" }, "deleted": { "description": "if `true` then the document is deleted.", "type": "boolean" }, "doc": { "$ref": "#/components/schemas/Document" }, "id": { "$ref": "#/components/schemas/DocumentId" }, "seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "Update sequence." } ] } }, "required": [ "changes", "id", "seq" ], "type": "object" }, "CloudantSecurityConfiguration": { "additionalProperties": false, "description": "Schema for a Cloudant security document.", "properties": { "admins": { "$ref": "#/components/schemas/SecurityObject" }, "cloudant": { "$ref": "#/components/schemas/SecurityObjectCloudant" }, "couchdb_auth_only": { "description": "Manage permissions using the `_users` database only.", "type": "boolean" }, "members": { "$ref": "#/components/schemas/SecurityObject" } }, "required": [ "cloudant" ], "type": "object" }, "CommonViewQuery": { "additionalProperties": false, "description": "Schema for elements common to all view-like requests.", "properties": { "att_encoding_info": { "default": false, "description": "Parameter to specify whether to include the encoding information for compressed attachments. This only applies when requesting documents in the response.", "type": "boolean" }, "attachments": { "default": false, "description": "Parameter to specify whether to include attachment content in included document content or only the attachment metadata. This only applies when requesting documents in the response.", "type": "boolean" }, "conflicts": { "default": false, "description": "Parameter to specify whether to include a list of conflicted revisions in each returned document. This only applies when requesting documents in the response.", "type": "boolean" }, "descending": { "default": false, "description": "Parameter to specify whether to return the documents in descending by key order.", "type": "boolean" }, "include_docs": { "default": false, "description": "Parameter to specify whether to include the full content of the documents in the response.", "type": "boolean" }, "inclusive_end": { "default": true, "description": "Parameter to specify whether to include the specified end key in the result.", "type": "boolean" }, "limit": { "description": "Parameter to specify the number of returned documents to limit the result to.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "skip": { "default": 0, "description": "Parameter to specify the number of records before starting to return the results.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "sorted": { "default": true, "deprecated": true, "description": "Query parameter to specify whether to sort the returned rows. Setting this to false offers a performance boost. The total_rows and offset fields are not available when false.", "type": "boolean", "x-sdk-exclude": true }, "update_seq": { "default": false, "description": "Parameter to specify whether to include in the response an update_seq value indicating the sequence id of the database the view reflects.", "type": "boolean" } }, "type": "object" }, "CommonViewResult": { "additionalProperties": false, "description": "Schema for offset properties for view like structures.", "properties": { "offset": { "deprecated": true, "description": "Offset where the list started.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer", "x-sdk-exclude": true }, "total_rows": { "allOf": [ { "$ref": "#/components/schemas/TotalRows" }, { "description": "Total number of rows in the view index. Note that if the request query narrows the view this is not the number of matching rows. The number of matching rows, up to the specified `limit`, is the size of the `rows` array." } ] } }, "type": "object" }, "CommonViewResultUpdateSeq": { "additionalProperties": false, "description": "Schema for update sequence for view like structures.", "properties": { "update_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "Current update sequence for the database" } ] } }, "type": "object" }, "ContentInformationSizes": { "additionalProperties": false, "description": "Schema for size information of content.", "properties": { "active": { "description": "The active size of the content, in bytes.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "external": { "description": "The total uncompressed size of the content, in bytes.\n\nThis is the value used for IBM Cloudant storage billing.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "file": { "description": "The total size of the content as stored on disk, in bytes.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "active", "external", "file" ], "type": "object" }, "CorsConfiguration": { "additionalProperties": false, "description": "Schema for a CORS configuration.", "properties": { "allow_credentials": { "default": true, "description": "Boolean value to allow authentication credentials. If set to true, browser requests must be done by using withCredentials = true.", "type": "boolean" }, "enable_cors": { "default": true, "description": "Boolean value to turn CORS on and off.", "type": "boolean" }, "origins": { "description": "An array of strings that contain allowed origin domains. You have to specify the full URL including the protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you have to specify all subdomains used.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^http(s)?:\\/\\/.*$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "required": [ "origins" ], "type": "object", "x-terraform-resource-id": "enable_cors", "x-terraform-resource-name": "cloudant_cors", "x-terraform-resource-operations": { "create": "putCorsConfiguration", "delete": "putCorsConfiguration", "read": "getCorsInformation" } }, "CorsInformation": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/CorsConfiguration" } ], "description": "Schema for information about the CORS configuration.", "required": [ "allow_credentials", "enable_cors" ], "x-terraform-datasource-name": "cloudant_cors" }, "CurrentDatabasesInformation": { "additionalProperties": false, "description": "Schema for information about the current database counts.", "properties": { "databases": { "$ref": "#/components/schemas/DatabasesCountInformation" } }, "type": "object" }, "CurrentThroughputInformation": { "additionalProperties": false, "description": "Schema for information about current consumption of a provisioned throughput capacity.", "properties": { "throughput": { "$ref": "#/components/schemas/CurrentThroughputInformationThroughput" } }, "required": [ "throughput" ], "type": "object" }, "CurrentThroughputInformationThroughput": { "additionalProperties": false, "description": "Detailed information about current consumption.", "properties": { "query": { "description": "Number of global queries conducted against the instance for a given second.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "read": { "description": "Number of reads conducted against the instance for a given second.", "format": "int64", "maximum": 4337916968, "minimum": 0, "type": "integer" }, "write": { "description": "Number of writes conducted against the instance for a given second.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "required": [ "read", "write", "query" ], "type": "object" }, "DatabaseInformation": { "additionalProperties": false, "description": "Schema for information about a database.", "properties": { "cluster": { "$ref": "#/components/schemas/DatabaseInformationCluster" }, "committed_update_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "An opaque string that describes the committed state of the database." } ] }, "compact_running": { "description": "True if the database compaction routine is operating on this database.", "type": "boolean" }, "compacted_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "An opaque string that describes the compaction state of the database." } ] }, "db_name": { "$ref": "#/components/schemas/DatabaseName" }, "disk_format_version": { "description": "The version of the physical format used for the data when it is stored on disk.", "format": "int64", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "doc_count": { "description": "A count of the documents in the specified database.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "doc_del_count": { "description": "Number of deleted documents", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "engine": { "description": "The engine used for the database.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "instance_start_time": { "description": "An opaque string to detect whether a database has been recreated. The field name is for compatibility with old replicator versions. Do not use the value to infer timing information. Typically only used by replicators.", "maxLength": 10, "minLength": 1, "pattern": "^\\d+$", "type": "string" }, "partitioned_indexes": { "$ref": "#/components/schemas/PartitionedIndexesInformation" }, "props": { "$ref": "#/components/schemas/DatabaseInformationProps" }, "purge_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "An opaque string that describes the purge state of the database. Do not rely on this string for counting the number of purge operations." } ], "x-sdk-exclude": true }, "sizes": { "$ref": "#/components/schemas/ContentInformationSizes" }, "update_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "An opaque string that describes the state of the database. Do not rely on this string for counting the number of updates." } ] }, "uuid": { "description": "The UUID of the database.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "cluster", "compact_running", "db_name", "disk_format_version", "doc_count", "doc_del_count", "instance_start_time", "props", "purge_seq", "sizes", "update_seq" ], "type": "object" }, "DatabaseInformationCluster": { "additionalProperties": false, "description": "Schema for database cluster information.", "properties": { "n": { "$ref": "#/components/schemas/ReplicaCount" }, "q": { "$ref": "#/components/schemas/ShardCount" }, "r": { "description": "Read quorum. The number of consistent copies of a document that need to be read before a successful reply.", "format": "int64", "maximum": 3, "minimum": 1, "type": "integer" }, "w": { "description": "Write quorum. The number of copies of a document that need to be written before a successful reply.", "format": "int64", "maximum": 3, "minimum": 1, "type": "integer" } }, "required": [ "n", "q", "r", "w" ], "type": "object" }, "DatabaseInformationProps": { "additionalProperties": false, "description": "Schema for database properties.", "properties": { "partitioned": { "description": "The value is `true` for a partitioned database.", "type": "boolean" } }, "type": "object" }, "DatabaseName": { "description": "Schema for a database name.", "maxLength": 238, "minLength": 1, "pattern": "^_dbs$|^_global_changes$|^_metadata$|^_nodes$|^_replicator$|^_users$|^[a-z][a-z0-9_$()+/-]*$", "type": "string" }, "DatabaseUrl": { "description": "Schema for a database URL.", "maxLength": 8000, "minLength": 1, "pattern": "^https:\\/\\/.*$", "type": "string" }, "DatabasesCountInformation": { "additionalProperties": false, "description": "Schema for databases count.", "properties": { "total": { "description": "The total number of databases.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" } }, "type": "object" }, "DateTimeRFC2822": { "description": "Schema for date/time in RFC 2822 format.", "maxLength": 31, "minLength": 28, "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-3]\\d (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} [0-2]\\d:[0-5]\\d:[0-6]\\d ([+-]\\d{4}|[A-Z]{2,3})$", "type": "string" }, "DbEvent": { "additionalProperties": false, "description": "Schema for a database change event.", "properties": { "db_name": { "$ref": "#/components/schemas/DatabaseName" }, "seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "Sequence number." } ] }, "type": { "description": "A database event.", "enum": [ "created", "deleted", "updated" ], "type": "string" } }, "required": [ "db_name", "type", "seq" ], "type": "object" }, "DbUpdates": { "additionalProperties": false, "description": "Schema for database updates.", "properties": { "last_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "Last sequence number." } ] }, "results": { "description": "results", "items": { "$ref": "#/components/schemas/DbEvent" }, "maxItems": 4294967295, "minItems": 0, "type": "array" } }, "required": [ "last_seq", "results" ], "type": "object" }, "DbsInfoQuery": { "additionalProperties": false, "description": "Schema for submitting a query for information about multiple databases.", "properties": { "keys": { "description": "A list of database names", "items": { "$ref": "#/components/schemas/DatabaseName" }, "maxItems": 100, "minItems": 0, "type": "array" } }, "required": [ "keys" ], "type": "object" }, "DbsInfoResult": { "additionalProperties": false, "description": "Schema for database information keyed by database name.", "properties": { "error": { "description": "The name of the error.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "info": { "$ref": "#/components/schemas/DatabaseInformation" }, "key": { "$ref": "#/components/schemas/DatabaseName" } }, "required": [ "key" ], "type": "object" }, "DbsInfoResults": { "description": "Schema for a list of database information objects.", "items": { "$ref": "#/components/schemas/DbsInfoResult" }, "maxItems": 100, "minItems": 0, "type": "array" }, "DesignDocument": { "additionalProperties": true, "allOf": [ { "$ref": "#/components/schemas/Document" }, { "properties": { "_id": { "$ref": "#/components/schemas/DesignDocumentId" }, "autoupdate": { "default": true, "description": "Indicates whether to automatically build indexes defined in this design document.", "type": "boolean" }, "filters": { "$ref": "#/components/schemas/DesignDocumentFilterFunctions" }, "indexes": { "$ref": "#/components/schemas/DesignDocumentIndexFunctions" }, "language": { "default": "javascript", "description": "Defines Query Server key to process design document functions.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "options": { "$ref": "#/components/schemas/DesignDocumentOptions" }, "validate_doc_update": { "description": "Validate document update function can be used to prevent invalid\nor unauthorized document update requests from being stored.\nValidation functions typically examine the structure of the new\ndocument to ensure that required fields are present and to\nverify that the requesting user should be allowed to make\nchanges to the document properties. When a write request is\nreceived for a given database, the validation function in each\ndesign document in that database is called in an unspecified\norder. If any of the validation functions throw an error, the\nwrite will not succeed.\n\nThe validation function can abort the pending document\nwrite by throwing one of two error objects:\n\n```\n// user is not authorized to make the change but may\n// re-authenticate\nthrow({ unauthorized: 'Error message here.' });\n\n// change is not allowed\nthrow({ forbidden: 'Error message here.' });\n```\n\nThe function takes 4 parameters:\n\n * `newDoc` - New version of document that will be stored\n from the update request.\n * `oldDoc` - Previous version of document that is already\n stored.\n * `userCtx` - User Context Object, containing information\n about the user writing the document (if present), see the\n `UserContext`.\n * `secObj` - Security Object, with lists of database security\n roles, see the `SecurityObject`.", "maxLength": 1048488, "minLength": 1, "pattern": "^.+$", "type": "string" }, "views": { "$ref": "#/components/schemas/DesignDocumentViews" } }, "type": "object" } ], "description": "Schema for a design document.", "type": "object" }, "DesignDocumentFilterFunctions": { "additionalProperties": { "maxLength": 1048488, "minLength": 1, "pattern": "^.+$", "type": "string" }, "description": "Schema for filter functions definition. This schema is a map\nwhere keys are the names of the filter functions and values are the\nfunction definition in string format.\n\nFilter function formats, or filters the changes feed that pass filter\nrules.\nThe function takes 2 parameters:\n\n * `doc`: The document that is being processed.\n * `req`: A Request JavaScript object with these properties:\n\n * `body` - string, Request body data as string.\n If the request method is GET this field contains the value\n `\"undefined\"`.\n If the method is DELETE or HEAD the value is `\"\"` (empty string).\n * `cookie` - Cookies object.\n * `form` - Form Data object, contains the decoded body as key-value\n pairs if the Content-Type header was\n application/x-www-form-urlencoded.\n * `headers` - Request Headers object.\n * `id` - string, requested document id if it was specified\n or null otherwise.\n * `info` - Database Information object,\n see `DatabaseInformation`.\n * `method` - string or an array of chars, request method.\n String value is a method as one of: HEAD, GET, POST, PUT,\n DELETE, OPTIONS, TRACE, COPY. For not supported methods\n it will be represented as an array of char codes e.g. for VIEW\n it will be 86,73,69,87.\n * `path` - array of strings, requested path sections.\n * `peer` - string, request source IP address.\n * `query` - string, URL query parameters object. Note that multiple\n keys are not supported and the last key value suppresses others.\n * `requested_path` - array of strings,\n actual requested path section.\n * `raw_path` - string, raw requested path.\n * `userCtx`: User Context Object, containing information about the\n user writing the document (if present), see the `UserContext`.\n * `secObj`: Security Object, with lists of database security roles,\n see the `SecurityObject`.\n * `uuid` - string, generated UUID by a specified algorithm in the\n config file.\n\nFilter functions must return true if a document passed all the rules.", "type": "object" }, "DesignDocumentId": { "description": "Schema for a design document ID including a `_design/` prefix.", "maxLength": 7160, "minLength": 9, "pattern": "^_design\\/.+$", "type": "string" }, "DesignDocumentIdNullable": { "allOf": [ { "$ref": "#/components/schemas/DesignDocumentId" }, { "description": "Schema for a nullable design document ID including a `_design/` prefix." }, { "nullable": true } ] }, "DesignDocumentIndexFunctions": { "additionalProperties": { "$ref": "#/components/schemas/SearchIndexDefinition" }, "description": "Search (text) index function definitions.", "type": "object" }, "DesignDocumentInformation": { "additionalProperties": false, "description": "Schema for information about a design document.", "properties": { "name": { "description": "name", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "view_index": { "$ref": "#/components/schemas/DesignDocumentViewIndex" } }, "required": [ "name", "view_index" ], "type": "object" }, "DesignDocumentOptions": { "additionalProperties": false, "description": "Schema for design document options.", "properties": { "partitioned": { "description": "Whether this design document describes partitioned or global indexes. Set this option to `false` for a design document that describes global indexes in a partitioned database.\nA design document describes either global or partitioned indexes, but not both. By default, for a partitioned database this option is `true` and the design document describes partitioned indexes for queries on a single partition at a time. When set to `false` this option allows creating global indexes in this design document for queries spanning many partitions.\nFor non-partitioned databases, the default is `false` and design documents default to global. Only partitioned databases can have partitioned indexes.", "type": "boolean" } }, "type": "object" }, "DesignDocumentViewIndex": { "additionalProperties": false, "description": "View index information.", "properties": { "collator_versions": { "description": "List of collator versions. If there are multiple entries this implies a libicu upgrade has occurred but compaction has not run yet.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 4294967295, "minItems": 1, "type": "array" }, "compact_running": { "description": "Indicates whether a compaction routine is currently running on the view.", "type": "boolean" }, "language": { "description": "Language for the defined views.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "purge_seq": { "description": "The purge sequence that has been processed.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer", "x-sdk-exclude": true }, "signature": { "description": "MD5 signature of the views for the design document.", "maxLength": 32, "minLength": 32, "pattern": "^[\\da-f]{32}$", "type": "string" }, "sizes": { "$ref": "#/components/schemas/ContentInformationSizes" }, "update_seq": { "description": "The update sequence of the corresponding view that has been indexed. Do not rely on this property for counting the number of updates.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer", "x-sdk-exclude": true }, "updater_running": { "description": "Indicates if the view is currently being updated.", "type": "boolean" }, "updates_pending": { "$ref": "#/components/schemas/UpdatesPending" }, "waiting_clients": { "description": "Number of clients waiting on views from this design document.", "format": "int64", "maximum": 10000, "minimum": 0, "type": "integer" }, "waiting_commit": { "description": "Indicates if there are outstanding commits to the underlying database that need to processed.", "type": "boolean" } }, "required": [ "compact_running", "language", "purge_seq", "signature", "sizes", "update_seq", "updater_running", "updates_pending", "waiting_clients", "waiting_commit", "collator_versions" ], "type": "object" }, "DesignDocumentViews": { "additionalProperties": { "$ref": "#/components/schemas/DesignDocumentViewsMapReduce" }, "description": "Schema for design document views.", "type": "object" }, "DesignDocumentViewsMapReduce": { "additionalProperties": false, "description": "Schema for view functions definition.", "properties": { "map": { "description": "JavaScript map function as a string.", "maxLength": 1048488, "minLength": 1, "pattern": "^.+$", "type": "string" }, "options": { "$ref": "#/components/schemas/DesignDocumentViewsMapReduceOptions" }, "reduce": { "description": "JavaScript reduce function as a string.", "maxLength": 1048488, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "map" ], "type": "object" }, "DesignDocumentViewsMapReduceOptions": { "additionalProperties": false, "description": "Options of view build results.", "properties": { "collation": { "description": "By default when `collation` is unset, comparison of keys in view build results is done using ICU which implements the [Unicode Collation Algorithm](https://www.unicode.org/reports/tr10/)(UCA).\n UCA is a standard algorithm for collating any collection of strings\ncomposed of any standard Unicode symbols.\n\n\n**Note:** Keeping `collation` as unset resulting in UCA sorting is highly recommended.\n\n\n`raw` option enables native [Erlang binary collation](https://www.erlang.org/doc/system/expressions.html#term-comparisons) for sorting view build results. Only enable raw collation if you have a specific requirement for it and Unicode collation is not important.", "enum": [ "raw" ], "nullable": true, "type": "string", "x-sdk-exclude": true } }, "type": "object", "x-sdk-exclude": true }, "DocsResult": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/CommonViewResult" }, { "additionalProperties": false, "properties": { "rows": { "description": "List of doc results.", "items": { "$ref": "#/components/schemas/DocsResultRow" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "total_rows": { "allOf": [ { "$ref": "#/components/schemas/TotalRows" }, { "description": "Total number of document results." } ] } }, "required": [ "rows" ], "type": "object" } ], "description": "Schema for the document result structure in a view like response such as`/_all_docs` and `/_local_docs`.", "required": [ "offset", "total_rows" ] }, "DocsResultRow": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/Error" }, { "additionalProperties": false, "description": "Schema for a row of document information in a DocsResult.", "properties": { "doc": { "$ref": "#/components/schemas/Document" }, "id": { "$ref": "#/components/schemas/DocumentId" }, "key": { "$ref": "#/components/schemas/DocumentId" }, "value": { "$ref": "#/components/schemas/DocsResultRowValue" } }, "type": "object" } ], "description": "Schema for a row of document information in a DocsResult.", "required": [ "key" ] }, "DocsResultRowValue": { "additionalProperties": false, "description": "Value of built-in `/_all_docs` style view.", "properties": { "deleted": { "description": "If `true` then the document is deleted. Not present for undeleted documents.", "type": "boolean" }, "rev": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" } }, "required": [ "rev" ], "type": "object" }, "Document": { "additionalProperties": true, "description": "Schema for a document.", "properties": { "_attachments": { "$ref": "#/components/schemas/Attachments" }, "_conflicts": { "$ref": "#/components/schemas/DocumentRevisionIdentifiers" }, "_deleted": { "description": "Deletion flag. Available if document was removed", "type": "boolean" }, "_deleted_conflicts": { "$ref": "#/components/schemas/DocumentRevisionIdentifiers" }, "_id": { "$ref": "#/components/schemas/DocumentId" }, "_local_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "Document's update sequence in current database. Available if requested with local_seq=true query parameter" } ] }, "_rev": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" }, "_revisions": { "$ref": "#/components/schemas/Revisions" }, "_revs_info": { "$ref": "#/components/schemas/DocumentRevsInfo" } }, "type": "object", "x-preserved-property-names": [ "_attachments", "_conflicts", "_deleted", "_deleted_conflicts", "_id", "_local_seq", "_rev", "_revisions", "_revs_info", "_attachments", "_conflicts", "_deleted", "_deleted_conflicts", "_id", "_local_seq", "_rev", "_revisions", "_revs_info" ] }, "DocumentId": { "description": "Schema for a document ID.", "maxLength": 7168, "minLength": 1, "pattern": "^([^_]|_(design|local)\\/).+$", "type": "string" }, "DocumentIdRev": { "additionalProperties": false, "description": "Schema for an object with a document ID and revision identifier.", "properties": { "id": { "$ref": "#/components/schemas/DocumentId" }, "rev": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" } }, "required": [ "id" ], "type": "object" }, "DocumentIds": { "description": "Schema for a list of document IDs.", "items": { "$ref": "#/components/schemas/DocumentId" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "DocumentMultipart": { "additionalProperties": false, "description": "Schema for a multipart document and attachments.", "properties": { "document": { "$ref": "#/components/schemas/Document" }, "documentAttachments": { "description": "Schema for multipart attachments.", "items": { "$ref": "#/components/schemas/AttachmentContent" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "type": "object" }, "DocumentResult": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/DocumentIdRev" }, { "$ref": "#/components/schemas/Ok" }, { "$ref": "#/components/schemas/Error" } ], "description": "Schema for the result of a document modification." }, "DocumentRevisionIdentifier": { "description": "Schema for a document revision identifier.", "maxLength": 43, "minLength": 34, "pattern": "^[1-9]\\d{0,9}-[\\da-f]{32}$", "type": "string" }, "DocumentRevisionIdentifiers": { "description": "Schema for a list of document revision identifiers.", "items": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "DocumentRevisionStatus": { "additionalProperties": false, "description": "Schema for information about revisions and their status.", "properties": { "rev": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" }, "status": { "description": "Status of the revision. May be one of: - `available`: Revision is available for retrieving with rev query parameter - `missing`: Revision is not available - `deleted`: Revision belongs to deleted document", "enum": [ "available", "missing", "deleted" ], "type": "string" } }, "required": [ "rev", "status" ], "type": "object" }, "DocumentRevisions": { "additionalProperties": { "items": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "description": "Schema for mapping document IDs to lists of revisions.", "type": "object" }, "DocumentRevsInfo": { "description": "Schema for a list of objects with information about local revisions and their status.", "items": { "$ref": "#/components/schemas/DocumentRevisionStatus" }, "maxItems": 4294967295, "minItems": 1, "type": "array" }, "DocumentShardInfo": { "additionalProperties": false, "description": "Schema for document shard information.", "properties": { "nodes": { "description": "List of nodes serving a replica of the shard.", "items": { "maxLength": 255, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 3, "minItems": 1, "type": "array" }, "range": { "description": "The shard range in which the document is stored.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "nodes", "range" ], "type": "object" }, "DrilldownQuery": { "description": "Schema for a drilldown search query parameter.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" }, "ETag": { "description": "Resource ETag value.", "maxLength": 45, "minLength": 26, "pattern": "^\"[A-Za-z0-9+\\/]{2,24}={0,3}\"$|^\"[1-9]\\d{0,9}-[\\da-f]{32}\"$|^\"[0-9A-Z]{25}\"$", "title": "ETag", "type": "string" }, "EnsureFullCommitInformation": { "additionalProperties": false, "description": "Schema for the status of a commit operation.", "properties": { "instance_start_time": { "description": "Timestamp of when the database was opened, expressed in microseconds since the epoch.", "maxLength": 10, "minLength": 1, "pattern": "^\\d+$", "type": "string" }, "ok": { "default": true, "description": "Operation status.", "type": "boolean" } }, "required": [ "instance_start_time", "ok" ], "type": "object" }, "Error": { "additionalProperties": false, "description": "Schema for error information returned from the database.", "properties": { "caused_by": { "description": "The cause of the error (if available).", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "error": { "description": "The name of the error.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "reason": { "description": "The reason the error occurred (if available).", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "ref": { "description": "An internal error reference (if available).", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "type": "object" }, "ExecutionStats": { "additionalProperties": false, "description": "Schema for find query execution statistics.", "properties": { "execution_time_ms": { "description": "Time to execute the query.", "format": "double", "type": "number" }, "results_returned": { "description": "Number of results returned.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "total_docs_examined": { "description": "Number of documents fetched from the index.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "total_keys_examined": { "description": "Number of rows scanned in the index.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "total_quorum_docs_examined": { "description": "Number of documents fetched from the primary index with the specified read quorum.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "execution_time_ms", "results_returned", "total_docs_examined", "total_keys_examined", "total_quorum_docs_examined" ], "type": "object" }, "ExplainResult": { "additionalProperties": false, "description": "Schema for information about the index used for a find query.", "properties": { "covering": { "description": "When `true`, the query is answered using the index only and no documents are fetched.", "type": "boolean" }, "dbname": { "$ref": "#/components/schemas/DatabaseName" }, "fields": { "description": "Fields that were requested to be projected from the document.\nIf no fields were requested to be projected this will be empty\nand all fields will be returned.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "index": { "$ref": "#/components/schemas/IndexInformation" }, "index_candidates": { "$ref": "#/components/schemas/IndexCandidates" }, "limit": { "default": 25, "description": "The used maximum number of results returned.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "mrargs": { "$ref": "#/components/schemas/ExplainResultMrArgs" }, "opts": { "$ref": "#/components/schemas/ExplainResultOpts" }, "partitioned": { "$ref": "#/components/schemas/AnyJsonType" }, "selector": { "$ref": "#/components/schemas/Selector" }, "selector_hints": { "$ref": "#/components/schemas/SelectorHints" }, "skip": { "description": "Skip parameter used.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "covering", "dbname", "fields", "index", "index_candidates", "limit", "opts", "selector", "selector_hints", "skip" ], "type": "object" }, "ExplainResultMrArgs": { "additionalProperties": false, "description": "Arguments passed to the underlying view.", "properties": { "conflicts": { "$ref": "#/components/schemas/AnyJsonType" }, "direction": { "default": "fwd", "description": "Direction parameter passed to the underlying view.", "enum": [ "fwd", "rev" ], "type": "string" }, "end_key": { "$ref": "#/components/schemas/AnyJsonType" }, "include_docs": { "description": "A parameter that specifies whether to include the full content\nof the documents in the response in the underlying view.", "type": "boolean" }, "partition": { "description": "Partition parameter passed to the underlying view.", "maxLength": 7168, "minLength": 0, "nullable": true, "pattern": "^[^_:][^:]*$", "type": "string" }, "reduce": { "description": "A parameter that specifies returning only documents that match\nany of the specified keys in the underlying view.", "type": "boolean" }, "stable": { "description": "A parameter that specifies whether the view results\nshould be returned form a \"stable\" set of shards passed to\nthe underlying view.", "type": "boolean" }, "start_key": { "$ref": "#/components/schemas/AnyJsonType" }, "update": { "$ref": "#/components/schemas/AnyJsonType" }, "view_type": { "description": "The type of the underlying view.", "enum": [ "map", "reduce" ], "type": "string" } }, "required": [ "conflicts", "direction", "end_key", "include_docs", "partition", "reduce", "stable", "update", "view_type" ], "type": "object" }, "ExplainResultOpts": { "additionalProperties": false, "description": "Options used for the request.", "properties": { "bookmark": { "$ref": "#/components/schemas/Bookmark" }, "conflicts": { "default": false, "description": "Conflicts used in the request query.", "type": "boolean" }, "execution_stats": { "default": false, "description": "Execution statistics used in the request query.", "type": "boolean" }, "fields": { "$ref": "#/components/schemas/Fields" }, "limit": { "default": 25, "description": "Limit used in the request query.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "partition": { "description": "On which database partition the request was used.\nIf it was not used on a database partition, it returns with `\"\"`.", "maxLength": 7168, "minLength": 0, "pattern": "^[^_:][^:]*$", "type": "string" }, "r": { "description": "The read quorum that is needed for the result.", "format": "int64", "maximum": 3, "minimum": 1, "type": "integer" }, "skip": { "default": 0, "description": "Skip used in the request query.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "sort": { "$ref": "#/components/schemas/AnyJsonType" }, "stable": { "default": false, "description": "Stable used in the request query.", "type": "boolean" }, "stale": { "default": false, "deprecated": true, "description": "Stale used in the request query.", "type": "boolean" }, "update": { "default": true, "description": "Update used in the request query.", "type": "boolean" }, "use_index": { "description": "Use index used in the request query.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 2, "minItems": 0, "type": "array" } }, "required": [ "bookmark", "conflicts", "execution_stats", "fields", "limit", "partition", "r", "skip", "sort", "stable", "stale", "update", "use_index" ], "type": "object" }, "FieldSort": { "additionalProperties": { "$ref": "#/components/schemas/SortDirection" }, "description": "Schema for a mapping of field name to sort direction.", "type": "object" }, "Fields": { "description": "JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be returned. If it is omitted or empty, the entire document is returned.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "FindQuery": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/PartitionFindQuery" }, { "properties": { "r": { "default": 1, "description": "The read quorum that is needed for the result. The value defaults to 1, in which case the document that was found in the index is returned. If set to a higher value, each document is read from at least that many replicas before it is returned in the results. The request will take more time than using only the document that is stored locally with the index.", "format": "int64", "maximum": 3, "minimum": 1, "type": "integer" } } } ], "description": "Schema for a query find operation." }, "FindResult": { "additionalProperties": false, "description": "Schema for the result of a query find operation.", "properties": { "bookmark": { "$ref": "#/components/schemas/Bookmark" }, "docs": { "description": "Documents matching the selector.", "items": { "$ref": "#/components/schemas/Document" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "execution_stats": { "$ref": "#/components/schemas/ExecutionStats" }, "warning": { "description": "warning", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "bookmark", "docs" ], "type": "object" }, "IamSessionConfiguration": { "additionalProperties": false, "description": "Schema for submitting an IAM access token.", "properties": { "access_token": { "description": "Token obtained from the IAM service.", "maxLength": 7168, "minLength": 1, "pattern": "^[A-Za-z0-9_-]{2,}\\.[A-Za-z0-9_-]{2,}\\.[A-Za-z0-9_-]{2,}$", "type": "string" } }, "required": [ "access_token" ], "type": "object" }, "IamSessionInformation": { "additionalProperties": false, "description": "Schema for information about an IAM session.", "properties": { "id": { "description": "User ID", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "ok": { "default": true, "description": "Session is ok", "type": "boolean" }, "scope": { "description": "Scope of the session", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "type": { "description": "Type of the session", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "id", "ok", "scope", "type" ], "type": "object" }, "IndexAnalysis": { "additionalProperties": false, "description": "Schema for detailed explanation of why the specific index was excluded by the query planner.", "properties": { "covering": { "description": "When `true`, the query is answered using the index only and no documents are fetched.", "nullable": true, "type": "boolean" }, "ranking": { "description": "A position of the unused index based on its potential relevance to the query.", "format": "int64", "maximum": 4294967295, "minimum": 1, "type": "integer" }, "reasons": { "description": "A list of reasons explaining why index was not chosen for the query.", "items": { "$ref": "#/components/schemas/IndexAnalysisExclusionReason" }, "maxItems": 4294967295, "minItems": 1, "type": "array" }, "usable": { "description": "Indicates whether an index can still be used for the query.", "type": "boolean" } }, "required": [ "covering", "ranking", "reasons", "usable" ], "type": "object" }, "IndexAnalysisExclusionReason": { "additionalProperties": false, "description": "A reason for index's exclusion.", "properties": { "name": { "description": "A reason code for index's exclusion.\n\nThe full list of possible reason codes is following:\n\n* alphabetically_comes_after: json\n There is another suitable index whose name comes before that of\n this index.\n* empty_selector: text\n\"text\" indexes do not support queries with empty selectors.\n* excluded_by_user: any\nuse_index was used to manually specify the index.\n* field_mismatch: any\nFields in \"selector\" of the query do match with the fields available\nin the index.\n* is_partial: json, text\nPartial indexes can be selected only manually.\n* less_overlap: json\nThere is a better match of fields available within the indexes for\nthe query.\n* needs_text_search: json\nThe use of the $text operator requires a \"text\" index.\n* scope_mismatch: json\nThe scope of the query and the index is not the same.\n* sort_order_mismatch: json, special\nFields in \"sort\" of the query do not match with the fields available\nin the index.\n* too_many_fields: json\nThe index has more fields than the chosen one.\n* unfavored_type: any\nThe type of the index is not preferred.", "enum": [ "alphabetically_comes_after", "empty_selector", "excluded_by_user", "field_mismatch", "is_partial", "less_overlap", "needs_text_search", "scope_mismatch", "sort_order_mismatch", "too_many_fields", "unfavored_type" ], "type": "string" } }, "required": [ "name" ] }, "IndexCandidate": { "additionalProperties": false, "description": "Schema for an index that was not chosen for serving the query with the reason for the exclusion.", "properties": { "analysis": { "$ref": "#/components/schemas/IndexAnalysis" }, "index": { "$ref": "#/components/schemas/IndexInformation" } }, "required": [ "analysis", "index" ], "type": "object" }, "IndexCandidates": { "description": "Schema for the list of all the other indexes that were not chosen for serving the query.", "items": { "$ref": "#/components/schemas/IndexCandidate" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "IndexConfiguration": { "additionalProperties": false, "description": "Schema for configuration options for creating an index.", "properties": { "ddoc": { "description": "Specifies the design document name in which the index will be\ncreated. The design document name is the design document ID\nexcluding the `_design/` prefix.", "maxLength": 7168, "minLength": 1, "pattern": "^[^_design/].*$", "type": "string" }, "index": { "$ref": "#/components/schemas/IndexDefinition" }, "name": { "description": "name", "maxLength": 7168, "minLength": 1, "pattern": "^[^_].*$", "type": "string" }, "partitioned": { "description": "The default value is `true` for databases with `partitioned: true` and `false` otherwise. For databases with `partitioned: false` if this option is specified the value must be `false`.", "type": "boolean" }, "type": { "$ref": "#/components/schemas/IndexType" } }, "required": [ "index" ], "type": "object" }, "IndexDefinition": { "additionalProperties": false, "description": "Schema for a `json` or `text` query index definition. Indexes of type `text` have additional configuration properties that do not apply to `json` indexes, these are:\n* `default_analyzer` - the default text analyzer to use\n* `default_field` - whether to index the text in all document fields and what analyzer to use for that purpose.", "properties": { "default_analyzer": { "$ref": "#/components/schemas/Analyzer" }, "default_field": { "$ref": "#/components/schemas/IndexTextOperatorDefaultField" }, "fields": { "description": "List of field objects to index. Nested fields are also allowed,\ne.g. `person.name`.\n\nFor \"json\" type indexes each object is a mapping of field name to\nsort direction (asc or desc).\n\nFor \"text\" type indexes each object has a `name` property of the\nfield name and a `type` property of the field type (string, number,\nor boolean).", "items": { "$ref": "#/components/schemas/IndexField" }, "maxItems": 65535, "minItems": 1, "type": "array" }, "index_array_lengths": { "default": true, "description": "Whether to scan every document for arrays and store the length for each array found. Set the index_array_lengths field to false if:\n* You do not need to know the length of an array.\n* You do not use the `$size` operator.\n* The documents in your database are complex, or not completely under your control. As a result, it is difficult to estimate the impact of the extra processing that is needed to determine and store the arrays lengths.", "type": "boolean" }, "partial_filter_selector": { "$ref": "#/components/schemas/Selector" }, "selector": { "$ref": "#/components/schemas/IndexDefinitionSelector" } }, "required": [ "fields" ], "type": "object" }, "IndexDefinitionSelector": { "allOf": [ { "$ref": "#/components/schemas/Selector" } ], "deprecated": true, "description": "Use `partial_filter_selector` instead.", "type": "object", "x-sdk-exclude": true }, "IndexField": { "additionalProperties": { "$ref": "#/components/schemas/SortDirection" }, "description": "Schema for indexed fields for use with declarative JSON query.", "properties": { "name": { "description": "Name of the field.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "type": { "description": "The type of the named field.", "enum": [ "boolean", "number", "string" ], "type": "string" } }, "type": "object" }, "IndexInformation": { "additionalProperties": false, "description": "Schema for information about an index.", "properties": { "ddoc": { "$ref": "#/components/schemas/DesignDocumentIdNullable" }, "def": { "$ref": "#/components/schemas/IndexDefinition" }, "name": { "$ref": "#/components/schemas/IndexName" }, "partitioned": { "description": "Indicates if index is partitioned.", "type": "boolean" }, "type": { "$ref": "#/components/schemas/IndexType" } }, "required": [ "ddoc", "def", "name", "type" ], "type": "object" }, "IndexName": { "description": "Index name.", "maxLength": 7168, "minLength": 1, "pattern": "^[^_].*$|^_all_docs$", "type": "string" }, "IndexResult": { "additionalProperties": false, "description": "Schema for the result of creating an index.", "properties": { "id": { "allOf": [ { "$ref": "#/components/schemas/DesignDocumentId" }, { "description": "Id of the design document the index was created in." } ] }, "name": { "description": "Name of the index created.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "result": { "description": "Flag to show whether the index was created or one already exists.", "enum": [ "created", "exists" ], "type": "string" } }, "required": [ "id", "name", "result" ], "type": "object" }, "IndexTextOperatorDefaultField": { "additionalProperties": false, "description": "Schema for the text index default field configuration. The default field is used to index the text of all fields within a document for use with the `$text` operator.", "properties": { "analyzer": { "$ref": "#/components/schemas/Analyzer" }, "enabled": { "default": true, "description": "Whether or not the default_field is enabled.", "type": "boolean" } }, "type": "object" }, "IndexType": { "description": "Schema for the type of an index.", "enum": [ "json", "special", "text" ], "type": "string" }, "IndexesInformation": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/CommonViewResult" }, { "description": "Schema for information about the indexes in a database.", "properties": { "indexes": { "description": "Indexes.", "items": { "$ref": "#/components/schemas/IndexInformation" }, "maxItems": 4294967295, "minItems": 1, "type": "array" }, "total_rows": { "allOf": [ { "$ref": "#/components/schemas/TotalRows" }, { "description": "Total number of query indexes in the database." } ] } }, "required": [ "indexes" ] } ], "required": [ "total_rows" ], "type": "object" }, "JobId": { "description": "Schema for a replication job id.", "maxLength": 7168, "minLength": 1, "pattern": "^[^_].*$", "type": "string" }, "MembershipInformation": { "additionalProperties": false, "description": "Schema for information about known nodes and cluster membership.", "properties": { "all_nodes": { "description": "List of nodes this node knows about, including the ones that are part of the cluster.", "items": { "maxLength": 255, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 64, "minItems": 1, "type": "array" }, "cluster_nodes": { "description": "All cluster nodes.", "items": { "maxLength": 255, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 64, "minItems": 1, "type": "array" } }, "required": [ "all_nodes", "cluster_nodes" ], "type": "object" }, "MissingRevsResult": { "additionalProperties": false, "description": "Schema for mapping document IDs to lists of missing revisions.", "properties": { "missing_revs": { "$ref": "#/components/schemas/DocumentRevisions" } }, "required": [ "missing_revs" ], "type": "object" }, "NodeStatsCounter": { "additionalProperties": false, "description": "Schema for a statistic of a monotonically increasing counter that resets on restart.", "properties": { "desc": { "description": "Description of the counter statistic.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "type": { "description": "counter", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "value": { "description": "Count value of the statistic.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "type": "object" }, "NodeStatsGauge": { "additionalProperties": false, "description": "Schema for a statistic of a single numerical value that can go up and down.", "properties": { "desc": { "description": "Description of the gauge statistic.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "type": { "description": "gauge", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "value": { "description": "Current numerical value of the statistic.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "type": "object" }, "NodeStatsHistogram": { "additionalProperties": false, "description": "Schema for a statistic of a histogram of binned values with meaningful subdivisions.", "properties": { "arithmetic_mean": { "description": "arithmetic_mean", "format": "double", "type": "number" }, "desc": { "description": "Description of the historgram statistic.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "geometric_mean": { "description": "geometric_mean", "format": "double", "type": "number" }, "harmonic_mean": { "description": "harmonic_mean", "format": "double", "type": "number" }, "histogram": { "description": "histogram", "items": { "items": { "format": "double", "type": "number" }, "maxItems": 2, "minItems": 2, "type": "array" }, "maxItems": 4294967295, "minItems": 1, "type": "array" }, "kurtosis": { "description": "kurtosis", "format": "double", "type": "number" }, "max": { "description": "max", "format": "double", "type": "number" }, "median": { "description": "median", "format": "double", "type": "number" }, "min": { "description": "min", "format": "double", "type": "number" }, "n": { "description": "n", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "percentile": { "description": "percentile", "items": { "items": { "format": "double", "type": "number" }, "maxItems": 2, "minItems": 2, "type": "array" }, "maxItems": 6, "minItems": 6, "type": "array" }, "skewness": { "description": "skewness", "format": "double", "type": "number" }, "standard_deviation": { "description": "standard_deviation", "format": "double", "type": "number" }, "variance": { "description": "variance", "format": "double", "type": "number" } }, "required": [ "histogram", "percentile" ], "type": "object" }, "NodeStatsInformation": { "additionalProperties": false, "description": "Schema for node statistics.", "properties": { "cassim": { "$ref": "#/components/schemas/NodeStatsInformationCassim" }, "couch_audit": { "$ref": "#/components/schemas/NodeStatsInformationCouchAudit" }, "couch_log": { "$ref": "#/components/schemas/NodeStatsInformationCouchLog" }, "couch_replicator": { "$ref": "#/components/schemas/NodeStatsInformationCouchReplicator" }, "couchdb": { "$ref": "#/components/schemas/NodeStatsInformationCouchdb" }, "dbcopy": { "$ref": "#/components/schemas/NodeStatsInformationDbcopy" }, "ddoc_cache": { "$ref": "#/components/schemas/NodeStatsInformationDdocCache" }, "dreyfus": { "$ref": "#/components/schemas/NodeStatsInformationDreyfus" }, "epep": { "$ref": "#/components/schemas/NodeStatsInformationEpep" }, "fabric": { "$ref": "#/components/schemas/NodeStatsInformationFabric" }, "global_changes": { "$ref": "#/components/schemas/NodeStatsInformationGlobalChanges" }, "mango": { "$ref": "#/components/schemas/NodeStatsInformationMango" }, "mem3": { "$ref": "#/components/schemas/NodeStatsInformationMem3" }, "pread": { "$ref": "#/components/schemas/NodeStatsInformationPread" }, "rexi": { "$ref": "#/components/schemas/NodeStatsInformationRexi" } }, "required": [ "couch_log", "couch_replicator", "couchdb", "ddoc_cache", "dreyfus", "fabric", "global_changes", "mango", "mem3", "pread", "rexi" ], "type": "object" }, "NodeStatsInformationCassim": { "additionalProperties": false, "description": "cassim", "properties": { "metadata_cache": { "$ref": "#/components/schemas/NodeStatsInformationCassimMetadataCache" }, "security_migration": { "$ref": "#/components/schemas/NodeStatsInformationCassimSecurityMigration" } }, "type": "object" }, "NodeStatsInformationCassimMetadataCache": { "additionalProperties": false, "description": "metadata_cache\nhit: Number of cassim metadata cache lookup hits.\nmiss: Number of cassim metadata cache lookup misses.", "properties": { "hit": { "$ref": "#/components/schemas/NodeStatsCounter" }, "miss": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCassimSecurityMigration": { "additionalProperties": false, "description": "security_migration\nconflict: Number of conflicted cassim security doc migrations.\nsuccess: Number of successful cassim security doc migrations.", "properties": { "conflict": { "$ref": "#/components/schemas/NodeStatsCounter" }, "success": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchAudit": { "additionalProperties": false, "description": "couch_audit\nevent: Number of audit events.\nfailures: Number of failed tcp audit transmissions.\nsuccess: Number of successful tcp audit transmissions.\ntcp_send_latency: Tcp transmission latency.", "properties": { "audit": { "$ref": "#/components/schemas/NodeStatsInformationCouchAuditAudit" } }, "type": "object" }, "NodeStatsInformationCouchAuditAudit": { "additionalProperties": false, "description": "audit", "properties": { "event": { "$ref": "#/components/schemas/NodeStatsCounter" }, "failure": { "$ref": "#/components/schemas/NodeStatsCounter" }, "success": { "$ref": "#/components/schemas/NodeStatsCounter" }, "tcp_send_latency": { "$ref": "#/components/schemas/NodeStatsHistogram" } }, "type": "object" }, "NodeStatsInformationCouchLog": { "additionalProperties": false, "description": "couch_log\nalert: Number of logged alert messages.\ncritical: Number of logged critical messages.\ndebug: Number of logged debug messages.\nemergency: Number of logged emergency messages.\nerror: Number of logged error messages.\ninfo: Number of logged info messages.\nnotice: Number of logged notice messages.\nwarning: Number of logged warning messages.", "properties": { "level": { "$ref": "#/components/schemas/NodeStatsInformationCouchLogLevel" } }, "type": "object" }, "NodeStatsInformationCouchLogLevel": { "additionalProperties": false, "description": "level", "properties": { "alert": { "$ref": "#/components/schemas/NodeStatsCounter" }, "critical": { "$ref": "#/components/schemas/NodeStatsCounter" }, "debug": { "$ref": "#/components/schemas/NodeStatsCounter" }, "emergency": { "$ref": "#/components/schemas/NodeStatsCounter" }, "error": { "$ref": "#/components/schemas/NodeStatsCounter" }, "info": { "$ref": "#/components/schemas/NodeStatsCounter" }, "notice": { "$ref": "#/components/schemas/NodeStatsCounter" }, "warning": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchReplicator": { "additionalProperties": false, "description": "couch_replicator\nchanges_manager_deaths: Number of failed replicator changes managers.\nchanges_queue_deaths: Number of failed replicator changes work queues.\nchanges_read_failures: Number of failed replicator changes read\nfailures.\nchanges_reader_deaths: Number of failed replicator changes readers.\ncheckpoints: checkpoint statistics\ncluster_is_stable: 1 if cluster is stable, 0 if unstable.\nconnection: connection statistics\ndb_scans: Number of times replicator db scans have been started.\ndocs: doc statistics\nfailed_starts: Number of replications that have failed to start.\njobs: job statistics\nrequests: Number of http requests made by the replicator.\nresponses: response statistics\nstream_responses: stream response statistics\nworker_deaths: Number of failed replicator workers.\nworkers_started: Number of replicator workers started.", "properties": { "changes_manager_deaths": { "$ref": "#/components/schemas/NodeStatsCounter" }, "changes_queue_deaths": { "$ref": "#/components/schemas/NodeStatsCounter" }, "changes_read_failures": { "$ref": "#/components/schemas/NodeStatsCounter" }, "changes_reader_deaths": { "$ref": "#/components/schemas/NodeStatsCounter" }, "checkpoints": { "$ref": "#/components/schemas/NodeStatsInformationCouchReplicatorCheckpoints" }, "cluster_is_stable": { "$ref": "#/components/schemas/NodeStatsGauge" }, "connection": { "$ref": "#/components/schemas/NodeStatsInformationCouchReplicatorConnection" }, "db_scans": { "$ref": "#/components/schemas/NodeStatsCounter" }, "docs": { "$ref": "#/components/schemas/NodeStatsInformationCouchReplicatorDocs" }, "failed_starts": { "$ref": "#/components/schemas/NodeStatsCounter" }, "jobs": { "$ref": "#/components/schemas/NodeStatsInformationCouchReplicatorJobs" }, "requests": { "$ref": "#/components/schemas/NodeStatsCounter" }, "responses": { "$ref": "#/components/schemas/NodeStatsInformationCouchReplicatorResponses" }, "stream_responses": { "$ref": "#/components/schemas/NodeStatsInformationCouchReplicatorStreamResponses" }, "worker_deaths": { "$ref": "#/components/schemas/NodeStatsCounter" }, "workers_started": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchReplicatorCheckpoints": { "additionalProperties": false, "description": "checkpoints\nfailure: Number of failed checkpoint saves.\nsuccess: Number of checkpoints successfully saves.", "properties": { "failure": { "$ref": "#/components/schemas/NodeStatsCounter" }, "success": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchReplicatorConnection": { "additionalProperties": false, "description": "connection\nacquires: Number of times connections are shared.\ncloses: Number of times a worker is gracefully shut down.\ncreates: Number of connections created.\nowner_crashes: Number of times a connection owner crashes while\nowning at least one connection.\nreleases: Number of times ownership of a connection is released.\nworker_crashes: Number of times a worker unexpectedly terminates.", "properties": { "acquires": { "$ref": "#/components/schemas/NodeStatsCounter" }, "closes": { "$ref": "#/components/schemas/NodeStatsCounter" }, "creates": { "$ref": "#/components/schemas/NodeStatsCounter" }, "owner_crashes": { "$ref": "#/components/schemas/NodeStatsCounter" }, "releases": { "$ref": "#/components/schemas/NodeStatsCounter" }, "worker_crashes": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchReplicatorDocs": { "additionalProperties": false, "description": "docs\ncompleted_state_updates: Number of completed state document\nupdates.\ndb_changes: Number of db changes processed by replicator doc\nprocessor.\ndbs_created: Number of db shard creations seen by replicator doc\nprocessor.\ndbs_deleted: Number of db shard deletions seen by replicator doc\nprocessor.\ndbs_found: Number of db shard found by replicator doc processor.\nfailed_state_updates: Number of failed state document updates.", "properties": { "completed_state_updates": { "$ref": "#/components/schemas/NodeStatsCounter" }, "db_changes": { "$ref": "#/components/schemas/NodeStatsCounter" }, "dbs_created": { "$ref": "#/components/schemas/NodeStatsCounter" }, "dbs_deleted": { "$ref": "#/components/schemas/NodeStatsCounter" }, "dbs_found": { "$ref": "#/components/schemas/NodeStatsCounter" }, "failed_state_updates": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchReplicatorJobs": { "additionalProperties": false, "description": "jobs\nadds: Number of jobs added to replicator scheduler.\ncrashed: Replicator scheduler crashed jobs.\ncrashes: Number of job crashed noticed by replicator scheduler.\nduplicate_adds: Number of duplicate jobs added to replicator\nscheduler.\npending: Replicator scheduler pending jobs.\nremoves: Number of jobs removed from replicator scheduler.\nrunning: Replicator scheduler running jobs.\nstarts: Number of jobs started by replicator scheduler.\nstops: Number of jobs stopped by replicator scheduler.\ntotal: Total number of replicator scheduler jobs.", "properties": { "adds": { "$ref": "#/components/schemas/NodeStatsCounter" }, "crashed": { "$ref": "#/components/schemas/NodeStatsGauge" }, "crashes": { "$ref": "#/components/schemas/NodeStatsCounter" }, "duplicate_adds": { "$ref": "#/components/schemas/NodeStatsCounter" }, "pending": { "$ref": "#/components/schemas/NodeStatsGauge" }, "removes": { "$ref": "#/components/schemas/NodeStatsCounter" }, "running": { "$ref": "#/components/schemas/NodeStatsGauge" }, "starts": { "$ref": "#/components/schemas/NodeStatsCounter" }, "stops": { "$ref": "#/components/schemas/NodeStatsCounter" }, "total": { "$ref": "#/components/schemas/NodeStatsGauge" } }, "type": "object" }, "NodeStatsInformationCouchReplicatorResponses": { "additionalProperties": false, "description": "responses\nfailure: Number of failed http responses received by the replicator.\nsuccess: Number of successful http responses received by the\nreplicator.", "properties": { "failure": { "$ref": "#/components/schemas/NodeStatsCounter" }, "success": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchReplicatorStreamResponses": { "additionalProperties": false, "description": "stream_responses\nfailure: Number of failed streaming http responses received by the\nreplicator.\nsuccess: Number of successful streaming http responses received by\nthe replicator.", "properties": { "failure": { "$ref": "#/components/schemas/NodeStatsCounter" }, "success": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdb": { "additionalProperties": false, "description": "couchdb\nauth_cache_hits: Number of authentication cache hits.\nauth_cache_misses: Number of authentication cache misses.\ncollect_results_time: Microsecond latency for calls to\ncouch_db:collect_results/3.\ncouch_server: server statistics\ndatabase_reads: Number of times a document was read from a database.\ndatabase_purges: Number of times a database was purged.\ndatabase_writes: Number of times a database was changed.\ndb_open_time: Milliseconds required to open a database.\ndbinfo: Distribution of latencies for calls to retrieve db info.\ndocument_inserts: Number of documents inserted.\ndocument_purges: Number of document purge operations.\ndocument_writes: Number of document write operations.\nhttpd: httpd statistics\nhttpd_request_methods: HTTP request method statistics\nhttpd_status_codes: HTTP status code statistics\nio_queue: IO queue statistics\nio_queue2: IO queue2 statistics\nio_queue_bypassed: IO queue bypass statistics\nlocal_document_writes: Number of _local document write operations.\nmrview: mrview statistics\nopen_databases: Number of open databases.\nopen_os_files: Number of file descriptors couchdb has open.\nquery_server: Query server statistics\nrequest_time: Length of a request inside couchdb without mochiweb.", "properties": { "auth_cache_hits": { "$ref": "#/components/schemas/NodeStatsCounter" }, "auth_cache_misses": { "$ref": "#/components/schemas/NodeStatsCounter" }, "collect_results_time": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "couch_server": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbCouchServer" }, "database_purges": { "$ref": "#/components/schemas/NodeStatsCounter" }, "database_reads": { "$ref": "#/components/schemas/NodeStatsCounter" }, "database_writes": { "$ref": "#/components/schemas/NodeStatsCounter" }, "db_open_time": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "dbinfo": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "document_inserts": { "$ref": "#/components/schemas/NodeStatsCounter" }, "document_purges": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbDocumentPurges" }, "document_writes": { "$ref": "#/components/schemas/NodeStatsCounter" }, "httpd": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbHttpd" }, "httpd_request_methods": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbHttpdRequestMethods" }, "httpd_status_codes": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbHttpdStatusCodes" }, "io_queue": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue" }, "io_queue2": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2" }, "io_queue_bypassed": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueueBypassed" }, "local_document_writes": { "$ref": "#/components/schemas/NodeStatsCounter" }, "mrview": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbMrview" }, "open_databases": { "$ref": "#/components/schemas/NodeStatsCounter" }, "open_os_files": { "$ref": "#/components/schemas/NodeStatsCounter" }, "query_server": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbQueryServer" }, "request_time": { "$ref": "#/components/schemas/NodeStatsHistogram" } }, "type": "object" }, "NodeStatsInformationCouchdbCouchServer": { "additionalProperties": false, "description": "couch_server\nlru_skip: Number of couch_server lru operations skipped.", "properties": { "lru_skip": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbDocumentPurges": { "additionalProperties": false, "description": "Schema for document purge operations.", "properties": { "failure": { "$ref": "#/components/schemas/NodeStatsCounter" }, "success": { "$ref": "#/components/schemas/NodeStatsCounter" }, "total": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbHttpd": { "additionalProperties": false, "description": "httpd\naborted_requests: Number of aborted requests.\nbulk_docs: Distribution of the number of docs in _bulk_docs requests.\nbulk_requests: Number of bulk requests.\nclients_requesting_changes: Number of clients for continuous _changes.\nrequests: Number of http requests.\ntemporary_view_reads: Number of temporary view reads.\nview_reads: Number of view reads.", "properties": { "aborted_requests": { "$ref": "#/components/schemas/NodeStatsCounter" }, "all_docs_timeouts": { "$ref": "#/components/schemas/NodeStatsCounter" }, "bulk_docs": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "bulk_requests": { "$ref": "#/components/schemas/NodeStatsCounter" }, "clients_requesting_changes": { "$ref": "#/components/schemas/NodeStatsCounter" }, "explain_timeouts": { "$ref": "#/components/schemas/NodeStatsCounter" }, "find_timeouts": { "$ref": "#/components/schemas/NodeStatsCounter" }, "partition_all_docs_requests": { "$ref": "#/components/schemas/NodeStatsCounter" }, "partition_all_docs_timeouts": { "$ref": "#/components/schemas/NodeStatsCounter" }, "partition_explain_requests": { "$ref": "#/components/schemas/NodeStatsCounter" }, "partition_explain_timeouts": { "$ref": "#/components/schemas/NodeStatsCounter" }, "partition_find_requests": { "$ref": "#/components/schemas/NodeStatsCounter" }, "partition_find_timeouts": { "$ref": "#/components/schemas/NodeStatsCounter" }, "partition_view_requests": { "$ref": "#/components/schemas/NodeStatsCounter" }, "partition_view_timeouts": { "$ref": "#/components/schemas/NodeStatsCounter" }, "purge_requests": { "$ref": "#/components/schemas/NodeStatsCounter" }, "requests": { "$ref": "#/components/schemas/NodeStatsCounter" }, "temporary_view_reads": { "$ref": "#/components/schemas/NodeStatsCounter" }, "view_reads": { "$ref": "#/components/schemas/NodeStatsCounter" }, "view_timeouts": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbHttpdRequestMethods": { "additionalProperties": false, "description": "httpd_request_methods\nCOPY: Number of http copy requests.\nDELETE: Number of http delete requests.\nGET: Number of http get requests.\nHEAD: Number of http head requests.\nOPTIONS: Number of http options requests.\nPOST: Number of http post requests.\nPUT: Number of http put requests.", "properties": { "COPY": { "$ref": "#/components/schemas/NodeStatsCounter" }, "DELETE": { "$ref": "#/components/schemas/NodeStatsCounter" }, "GET": { "$ref": "#/components/schemas/NodeStatsCounter" }, "HEAD": { "$ref": "#/components/schemas/NodeStatsCounter" }, "OPTIONS": { "$ref": "#/components/schemas/NodeStatsCounter" }, "POST": { "$ref": "#/components/schemas/NodeStatsCounter" }, "PUT": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbHttpdStatusCodes": { "additionalProperties": false, "description": "httpd_status_codes\n200: Number of http 200 ok responses.\n201: Number of http 201 created responses.\n202: Number of http 202 accepted response.\n204: Number of http 204 no content responses.\n206: Number of http 206 partial content.\n301: Number of http 301 moved permanently responses.\n302: Number of http 302 found responses.\n304: Number of http 304 not modified responses.\n400: Number of http 400 bad request responses.\n401: Number of http 401 unauthorized responses.\n402: Number of http 402 payment required responses.\n403: Number of http 403 forbidden responses.\n404: Number of http 404 not found responses.\n405: Number of http 405 method not allowed responses.\n406: Number of http 406 not acceptable responses.\n409: Number of http 409 conflict responses.\n412: Number of http 412 precondition failed responses.\n413: Number of http 413 request entity too long responses.\n414: Number of http 414 request uri too long responses.\n415: Number of http 415 unsupported media type responses.\n416: Number of http 416 requested range not satisfiable responses.\n417: Number of http 417 expectation failed responses.\n500: Number of http 500 internal server error responses.\n501: Number of http 501 not implemented responses.\n503: Number of http 503 service unavailable responses.", "properties": { "200": { "$ref": "#/components/schemas/NodeStatsCounter" }, "201": { "$ref": "#/components/schemas/NodeStatsCounter" }, "202": { "$ref": "#/components/schemas/NodeStatsCounter" }, "204": { "$ref": "#/components/schemas/NodeStatsCounter" }, "206": { "$ref": "#/components/schemas/NodeStatsCounter" }, "301": { "$ref": "#/components/schemas/NodeStatsCounter" }, "302": { "$ref": "#/components/schemas/NodeStatsCounter" }, "304": { "$ref": "#/components/schemas/NodeStatsCounter" }, "400": { "$ref": "#/components/schemas/NodeStatsCounter" }, "401": { "$ref": "#/components/schemas/NodeStatsCounter" }, "402": { "$ref": "#/components/schemas/NodeStatsCounter" }, "403": { "$ref": "#/components/schemas/NodeStatsCounter" }, "404": { "$ref": "#/components/schemas/NodeStatsCounter" }, "405": { "$ref": "#/components/schemas/NodeStatsCounter" }, "406": { "$ref": "#/components/schemas/NodeStatsCounter" }, "409": { "$ref": "#/components/schemas/NodeStatsCounter" }, "412": { "$ref": "#/components/schemas/NodeStatsCounter" }, "413": { "$ref": "#/components/schemas/NodeStatsCounter" }, "414": { "$ref": "#/components/schemas/NodeStatsCounter" }, "415": { "$ref": "#/components/schemas/NodeStatsCounter" }, "416": { "$ref": "#/components/schemas/NodeStatsCounter" }, "417": { "$ref": "#/components/schemas/NodeStatsCounter" }, "500": { "$ref": "#/components/schemas/NodeStatsCounter" }, "501": { "$ref": "#/components/schemas/NodeStatsCounter" }, "503": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue": { "additionalProperties": false, "description": "io_queue\ndb_compact: Db compaction requests routed through IO queue.\ndb_update: Db update requests routed through IO queue.\ninteractive: IO directly triggered by client requests.\ninternal_repl: IO related to internal replication.\nlatency: Delay introduced by routing request through IO queue.\nlow: Number of requests routed through IO at low priority.\nmerged: Number of requests routed through IO queue that were merged.\nosproc: Number of requests routed through IO OS queue.\nother: IO related to internal replication.\nreads: Number of read requests routed through IO queue.\nundefined: Number of requests routed through IO queue without class.\nunknown: Number of unknown requests routed through IO queue.\nview_compact: View compaction requests routed through IO queue.\nview_update: View indexing requests routed through IO queue.\nwrites: Number of write requests routed through IO queue.", "properties": { "db_compact": { "$ref": "#/components/schemas/NodeStatsCounter" }, "db_update": { "$ref": "#/components/schemas/NodeStatsCounter" }, "interactive": { "$ref": "#/components/schemas/NodeStatsCounter" }, "internal_repl": { "$ref": "#/components/schemas/NodeStatsCounter" }, "latency": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "low": { "$ref": "#/components/schemas/NodeStatsCounter" }, "merged": { "$ref": "#/components/schemas/NodeStatsCounter" }, "osproc": { "$ref": "#/components/schemas/NodeStatsCounter" }, "other": { "$ref": "#/components/schemas/NodeStatsCounter" }, "reads": { "$ref": "#/components/schemas/NodeStatsCounter" }, "search": { "$ref": "#/components/schemas/NodeStatsCounter" }, "undefined": { "$ref": "#/components/schemas/NodeStatsCounter" }, "unknown": { "$ref": "#/components/schemas/NodeStatsCounter" }, "view_compact": { "$ref": "#/components/schemas/NodeStatsCounter" }, "view_update": { "$ref": "#/components/schemas/NodeStatsCounter" }, "writes": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2": { "additionalProperties": false, "description": "io_queue2\nbypassed_count: Number of requests that bypassed IO queue.\ndb_compact: db_compact statistics\ndb_meta: db_meta statistics\ndb_update: db_update statistics\ninteractive: interactive statistics\ninternal_repl: internal_repl statistics\nio_errors: Number of IO errors.\niowait: Total time request spent waiting on IO.\nlow: low priority statistics\nmerged: Number of requests routed through IO queue that were merged.\nosproc: os proc statistics\nother: other statistics\nqueued: Number of requests queued into IO.\nreads: read statistics\nsearch: Number of Search IO requests\nsubmit_delay: Delay introduced by routing request through IO queue.\nsvctm: Time taken to service the IO request.\nundefined: statistics for undefined requests\nunknown: statistics for unknown requests\nview_compact: view_compact statistics\nview_update: view_update statistics\nwrites: write statistics", "properties": { "bypassed_count": { "$ref": "#/components/schemas/NodeStatsCounter" }, "db_compact": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2DbCompact" }, "db_meta": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2DbMeta" }, "db_update": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2DbUpdate" }, "interactive": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2Interactive" }, "internal_repl": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2InternalRepl" }, "io_errors": { "$ref": "#/components/schemas/NodeStatsCounter" }, "iowait": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "low": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2Low" }, "merged": { "$ref": "#/components/schemas/NodeStatsCounter" }, "osproc": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2Osproc" }, "other": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2Other" }, "queued": { "$ref": "#/components/schemas/NodeStatsCounter" }, "reads": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2Reads" }, "search": { "$ref": "#/components/schemas/NodeStatsCounter" }, "submit_delay": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "svctm": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "undefined": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2Undefined" }, "unknown": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2Unknown" }, "view_compact": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2ViewCompact" }, "view_update": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2ViewUpdate" }, "writes": { "$ref": "#/components/schemas/NodeStatsInformationCouchdbIoQueue2Writes" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2DbCompact": { "additionalProperties": false, "description": "db_compact\ncount: Db compaction requests routed through IO queue.", "properties": { "count": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2DbMeta": { "additionalProperties": false, "description": "db_meta\ncount: IO related to db_meta.", "properties": { "count": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2DbUpdate": { "additionalProperties": false, "description": "db_update\ncount: DB update requests routed through IO queue.", "properties": { "count": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2Interactive": { "additionalProperties": false, "description": "interactive\ncount: IO directly triggered by client requests.", "properties": { "count": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2InternalRepl": { "additionalProperties": false, "description": "internal_repl\ncount: IO related to internal replication.", "properties": { "count": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2Low": { "additionalProperties": false, "description": "low\ncount: Number of requests routed through IO at low priority.", "properties": { "count": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2Osproc": { "additionalProperties": false, "description": "osproc\ncount: Number of requests routed through IO OS queue.", "properties": { "count": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2Other": { "additionalProperties": false, "description": "other\ncount: IO related to internal replication.", "properties": { "count": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2Reads": { "additionalProperties": false, "description": "reads\nbypassed_count: Number of read requests that bypassed IO queue.\ncount: Number of read requests routed through IO queue.\nqueued: Number of read requests queued into IO queue.", "properties": { "bypassed_count": { "$ref": "#/components/schemas/NodeStatsCounter" }, "count": { "$ref": "#/components/schemas/NodeStatsCounter" }, "queued": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2Undefined": { "additionalProperties": false, "description": "undefined\ncount: Number of requests routed through IO queue without class", "properties": { "count": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2Unknown": { "additionalProperties": false, "description": "unknown\nbypassed_count: Number of unknown requests that bypassed IO queue.\ncount: Number of unknown requests routed through IO queue.\nqueued: Number of unknown requests queued into IO queue.", "properties": { "bypassed_count": { "$ref": "#/components/schemas/NodeStatsCounter" }, "count": { "$ref": "#/components/schemas/NodeStatsCounter" }, "queued": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2ViewCompact": { "additionalProperties": false, "description": "view_compact\ncount: View compaction requests routed through IO queue.", "properties": { "count": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2ViewUpdate": { "additionalProperties": false, "description": "view_update\ncount: View indexing requests routed through IO queue.", "properties": { "count": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueue2Writes": { "additionalProperties": false, "description": "writes\nbypassed_count: Number of write requests that bypassed IO queue.\ncount: Number of write requests routed through IO queue.\nqueued: Number of write requests queued into IO queue.", "properties": { "bypassed_count": { "$ref": "#/components/schemas/NodeStatsCounter" }, "count": { "$ref": "#/components/schemas/NodeStatsCounter" }, "queued": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbIoQueueBypassed": { "additionalProperties": false, "description": "io_queue_bypassed\ndb_compact: DB compaction requests that bypassed IO queue.\ndb_update: DB update requests that bypassed IO queue.\ninteractive: Bypassed IO directly triggered by client requests.\ninternal_repl: Bypassed IO related to internal replication.\nlow: Number of requests that bypassed IO at low priority.\nmerged: Number of requests that bypassed IO queue that were merged.\nosproc: Number of requests that bypassed IO OS queue.\nother: Bypassed IO related to internal replication.\nreads: Number of read requests that bypassed IO queue.\nundefined: Number of requests that bypassed IO queue without class.\nunknown: Number of unknown requests that bypassed IO queue.\nview_compact: View compaction requests that bypassed IO queue.\nview_update: View indexing requests that bypassed IO queue.\nwrites: Number of write requests that bypassed IO queue.", "properties": { "db_compact": { "$ref": "#/components/schemas/NodeStatsCounter" }, "db_update": { "$ref": "#/components/schemas/NodeStatsCounter" }, "interactive": { "$ref": "#/components/schemas/NodeStatsCounter" }, "internal_repl": { "$ref": "#/components/schemas/NodeStatsCounter" }, "low": { "$ref": "#/components/schemas/NodeStatsCounter" }, "merged": { "$ref": "#/components/schemas/NodeStatsCounter" }, "osproc": { "$ref": "#/components/schemas/NodeStatsCounter" }, "other": { "$ref": "#/components/schemas/NodeStatsCounter" }, "reads": { "$ref": "#/components/schemas/NodeStatsCounter" }, "undefined": { "$ref": "#/components/schemas/NodeStatsCounter" }, "unknown": { "$ref": "#/components/schemas/NodeStatsCounter" }, "view_compact": { "$ref": "#/components/schemas/NodeStatsCounter" }, "view_update": { "$ref": "#/components/schemas/NodeStatsCounter" }, "writes": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbMrview": { "additionalProperties": false, "description": "mrview\nemits: Number of invocations of emit in map functions in the view\nserver.\nmap_doc: Number of documents mapped in the view server.", "properties": { "emits": { "$ref": "#/components/schemas/NodeStatsCounter" }, "map_doc": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationCouchdbQueryServer": { "additionalProperties": false, "description": "query_server\nvdu_process_time: Duration of validate_doc_update function calls.\nvdu_rejects: Number of rejections by validate_doc_update function.", "properties": { "vdu_process_time": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "vdu_rejects": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationDbcopy": { "additionalProperties": false, "deprecated": true, "description": "dbcopy\nacquire_lock: Number of lock acquisitions performed by dbcopy.\nnoop: Number of dbcopy writes skipped.\nupdate_doc: Number of dbcopy write operations attempted.\nupdate_error: Number of failed dbcopy writes.", "properties": { "acquire_lock": { "$ref": "#/components/schemas/NodeStatsCounter" }, "noop": { "$ref": "#/components/schemas/NodeStatsCounter" }, "update_doc": { "$ref": "#/components/schemas/NodeStatsCounter" }, "update_error": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationDdocCache": { "additionalProperties": false, "description": "ddoc_cache\nhit: Number of design doc cache hits.\nmiss: Number of design doc cache misses.\nrecovery: Number of design doc cache recoveries.", "properties": { "hit": { "$ref": "#/components/schemas/NodeStatsCounter" }, "miss": { "$ref": "#/components/schemas/NodeStatsCounter" }, "recovery": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationDreyfus": { "additionalProperties": false, "description": "dreyfus\nhttpd: httpd statistics\nindex: index statistics\nrpc: rpc statistics", "properties": { "httpd": { "$ref": "#/components/schemas/NodeStatsInformationDreyfusHttpd" }, "index": { "$ref": "#/components/schemas/NodeStatsInformationDreyfusIndex" }, "rpc": { "$ref": "#/components/schemas/NodeStatsInformationDreyfusRpc" } }, "type": "object" }, "NodeStatsInformationDreyfusHttpd": { "additionalProperties": false, "description": "httpd\nsearch: Distribution of overall search request latency as experienced\nby the end user.", "properties": { "search": { "$ref": "#/components/schemas/NodeStatsHistogram" } }, "type": "object" }, "NodeStatsInformationDreyfusIndex": { "additionalProperties": false, "description": "index\nawait: Length of an dreyfus_index await request.\ngroup1: Length of an dreyfus_index group1 request.\ngroup2: Length of an dreyfus_index group2 request.\ninfo: Length of an dreyfus_index info request.\nsearch: Length of an dreyfus_index search request.", "properties": { "await": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "group1": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "group2": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "info": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "search": { "$ref": "#/components/schemas/NodeStatsHistogram" } }, "type": "object" }, "NodeStatsInformationDreyfusRpc": { "additionalProperties": false, "description": "rpc\ngroup1: Length of a group1 rpc worker.\ngroup2: Length of a group2 rpc worker.\ninfo: Length of an info rpc worker.\nsearch: Length of a search rpc worker.", "properties": { "group1": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "group2": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "info": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "search": { "$ref": "#/components/schemas/NodeStatsHistogram" } }, "type": "object" }, "NodeStatsInformationEpep": { "additionalProperties": false, "description": "epep\naccess_token_latency: Distribution of latencies for calls to acquire\naccess tokens.\nauthz_latency: Distribution of latencies for calls to retrieve pdp\ndecisions.\nauthz_service_available: IAM PDP is currently available.\ndecision_cache: decision_cache statistics\nkeystore_service_available: IAM keystore service is currently available.\nreplicator_token: replicator_token statistics\nreplicator_token_latency: Distribution of latencies for replicator\naccess token requests.\ntoken_service_available: IAM token service is currently available.", "properties": { "access_token_latency": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "authz_latency": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "authz_service_available": { "$ref": "#/components/schemas/NodeStatsGauge" }, "decision_cache": { "$ref": "#/components/schemas/NodeStatsInformationEpepDecisionCache" }, "keystore_service_available": { "$ref": "#/components/schemas/NodeStatsGauge" }, "replicator_token": { "$ref": "#/components/schemas/NodeStatsInformationEpepReplicatorToken" }, "replicator_token_latency": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "token_service_available": { "$ref": "#/components/schemas/NodeStatsGauge" } }, "type": "object" }, "NodeStatsInformationEpepDecisionCache": { "additionalProperties": false, "description": "decision_cache\nfresh_hit: Cache hit for PDP decision lookup when decision is fresh.\nmiss: Cache miss for PDP decision lookup.\nstale_hit: Cache hit for PDP decision lookup when decision is stale.", "properties": { "fresh_hit": { "$ref": "#/components/schemas/NodeStatsCounter" }, "miss": { "$ref": "#/components/schemas/NodeStatsCounter" }, "stale_hit": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationEpepReplicatorToken": { "additionalProperties": false, "description": "replicator_token\ncomplete: Complete replicator access token requests.\nfailure: Failed replicator access token requests.\nincomplete: Incomplete replicator access token requests.\nsuccess: Successful replicator access token requests.", "properties": { "complete": { "$ref": "#/components/schemas/NodeStatsCounter" }, "failure": { "$ref": "#/components/schemas/NodeStatsCounter" }, "incomplete": { "$ref": "#/components/schemas/NodeStatsCounter" }, "success": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationFabric": { "additionalProperties": false, "description": "fabric\ndoc_update: doc_update statistics\nopen_shard: open_shard statistics\nread_repairs: read_repairs statistics\nworker: worker statistics", "properties": { "doc_update": { "$ref": "#/components/schemas/NodeStatsInformationFabricDocUpdate" }, "open_shard": { "$ref": "#/components/schemas/NodeStatsInformationFabricOpenShard" }, "read_repairs": { "$ref": "#/components/schemas/NodeStatsInformationFabricReadRepairs" }, "worker": { "$ref": "#/components/schemas/NodeStatsInformationFabricWorker" } }, "type": "object" }, "NodeStatsInformationFabricDocUpdate": { "additionalProperties": false, "description": "doc_update\nerrors: Number of document update errors.\nmismatched_errors: Number of document update errors with multiple\nerror types.\nwrite_quorum_errors: Number of write quorum errors.", "properties": { "errors": { "$ref": "#/components/schemas/NodeStatsCounter" }, "mismatched_errors": { "$ref": "#/components/schemas/NodeStatsCounter" }, "write_quorum_errors": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationFabricOpenShard": { "additionalProperties": false, "description": "open_shard\ntimeouts: Number of open shard timeouts.", "properties": { "timeouts": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationFabricReadRepairs": { "additionalProperties": false, "description": "read_repairs\nfailure: Number of failed read repair operations.\nsuccess: Number of successful read repair operations.", "properties": { "failure": { "$ref": "#/components/schemas/NodeStatsCounter" }, "success": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationFabricWorker": { "additionalProperties": false, "description": "worker\ntimeouts: Number of worker timeouts.", "properties": { "timeouts": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationGlobalChanges": { "additionalProperties": false, "description": "global_changes\ndb_writes: Number of db writes performed by global changes.\nevent_doc_conflict: Number of conflicted event docs encountered by\nglobal changes.\nlistener_pending_updates: Number of global changes updates pending\nwrites in global_changes_listener.\nrpcs: Number of rpc operations performed by global_changes.\nserver_pending_updates: Number of global changes updates pending writes\nin global_changes_server.", "properties": { "db_writes": { "$ref": "#/components/schemas/NodeStatsCounter" }, "event_doc_conflict": { "$ref": "#/components/schemas/NodeStatsCounter" }, "listener_pending_updates": { "$ref": "#/components/schemas/NodeStatsGauge" }, "rpcs": { "$ref": "#/components/schemas/NodeStatsCounter" }, "server_pending_updates": { "$ref": "#/components/schemas/NodeStatsGauge" } }, "type": "object" }, "NodeStatsInformationMango": { "additionalProperties": false, "description": "mango\ndocs_examined: number of documents examined by mango queries coordinated\n by this node\nevaluate_selector: number of mango selector evaluations\nquery_invalid_index: number of mango queries that generated an invalid\n index warning\nquery_time: length of time processing a mango query\nquorum_docs_examined: number of documents examined by mango queries,\n using cluster quorum\nresults_returned: number of rows returned by mango queries\ntoo_many_docs_scanned: number of mango queries that generated an index\n scan warning\nunindexed_queries: number of mango queries that could not use an index", "properties": { "docs_examined": { "$ref": "#/components/schemas/NodeStatsCounter" }, "evaluate_selector": { "$ref": "#/components/schemas/NodeStatsCounter" }, "query_invalid_index": { "$ref": "#/components/schemas/NodeStatsCounter" }, "query_time": { "$ref": "#/components/schemas/NodeStatsHistogram" }, "quorum_docs_examined": { "$ref": "#/components/schemas/NodeStatsCounter" }, "results_returned": { "$ref": "#/components/schemas/NodeStatsCounter" }, "too_many_docs_scanned": { "$ref": "#/components/schemas/NodeStatsCounter" }, "unindexed_queries": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationMem3": { "additionalProperties": false, "description": "mem3\nshard_cache: shard_cache statistics", "properties": { "shard_cache": { "$ref": "#/components/schemas/NodeStatsInformationMem3ShardCache" } }, "type": "object" }, "NodeStatsInformationMem3ShardCache": { "additionalProperties": false, "description": "shard_cache\neviction: Number of shard cache evictions.\nhit: Number of shard cache hits.\nmiss: Number of shard cache misses.", "properties": { "eviction": { "$ref": "#/components/schemas/NodeStatsCounter" }, "hit": { "$ref": "#/components/schemas/NodeStatsCounter" }, "miss": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationPread": { "additionalProperties": false, "description": "pread\nexceed_eof: Number of the attempts to read beyond end of db file.\nexceed_limit: Number of the attempts to read beyond set limit.", "properties": { "exceed_eof": { "$ref": "#/components/schemas/NodeStatsCounter" }, "exceed_limit": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeStatsInformationRexi": { "additionalProperties": false, "description": "rexi\nbuffered: Number of rexi messages buffered.\ndown: Number of rexi_down messages handled.\ndropped: Number of rexi messages dropped from buffers.\nstreams: Stream statistics", "properties": { "buffered": { "$ref": "#/components/schemas/NodeStatsCounter" }, "down": { "$ref": "#/components/schemas/NodeStatsCounter" }, "dropped": { "$ref": "#/components/schemas/NodeStatsCounter" }, "streams": { "$ref": "#/components/schemas/NodeStatsInformationRexiStreams" } }, "type": "object" }, "NodeStatsInformationRexiStreams": { "additionalProperties": false, "description": "streams\ntimeout: timeout statistics", "properties": { "timeout": { "$ref": "#/components/schemas/NodeStatsInformationRexiStreamsTimeout" } }, "type": "object" }, "NodeStatsInformationRexiStreamsTimeout": { "additionalProperties": false, "description": "timeout\ninit_stream: Number of rexi stream initialization timeouts.\nstream: Number of rexi stream timeouts.\nwait_for_ack: Number of rexi stream timeouts while waiting for acks", "properties": { "init_stream": { "$ref": "#/components/schemas/NodeStatsCounter" }, "stream": { "$ref": "#/components/schemas/NodeStatsCounter" }, "wait_for_ack": { "$ref": "#/components/schemas/NodeStatsCounter" } }, "type": "object" }, "NodeSystemInformation": { "additionalProperties": true, "description": "Schema for system-level statistics for the running server.", "type": "object" }, "Ok": { "additionalProperties": false, "description": "Schema for an OK result.", "properties": { "ok": { "description": "ok", "type": "boolean" } }, "type": "object" }, "PartitionFindQuery": { "additionalProperties": false, "description": "Schema for a query find operation in a partition.", "properties": { "allow_fallback": { "default": true, "description": "Whether to allow fallback to other indexes. Default is true.", "type": "boolean" }, "bookmark": { "$ref": "#/components/schemas/Bookmark" }, "conflicts": { "description": "A boolean value that indicates whether or not to include information about existing conflicts in the document.", "type": "boolean" }, "execution_stats": { "description": "Use this option to find information about the query that was run. This information includes total key lookups, total document lookups (when `include_docs=true` is used), and total quorum document lookups (when each document replica is fetched).", "type": "boolean" }, "fields": { "$ref": "#/components/schemas/Fields" }, "limit": { "default": 25, "description": "Maximum number of results returned. The `type: text` indexes are limited to 200 results when queried.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "selector": { "$ref": "#/components/schemas/Selector" }, "skip": { "description": "Skip the first 'n' results, where 'n' is the value that is specified.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "sort": { "description": "The sort field contains a list of pairs, each mapping a field name\nto a sort direction (asc or desc).\nThe first field name and direction pair is the topmost level of\nsort. The second pair, if provided, is the next level of sort.\nThe field can be any field, using dotted notation if desired for\nsub-document fields.\n\nFor example in JSON:\n`[{\"fieldName1\": \"desc\"}, {\"fieldName2.subFieldName1\": \"desc\"}]`\n\nWhen sorting with multiple fields, ensure that there is an index\nalready defined with all the sort fields in the same order and each\nobject in the sort array has a single key or at least one of the\nsort fields is included in the selector. All sorting fields must\nuse the same sort direction, either all ascending or all descending.", "items": { "$ref": "#/components/schemas/FieldSort" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "stable": { "description": "Whether or not the view results should be returned from a \"stable\" set of shards.", "type": "boolean" }, "update": { "default": "true", "description": "Whether to update the index prior to returning the result.", "enum": [ "false", "true", "lazy" ], "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "use_index": { "description": "Use this option to identify a specific index to answer the query,\nrather than letting the IBM Cloudant query planner choose an index.\nSpecified as a two element array of design document id\nfollowed by index name, for example `[\"my_design_doc\", \"my_index\"]`.\n\nIt’s recommended to specify indexes explicitly in your queries\nto prevent existing queries being affected by new indexes that might\nget added later.\n\nIf the specified index doesn't exist or can't answer the query\nthen the server ignores the value and answers using another index\nor a full scan of all documents.\nTo change this behavior set `allow_fallback` to `false` and the\nserver responds instead with a `400` status code if the requested\nindex is unsuitable to answer the query.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" } }, "required": [ "selector" ], "type": "object" }, "PartitionInformation": { "additionalProperties": false, "description": "Schema for information about a database partition.", "properties": { "db_name": { "$ref": "#/components/schemas/DatabaseName" }, "doc_count": { "description": "A count of the documents in the specified database partition.", "format": "int64", "maximum": 195225786, "minimum": 0, "type": "integer" }, "doc_del_count": { "description": "Number of deleted documents.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "partition": { "$ref": "#/components/schemas/PartitionKey" }, "partitioned_indexes": { "$ref": "#/components/schemas/PartitionInformationIndexes" }, "sizes": { "$ref": "#/components/schemas/PartitionInformationSizes" } }, "required": [ "db_name", "doc_count", "doc_del_count", "partition", "sizes" ], "type": "object" }, "PartitionInformationIndexes": { "additionalProperties": false, "description": "Schema for information about the partition index count and limit in a database.", "properties": { "count": { "description": "Total count of the partitioned indexes.", "format": "int64", "maximum": 10, "minimum": 0, "type": "integer" }, "indexes": { "$ref": "#/components/schemas/PartitionInformationIndexesIndexes" }, "limit": { "description": "The partitioned index limit.", "format": "int64", "maximum": 10, "minimum": 0, "type": "integer" } } }, "PartitionInformationIndexesIndexes": { "additionalProperties": false, "description": "The count breakdown of partitioned indexes.", "properties": { "search": { "description": "Number of partitioned search indexes.", "format": "int64", "maximum": 10, "minimum": 0, "type": "integer" }, "view": { "description": "Number of partitioned view indexes.", "format": "int64", "maximum": 10, "minimum": 0, "type": "integer" } }, "type": "object" }, "PartitionInformationSizes": { "description": "The size of active and external data, in bytes.", "properties": { "active": { "description": "The size of live data inside the database, in bytes.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "external": { "description": "The uncompressed size of database contents in bytes.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } } }, "PartitionKey": { "description": "Schema for a partition key.", "maxLength": 7168, "minLength": 1, "pattern": "^[^_:][^:]*$", "type": "string" }, "PartitionSearchQuery": { "additionalProperties": false, "description": "Schema for a query search operation in a partition.", "properties": { "bookmark": { "$ref": "#/components/schemas/Bookmark" }, "highlight_fields": { "description": "Specifies which fields to highlight. If specified, the result object contains a highlights field with an entry for each specified field.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "highlight_number": { "default": 1, "description": "Number of fragments that are returned in highlights. If the search term occurs less often than the number of fragments that are specified, longer fragments are returned.", "format": "int64", "maximum": 1048521, "minimum": 1, "type": "integer" }, "highlight_post_tag": { "default": "", "description": "A string that is inserted after the highlighted word in the highlights output.", "maxLength": 7168, "minLength": 1, "pattern": "^$", "type": "string" }, "highlight_pre_tag": { "default": "", "description": "A string that is inserted before the highlighted word in the highlights output.", "maxLength": 7168, "minLength": 1, "pattern": "^<.*>$", "type": "string" }, "highlight_size": { "default": 100, "description": "Number of characters in each fragment for highlights.", "format": "int64", "maximum": 1048521, "minimum": 1, "type": "integer" }, "include_docs": { "default": false, "description": "Include the full content of the documents in the return.", "type": "boolean" }, "include_fields": { "description": "A JSON array of field names to include in search results. Any fields that are included must be indexed with the store:true option. The default is all fields.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "limit": { "description": "Limit the number of the returned documents to the specified number.", "format": "int64", "maximum": 200, "minimum": 0, "type": "integer" }, "query": { "description": "The Lucene query to execute.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string", "x-alias": "q" }, "sort": { "description": "Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter specifies the sort order within a group. The default sort order is relevance. A JSON string of the form \"fieldname<type>\" or \"-fieldname<type>\" for descending order, where fieldname is the name of a string or number field, and type is either a number, a string, or a JSON array of strings. The type part is optional, and defaults to number. Some examples are \"foo\", \"-foo\", \"bar<string>\", \"-foo<number>\" and [\"-foo<number>\", \"bar<string>\"]. String fields that are used for sorting must not be analyzed fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.", "items": { "$ref": "#/components/schemas/SearchSort" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "stale": { "description": "Do not wait for the index to finish building to return results.", "enum": [ "ok" ], "type": "string" } }, "required": [ "query" ], "type": "object" }, "PartitionViewQuery": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/CommonViewQuery" }, { "additionalProperties": false, "description": "Schema for a partitioned query view operation.", "properties": { "end_key": { "$ref": "#/components/schemas/AnyJsonType" }, "end_key_doc_id": { "allOf": [ { "$ref": "#/components/schemas/DocumentId" }, { "description": "Stop returning rows at the specified document ID. No effect if using `group` or not providing end key." } ] }, "group": { "default": false, "description": "Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the number of array elements with the `group_level` parameter.", "type": "boolean" }, "group_level": { "description": "Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. Implies group is `true`. Group level groups the reduced results by the specified number of array elements. If unset, results are grouped by the entire array key, returning a reduced value for each complete key.", "format": "int64", "maximum": 4294967295, "minimum": 1, "type": "integer" }, "key": { "allOf": [ { "$ref": "#/components/schemas/AnyJsonType" }, { "description": "Parameter to specify to return only rows that match the specified key. String representation of any JSON type that matches the key type emitted by the view function." } ] }, "keys": { "description": "Parameter to specify returning only rows that match any of the specified keys. A JSON array of keys that match the key type emitted by the view function.", "items": { "$ref": "#/components/schemas/AnyJsonType" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "reduce": { "default": true, "description": "Parameter to specify whether to use the reduce function in\na map-reduce view. Default is true when a reduce function is\ndefined.\n\nA default `reduce` view type can be disabled to behave like a\n`map` by setting `reduce=false` explicitly.\n\nBe aware that `include_docs=true` is only for `map` views.\nReduced views do not include document IDs in view rows.", "type": "boolean" }, "start_key": { "$ref": "#/components/schemas/AnyJsonType" }, "start_key_doc_id": { "allOf": [ { "$ref": "#/components/schemas/DocumentId" }, { "description": "Start returning rows at the specified document ID. No effect if using `group` or not providing start key." } ] }, "update": { "default": "true", "description": "Parameter to specify whether or not the view in question\nshould be updated prior to responding to the user.\n\n* `true` - Return results after the view is updated.\n* `false` - Return results without updating the view.\n* `lazy` - Return the view results without waiting for an\nupdate, but update them immediately after the request.", "enum": [ "true", "false", "lazy" ], "type": "string" } }, "type": "object", "x-alias": { "end_key": "endkey", "end_key_doc_id": "endkey_docid", "start_key": "startkey", "start_key_doc_id": "startkey_docid" } } ], "description": "Schema for a partitioned query view operation.", "type": "object" }, "PartitionedIndexesDetailedInformation": { "description": "Number of partitioned indexes by type.", "properties": { "search": { "description": "Number of partitioned indexes of search type.", "format": "int64", "maximum": 10, "minimum": 0, "type": "integer" }, "view": { "description": "Number of partitioned indexes of view type.", "format": "int64", "maximum": 10, "minimum": 0, "type": "integer" } }, "type": "object" }, "PartitionedIndexesInformation": { "description": "Information about database's partitioned indexes.", "properties": { "count": { "description": "Total number of partitioned indexes in the database.", "format": "int64", "maximum": 10, "minimum": 0, "type": "integer" }, "indexes": { "$ref": "#/components/schemas/PartitionedIndexesDetailedInformation" }, "limit": { "default": 10, "description": "Maximum allowed number of partitioned indexes in the database.", "format": "int64", "maximum": 10, "minimum": 0, "type": "integer" } }, "type": "object" }, "PathDocumentId": { "description": "Schema for a document ID.", "maxLength": 7168, "minLength": 1, "pattern": "^[^_].+$", "type": "string" }, "QueryParameters": { "additionalProperties": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "description": "Schema for a map of string key value pairs, such as query parameters.", "type": "object" }, "ReplicaCount": { "default": 3, "description": "Schema for the number of replicas of a database in a cluster. The cluster is using the default value and it cannot be changed by the user.", "format": "int64", "maximum": 3, "minimum": 3, "type": "integer" }, "ReplicationCreateTargetParameters": { "additionalProperties": false, "description": "Request parameters to use during target database creation.", "properties": { "n": { "$ref": "#/components/schemas/ReplicaCount" }, "partitioned": { "default": false, "description": "Parameter to specify whether to enable database partitions when creating the target database.", "type": "boolean" }, "q": { "$ref": "#/components/schemas/ShardCount" } }, "type": "object" }, "ReplicationDatabase": { "additionalProperties": false, "description": "Schema for a replication source or target database.", "properties": { "auth": { "$ref": "#/components/schemas/ReplicationDatabaseAuth" }, "headers": { "additionalProperties": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "description": "Replication request headers.", "type": "object" }, "url": { "allOf": [ { "$ref": "#/components/schemas/DatabaseUrl" }, { "description": "Replication database URL." } ] } }, "required": [ "url" ], "type": "object" }, "ReplicationDatabaseAuth": { "additionalProperties": false, "description": "Schema for replication source or target database authentication.", "properties": { "basic": { "$ref": "#/components/schemas/ReplicationDatabaseAuthBasic" }, "iam": { "$ref": "#/components/schemas/ReplicationDatabaseAuthIam" } }, "type": "object" }, "ReplicationDatabaseAuthBasic": { "additionalProperties": false, "description": "Schema for basic authentication of replication source or target database.", "properties": { "password": { "description": "The password associated with the username.", "maxLength": 7168, "minLength": 16, "pattern": "^[^\\n\\t]{16,}$", "type": "string" }, "username": { "$ref": "#/components/schemas/Username" } }, "required": [ "password", "username" ], "type": "object" }, "ReplicationDatabaseAuthIam": { "additionalProperties": false, "description": "Schema for an IAM API key for replication database authentication.", "properties": { "api_key": { "description": "IAM API key.", "maxLength": 44, "minLength": 1, "pattern": "^[A-Za-z0-9_-]{2,}$", "type": "string" } }, "required": [ "api_key" ], "type": "object" }, "ReplicationDocument": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/Document" }, { "additionalProperties": false, "properties": { "cancel": { "description": "Cancels the replication.", "type": "boolean" }, "checkpoint_interval": { "default": 30000, "description": "Defines replication checkpoint interval in milliseconds.", "format": "int64", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "connection_timeout": { "default": 30000, "description": "HTTP connection timeout per replication. Even for very fast/reliable networks it might need to be increased if a remote database is too busy.", "format": "int64", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "continuous": { "default": false, "description": "Configure the replication to be continuous.", "type": "boolean" }, "create_target": { "default": false, "description": "Creates the target database. Requires administrator privileges on target server.", "type": "boolean" }, "create_target_params": { "$ref": "#/components/schemas/ReplicationCreateTargetParameters" }, "doc_ids": { "$ref": "#/components/schemas/DocumentIds" }, "filter": { "description": "The name of a filter function which is defined in a design document in the source database in {ddoc_id}/{filter} format. It determines which documents get replicated. Using the selector option provides performance benefits when compared with using the filter option. Use the selector option when possible.", "maxLength": 7168, "minLength": 1, "pattern": "^[^/]+/.+$", "type": "string" }, "http_connections": { "default": 20, "description": "Maximum number of HTTP connections per replication.", "format": "int64", "maximum": 100, "minimum": 1, "type": "integer" }, "owner": { "description": "The replication document owner. The server sets an appropriate value if the field is unset when writing a replication document. Only administrators can modify the value to an owner other than themselves.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "proxy": { "deprecated": true, "description": "Deprecated: see `source_proxy` and `target_proxy`. Address of a (http or socks5 protocol) proxy server through which replication with the source and target databases should occur.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string", "x-sdk-exclude": true }, "query_params": { "$ref": "#/components/schemas/QueryParameters" }, "retries_per_request": { "default": 5, "description": "Number of times a replication request is retried. The requests are retried with a doubling exponential backoff starting at 0.25 seconds, with a cap at 5 minutes.", "format": "int64", "maximum": 5000, "minimum": 0, "type": "integer" }, "selector": { "$ref": "#/components/schemas/Selector" }, "since_seq": { "description": "Start the replication at a specific sequence value.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "socket_options": { "description": "Replication socket options.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "source": { "$ref": "#/components/schemas/ReplicationDatabase" }, "source_proxy": { "deprecated": true, "description": "This setting is forbidden in IBM Cloudant replication documents. This setting may be used with alternative replication mediators.\n\nAddress of a (http or socks5 protocol) proxy server through which replication with the source database should occur.", "maxLength": 7168, "minLength": 1, "nullable": true, "pattern": "^http(s)?:\\/\\/.*$", "type": "string" }, "target": { "$ref": "#/components/schemas/ReplicationDatabase" }, "target_proxy": { "deprecated": true, "description": "This setting is forbidden in IBM Cloudant replication documents. This setting may be used with alternative replication mediators.\n\nAddress of a (http or socks5 protocol) proxy server through which replication with the target database should occur.", "maxLength": 7168, "minLength": 1, "nullable": true, "pattern": "^http(s)?:\\/\\/.*$", "type": "string" }, "use_bulk_get": { "description": "Specify whether to use _bulk_get for fetching documents from the source. If unset, the server configured default will be used.", "type": "boolean" }, "use_checkpoints": { "default": true, "description": "Specify if checkpoints should be saved during replication. Using checkpoints means a replication can be efficiently resumed.", "type": "boolean" }, "user_ctx": { "$ref": "#/components/schemas/UserContext" }, "winning_revs_only": { "default": false, "description": "Replicate only the winning revisions. Replication with this mode discards conflicting revisions. Replication IDs and checkpoints generated by this mode are different to those generated by default, so it is possible to first replicate the winning revisions then later backfill remaining revisions with a regular replication job.", "type": "boolean" }, "worker_batch_size": { "default": 500, "description": "Controls how many documents are processed. After each batch a checkpoint is written so this controls how frequently checkpointing occurs.", "format": "int64", "maximum": 65535, "minimum": 1, "type": "integer" }, "worker_processes": { "default": 4, "description": "Controls how many separate processes will read from the changes manager and write to the target. A higher number can improve throughput.", "format": "int64", "maximum": 16, "minimum": 1, "type": "integer" } }, "required": [ "source", "target" ], "type": "object" } ], "description": "Schema for a replication document. Note that `selector`, `doc_ids`, and `filter` are incompatible with each other.", "type": "object" }, "ReplicationHistory": { "additionalProperties": false, "description": "Schema for replication history information.", "properties": { "bulk_get_attempts": { "description": "Number of attempted _bulk_get fetches", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "bulk_get_docs": { "description": "Number of documents read with _bulk_get", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "doc_write_failures": { "description": "Number of document write failures.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "docs_read": { "description": "Number of documents read.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "docs_written": { "description": "Number of documents written to target.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "end_last_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "Last sequence number in changes stream." } ] }, "end_time": { "allOf": [ { "$ref": "#/components/schemas/DateTimeRFC2822" }, { "description": "Date/Time replication operation completed in RFC 2822 format." } ] }, "missing_checked": { "description": "Number of missing documents checked.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "missing_found": { "description": "Number of missing documents found.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "recorded_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "Last recorded sequence number." } ] }, "session_id": { "description": "Session ID for this replication operation.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "start_last_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "First sequence number in changes stream." } ] }, "start_time": { "allOf": [ { "$ref": "#/components/schemas/DateTimeRFC2822" }, { "description": "Date/Time replication operation started in RFC 2822 format." } ] } }, "required": [ "doc_write_failures", "docs_read", "docs_written", "end_last_seq", "end_time", "missing_checked", "missing_found", "recorded_seq", "session_id", "start_last_seq", "start_time" ], "type": "object" }, "ReplicationInformation": { "additionalProperties": false, "description": "Schema for information about a replication request.", "properties": { "_local_id": { "description": "Replication local ID.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "ok": { "default": true, "description": "Replication status.", "type": "boolean" } }, "required": [ "_local_id", "ok" ], "type": "object" }, "ReplicationResult": { "additionalProperties": false, "description": "Schema for a replication result.", "properties": { "history": { "description": "Replication history.", "items": { "$ref": "#/components/schemas/ReplicationHistory" }, "maxItems": 4294967295, "minItems": 1, "type": "array" }, "no_changes": { "description": "Changes since last checkpoint in replication history.", "type": "boolean" }, "ok": { "default": true, "description": "Replication status.", "type": "boolean" }, "replication_id_version": { "description": "Replication protocol version.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "session_id": { "description": "Unique session ID.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "source_last_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "Last sequence number read from source database." } ] } }, "required": [ "history", "ok", "replication_id_version", "session_id", "source_last_seq" ], "type": "object" }, "ReplicationState": { "description": "Schema for replication state.", "enum": [ "initializing", "error", "pending", "running", "crashing", "completed", "failed" ], "type": "string" }, "RequestId": { "description": "A UUIDv4 value to uniquely identify a request.", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "type": "string" }, "ReshardInformation": { "additionalProperties": false, "description": "Schema for the shard splitting cluster summary.", "properties": { "completed": { "description": "Number of complete jobs.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "failed": { "description": "Number of failed jobs.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "running": { "description": "Number of running jobs.", "format": "int64", "maximum": 48, "minimum": 0, "type": "integer" }, "state": { "description": "States of the shard splitting application. When shard splitting is running on the cluster then all the jobs that haven't been individually stopped will be running as well. When shard splitting is stopped then all the shard splitting jobs will be stopped on the cluster.", "enum": [ "running", "stopped" ], "type": "string" }, "state_reason": { "description": "State reason.", "maxLength": 7168, "minLength": 1, "nullable": true, "pattern": "^.+$", "type": "string" }, "stopped": { "description": "Number of stopped jobs.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "total": { "description": "Total number of jobs.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "completed", "failed", "running", "state", "state_reason", "stopped", "total" ], "type": "object" }, "ReshardJobInformation": { "additionalProperties": false, "description": "Schema for the state of a shard splitting job.", "properties": { "history": { "description": "The timeline of job state transitions with a timestamp and additional details (if available).", "items": { "$ref": "#/components/schemas/ReshardJobInformationItems" }, "maxItems": 20, "minItems": 0, "type": "array" }, "id": { "description": "The ID of the job.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "job_state": { "description": "This is the running state of the job.", "enum": [ "completed", "failed", "new", "running", "stopped" ], "type": "string" }, "node": { "description": "Node where this job is running.", "maxLength": 255, "minLength": 1, "pattern": "^.+$", "type": "string" }, "source": { "description": "Source shard.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "split_state": { "description": "How far along the shard splitting process has progressed.", "enum": [ "build_indices", "completed", "copy_local_docs", "initial_copy", "new", "source_delete", "topoff1", "topoff2", "topoff3", "update_shard_map", "wait_source_close" ], "type": "string" }, "start_time": { "description": "Time when job had started running last. A job might have been stopped or the node restarted to this time might not match with the creation time.", "format": "date-time", "maxLength": 26, "minLength": 1, "type": "string" }, "state_info": { "$ref": "#/components/schemas/ReshardJobInformationStateInfo" }, "target": { "description": "Target shards.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "type": { "$ref": "#/components/schemas/ReshardJobType" }, "update_time": { "description": "Time of the last update to the job state.", "format": "date-time", "maxLength": 26, "minLength": 1, "type": "string" } }, "required": [ "history", "id", "job_state", "node", "source", "split_state", "start_time", "state_info", "target", "type", "update_time" ], "type": "object" }, "ReshardJobInformationItems": { "additionalProperties": false, "properties": { "detail": { "description": "Detail.", "maxLength": 7168, "minLength": 1, "nullable": true, "pattern": "^.+$", "type": "string" }, "timestamp": { "description": "Timestamp.", "format": "date-time", "maxLength": 26, "minLength": 1, "type": "string" }, "type": { "description": "Type.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "detail", "timestamp", "type" ], "type": "object" }, "ReshardJobInformationStateInfo": { "additionalProperties": true, "description": "Additional information about the current running state. On retry it will include the last error that cause the retry to happen.", "properties": { "reason": { "description": "Failure reason.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "type": "object" }, "ReshardJobResult": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/Ok" }, { "$ref": "#/components/schemas/Error" }, { "properties": { "id": { "$ref": "#/components/schemas/DocumentId" }, "node": { "description": "Node name.", "maxLength": 255, "minLength": 1, "pattern": "^.+$", "type": "string" }, "shard": { "description": "Database shard.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "type": "object" } ], "description": "Schema for a reshard job configuration.", "required": [ "node", "shard" ] }, "ReshardJobType": { "description": "Job type. Currently the only type accepted is split.", "enum": [ "split" ], "type": "string" }, "ReshardJobsConfiguration": { "additionalProperties": false, "description": "Schema for a reshard job configuration.", "properties": { "db": { "$ref": "#/components/schemas/DatabaseName" }, "node": { "description": "Node name.", "maxLength": 255, "minLength": 1, "pattern": "^.+$", "type": "string" }, "range": { "description": "Shard range.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "shard": { "description": "Database shard.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "type": { "$ref": "#/components/schemas/ReshardJobType" } }, "required": [ "type" ], "type": "object" }, "ReshardJobsInformation": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/CommonViewResult" }, { "additionalProperties": false, "description": "Schema for a list of shard splitting jobs.", "properties": { "jobs": { "description": "All split jobs.", "items": { "$ref": "#/components/schemas/ReshardJobInformation" }, "maxItems": 48, "minItems": 0, "type": "array" }, "total_rows": { "allOf": [ { "$ref": "#/components/schemas/TotalRows" }, { "description": "Total number of shard splitting jobs." } ] } }, "required": [ "jobs" ], "type": "object" } ], "required": [ "offset", "total_rows" ] }, "ReshardJobsResult": { "description": "Schema for the result of a shard splitting jobs response.", "items": { "$ref": "#/components/schemas/ReshardJobResult" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "ReshardState": { "additionalProperties": false, "description": "Schema for the state information of a shard splitting job.", "properties": { "reason": { "description": "Reason for job state.", "maxLength": 7168, "minLength": 1, "nullable": true, "pattern": "^.+$", "type": "string" }, "state": { "description": "Job state.", "enum": [ "completed", "failed", "running", "stopped" ], "type": "string" } }, "required": [ "reason", "state" ], "type": "object" }, "Revisions": { "additionalProperties": false, "description": "Schema for list of revision information.", "properties": { "ids": { "description": "Array of valid revision IDs, in reverse order (latest first).", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^[0-9a-fA-F]{32}$", "type": "string" }, "maxItems": 4294967295, "minItems": 1, "type": "array" }, "start": { "description": "Prefix number for the latest revision.", "format": "int64", "maximum": 4294967295, "minimum": 1, "type": "integer" } }, "required": [ "ids", "start" ], "type": "object" }, "RevsDiff": { "additionalProperties": false, "description": "Schema for information about missing revs and possible ancestors.", "properties": { "missing": { "description": "List of missing revisions.", "items": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "possible_ancestors": { "description": "List of possible ancestor revisions.", "items": { "$ref": "#/components/schemas/DocumentRevisionIdentifier" }, "maxItems": 4294967295, "minItems": 0, "type": "array" } }, "type": "object" }, "RevsDiffResult": { "additionalProperties": { "$ref": "#/components/schemas/RevsDiff" }, "description": "Schema for mapping document IDs to RevsDiff information.", "type": "object" }, "RevsLimit": { "description": "Schema for the revision limit.", "format": "int64", "maximum": 4294967295, "minimum": 1, "type": "integer" }, "Role": { "description": "Schema for a security role.", "enum": [ "_reader", "_writer", "_admin", "_replicator", "_db_updates", "_design", "_shards", "_security" ], "type": "string" }, "SchedulerDocsResult": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/CommonViewResult" }, { "additionalProperties": false, "properties": { "docs": { "description": "Array of replication scheduler doc objects.", "items": { "$ref": "#/components/schemas/SchedulerDocument" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "total_rows": { "allOf": [ { "$ref": "#/components/schemas/TotalRows" }, { "description": "Total number of replication scheduler documents." } ] } }, "required": [ "docs" ], "type": "object" } ], "description": "Schema for a listing of replication scheduler documents.", "required": [ "offset", "total_rows" ] }, "SchedulerDocument": { "additionalProperties": false, "description": "Schema for a replication scheduler document.", "properties": { "database": { "allOf": [ { "$ref": "#/components/schemas/DatabaseName" }, { "description": "Database where replication document came from" } ] }, "doc_id": { "allOf": [ { "$ref": "#/components/schemas/DocumentId" }, { "description": "Replication document ID" } ] }, "error_count": { "description": "Consecutive errors count. Indicates how many times in a row this replication has crashed. Replication will be retried with an exponential backoff based on this number. As soon as the replication succeeds this count is reset to 0. To can be used to get an idea why a particular replication is not making progress.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "id": { "description": "Replication ID, or null if state is completed or failed.", "maxLength": 7168, "minLength": 1, "nullable": true, "pattern": "^.+$", "type": "string" }, "info": { "$ref": "#/components/schemas/SchedulerInfo" }, "last_updated": { "description": "Timestamp of last state update.", "format": "date-time", "maxLength": 26, "minLength": 1, "type": "string" }, "node": { "description": "Cluster node where the job is running.", "maxLength": 255, "minLength": 1, "pattern": "^.+$", "type": "string" }, "source": { "allOf": [ { "$ref": "#/components/schemas/DatabaseUrl" }, { "description": "Replication source." } ] }, "source_proxy": { "deprecated": true, "description": "Forbidden in IBM Cloudant mediated replications.\n\nAddress of the (http or socks5 protocol) proxy server through which replication with the source database occurs.", "maxLength": 7168, "minLength": 1, "nullable": true, "pattern": "^.+$", "type": "string" }, "start_time": { "description": "Timestamp of when the replication was started.", "format": "date-time", "maxLength": 26, "minLength": 1, "type": "string" }, "state": { "$ref": "#/components/schemas/ReplicationState" }, "target": { "allOf": [ { "$ref": "#/components/schemas/DatabaseUrl" }, { "description": "Replication target." } ] }, "target_proxy": { "deprecated": true, "description": "Forbidden in IBM Cloudant mediated replications.\n\nAddress of the (http or socks5 protocol) proxy server through which replication with the target database occurs.", "maxLength": 7168, "minLength": 1, "nullable": true, "pattern": "^.+$", "type": "string" } }, "required": [ "database", "doc_id", "error_count", "id", "info", "last_updated", "start_time", "state" ], "type": "object" }, "SchedulerInfo": { "additionalProperties": false, "description": "Schema for scheduler document information. A JSON object that may contain additional information about the state. For error states this will contain an error field and string value.", "nullable": true, "properties": { "changes_pending": { "description": "The count of changes not yet replicated.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "nullable": true, "type": "integer" }, "checkpointed_source_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "The source sequence id which was last successfully replicated." } ] }, "doc_write_failures": { "description": "The count of docs which failed to be written to the target.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "docs_read": { "description": "The count of docs which have been read from the source.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "docs_written": { "description": "The count of docs which have been written to the target.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "error": { "description": "Replication error message.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "missing_revisions_found": { "description": "The count of revisions which were found on the source, but missing from the target.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "revisions_checked": { "description": "The count of revisions which have been checked since this replication began.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "source_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "The last sequence number obtained from the source database changes feed." } ] }, "through_seq": { "allOf": [ { "$ref": "#/components/schemas/Sequence" }, { "description": "The last sequence number processed by the replicator." } ] } }, "type": "object" }, "SchedulerJob": { "additionalProperties": false, "description": "Schema for a replication scheduler job.", "properties": { "database": { "allOf": [ { "$ref": "#/components/schemas/DatabaseName" }, { "description": "Replication document database." } ] }, "doc_id": { "allOf": [ { "$ref": "#/components/schemas/DocumentId" }, { "description": "Replication document ID" } ] }, "history": { "description": "Timestamped history of events as a list of objects.", "items": { "$ref": "#/components/schemas/SchedulerJobEvent" }, "maxItems": 20, "minItems": 0, "type": "array" }, "id": { "$ref": "#/components/schemas/JobId" }, "info": { "$ref": "#/components/schemas/SchedulerInfo" }, "node": { "description": "Cluster node where the job is running.", "maxLength": 255, "minLength": 1, "pattern": "^.+$", "type": "string" }, "pid": { "description": "Replication process ID.", "maxLength": 34, "minLength": 1, "nullable": true, "pattern": "^.+$", "type": "string" }, "source": { "allOf": [ { "$ref": "#/components/schemas/DatabaseUrl" }, { "description": "Replication source." } ] }, "start_time": { "description": "Timestamp of when the replication was started.", "format": "date-time", "maxLength": 26, "minLength": 1, "type": "string" }, "target": { "allOf": [ { "$ref": "#/components/schemas/DatabaseUrl" }, { "description": "Replication target." } ] }, "user": { "$ref": "#/components/schemas/UsernameNullable" } }, "required": [ "database", "doc_id", "history", "id", "info", "node", "pid", "source", "start_time", "target", "user" ], "type": "object" }, "SchedulerJobEvent": { "additionalProperties": false, "description": "Schema for a replication scheduler job event.", "properties": { "reason": { "description": "Reason for current state of event.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "timestamp": { "description": "Timestamp of the event.", "format": "date-time", "maxLength": 26, "minLength": 1, "type": "string" }, "type": { "description": "Type of the event.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "timestamp", "type" ], "type": "object" }, "SchedulerJobsResult": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/CommonViewResult" }, { "additionalProperties": false, "properties": { "jobs": { "description": "Array of replication job objects.", "items": { "$ref": "#/components/schemas/SchedulerJob" }, "maxItems": 500, "minItems": 0, "type": "array" }, "total_rows": { "allOf": [ { "$ref": "#/components/schemas/TotalRows" }, { "description": "Total number of replication jobs." } ] } }, "required": [ "jobs" ], "type": "object" } ], "description": "Schema for a listing of replication scheduler jobs.", "required": [ "offset", "total_rows" ] }, "SearchAnalyzeQuery": { "additionalProperties": false, "description": "Schema for submitting sample data for testing a search analyzer.", "properties": { "analyzer": { "$ref": "#/components/schemas/SearchAnalyzer" }, "text": { "$ref": "#/components/schemas/SearchAnalyzerText" } }, "required": [ "analyzer", "text" ], "type": "object" }, "SearchAnalyzeResult": { "additionalProperties": false, "description": "Schema for the output of testing search analyzer tokenization.", "properties": { "tokens": { "description": "tokens", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 7168, "minItems": 1, "type": "array" } }, "required": [ "tokens" ] }, "SearchAnalyzer": { "description": "The analyzer type that is being used at the tokenization.", "enum": [ "arabic", "armenian", "basque", "brazilian", "bulgarian", "catalan", "chinese", "cjk", "classic", "czech", "danish", "dutch", "email", "english", "finnish", "french", "galician", "german", "greek", "hindi", "hungarian", "indonesian", "irish", "italian", "japanese", "keyword", "latvian", "norwegian", "persian", "polish", "portuguese", "romanian", "russian", "simple", "spanish", "standard", "swedish", "thai", "turkish", "whitespace" ], "type": "string" }, "SearchAnalyzerText": { "description": "The text to tokenize with the analyzer.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "SearchDiskSize": { "description": "The size of the search index on disk.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "SearchDiskSizeInformation": { "additionalProperties": false, "description": "Schema for search index disk size.", "properties": { "name": { "description": "The name of the search index prefixed by the design document ID where the index is stored.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "search_index": { "$ref": "#/components/schemas/SearchIndexDiskSize" } }, "required": [ "name", "search_index" ], "type": "object" }, "SearchIndexDefinition": { "additionalProperties": false, "description": "Schema for a search index definition.", "properties": { "analyzer": { "$ref": "#/components/schemas/AnalyzerConfiguration" }, "index": { "description": "String form of a JavaScript function that is called for each\ndocument in the database. The function takes the document as a\nparameter, extracts some data from it, and then calls the `index`\nfunction to index that data. The index function takes 2, or\noptionally 3, parameters.\n\n* The first parameter is the name of the field you intend to use\n when querying the index. If the special value `\"default\"` is used\n when you define the name, you do not have to specify a field name\n at query time.\n* The second parameter is the data to be indexed. This data must be\n only a string, number, or boolean. Other types will cause an error\n to be thrown by the index function call.\n* The optional third parameter is a JavaScript object with these\n properties:\n\n * `facet` - boolean, default `false` - Creates a faceted index.\n * `index` - boolean, default `true` - If set to `false`, the\n data cannot be used for searches, but can still be retrieved\n from the index if `store` is set to `true`.\n * `store` - boolean, default `true` -\tIf true, the value is\n returned in the search result; otherwise, the value is not\n returned.", "externalDocs": { "description": "Cloudant search index function documentation.", "url": "https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-cloudant-search#index-functions" }, "maxLength": 1048488, "minLength": 1, "pattern": "^.*$", "type": "string" } }, "required": [ "index" ], "type": "object" }, "SearchIndexDiskSize": { "description": "Schema for search index disk size.", "properties": { "disk_size": { "$ref": "#/components/schemas/SearchDiskSize" } } }, "SearchIndexInfo": { "additionalProperties": false, "description": "Schema for metadata information about a search index.", "properties": { "committed_seq": { "description": "The committed sequence identifier.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "disk_size": { "$ref": "#/components/schemas/SearchDiskSize" }, "doc_count": { "description": "The count of the number of indexed documents.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "doc_del_count": { "description": "The number of deleted documents.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "pending_seq": { "description": "The pending sequence identifier.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "signature": { "description": "Unique signature of the search index.", "maxLength": 32, "minLength": 32, "pattern": "^[\\da-f]{32}$", "type": "string" } }, "required": [ "committed_seq", "disk_size", "doc_count", "doc_del_count", "pending_seq", "signature" ], "type": "object" }, "SearchInfoResult": { "additionalProperties": false, "description": "Schema for search index information.", "properties": { "name": { "description": "The name of the search index prefixed by the design document ID where the index is stored.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "search_index": { "$ref": "#/components/schemas/SearchIndexInfo" } }, "required": [ "name", "search_index" ], "type": "object" }, "SearchQuery": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/PartitionSearchQuery" }, { "additionalProperties": false, "properties": { "counts": { "description": "This field defines an array of names of string fields, for which counts are requested. The response contains counts for each unique value of this field name among the documents that match the search query. Faceting must be enabled for this parameter to function. This option is only available when making global queries.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "drilldown": { "description": "Restrict results to documents with a dimension equal to the specified label(s). The search matches only documents containing the value that was provided in the named field. It differs from using \"fieldname:value\" in the q parameter only in that the values are not analyzed. Faceting must be enabled for this parameter to function.", "items": { "$ref": "#/components/schemas/DrilldownQuery" }, "maxItems": 65535, "minItems": 1, "type": "array" }, "group_field": { "description": "Field by which to group search matches. A string that contains the name of a string field. Fields containing other data such as numbers, objects, or arrays cannot be used. This option is only available when making global queries.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "group_limit": { "description": "Maximum group count. This field can be used only if group_field is specified. This option is only available when making global queries.", "format": "int64", "maximum": 4294967295, "minimum": 1, "type": "integer" }, "group_sort": { "description": "This field defines the order of the groups in a search that uses group_field. The default sort order is relevance. This field can have the same values as the sort field, so single fields and arrays of fields are supported. This option is only available when making global queries.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "ranges": { "$ref": "#/components/schemas/SearchRanges" } }, "type": "object" } ], "description": "Schema for a query search operation." }, "SearchRange": { "additionalProperties": { "description": "The range facet syntax reuses the standard Lucene syntax for ranges to return counts of results that fit into each specified category. Inclusive range queries are denoted by brackets (`[`, `]`). Exclusive range queries are denoted by curly brackets (`{`, `}`).", "maxLength": 7168, "minLength": 1, "pattern": "^[\\[\\{][+-]?(Infinity|([0-9]+\\.)?[0-9]+) TO [+-]?(Infinity|([0-9]+\\.)?[0-9]+)[\\]\\}]$", "type": "string" }, "description": "Schema for mapping range count category names to the Apache Lucene range query syntax defining the category.", "type": "object" }, "SearchRanges": { "additionalProperties": { "$ref": "#/components/schemas/SearchRange" }, "description": "Object mapping faceted, numeric search field names to the required ranges. Each key is a field name and each value is another object defining the ranges by mapping range name keys to string values describing the numeric ranges, for example \"[0 TO 10]\". This option is only available when making global queries.", "type": "object" }, "SearchResult": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/SearchResultProperties" }, { "additionalProperties": false, "properties": { "groups": { "description": "Array of grouped search matches.", "items": { "$ref": "#/components/schemas/SearchResultProperties" }, "maxItems": 4294967295, "minItems": 1, "type": "array" } }, "type": "object" } ], "description": "Schema for the result of a query search operation." }, "SearchResultCounts": { "additionalProperties": { "$ref": "#/components/schemas/SearchResultCountsValue" }, "description": "The counts facet syntax returns the number of query results for each unique value of each named field.", "type": "object" }, "SearchResultCountsValue": { "additionalProperties": { "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "description": "The count of query results for each unique value.", "type": "object" }, "SearchResultHighlights": { "additionalProperties": { "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "description": "Returns the context in which a search term was mentioned so that you can display more emphasized results to a user.", "type": "object" }, "SearchResultProperties": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/CommonViewResult" }, { "additionalProperties": false, "description": "Schema for the result of a query search operation.", "properties": { "bookmark": { "$ref": "#/components/schemas/Bookmark" }, "by": { "description": "Grouped search matches.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "counts": { "$ref": "#/components/schemas/SearchResultCounts" }, "ranges": { "$ref": "#/components/schemas/SearchResultRanges" }, "rows": { "description": "Array of row objects.", "items": { "$ref": "#/components/schemas/SearchResultRow" }, "maxItems": 200, "minItems": 0, "type": "array" }, "total_rows": { "allOf": [ { "$ref": "#/components/schemas/TotalRows" }, { "description": "Total number of rows in the index matching the search query. The limit may truncate the number of matches returned." } ] } }, "required": [ "rows" ], "type": "object" } ], "required": [ "total_rows" ] }, "SearchResultRanges": { "additionalProperties": { "$ref": "#/components/schemas/SearchResultRangesValue" }, "description": "The range facet syntax reuses the standard Lucene syntax for ranges to return counts of results that fit into each specified category.", "type": "object" }, "SearchResultRangesValue": { "additionalProperties": { "description": "Counts of range results that fit into each specified category.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "description": "Search range result counts.", "type": "object" }, "SearchResultRow": { "additionalProperties": false, "description": "Schema for a row of the result of a query search operation.", "properties": { "doc": { "$ref": "#/components/schemas/Document" }, "fields": { "$ref": "#/components/schemas/SearchResultRowFields" }, "highlights": { "$ref": "#/components/schemas/SearchResultHighlights" }, "id": { "$ref": "#/components/schemas/DocumentId" }, "order": { "deprecated": true, "description": "Geographical search distance.", "items": { "format": "double", "minimum": 0, "type": "number" }, "maxItems": 4294967295, "minItems": 1, "type": "array", "x-sdk-exclude": true } }, "required": [ "fields", "id", "order" ], "type": "object" }, "SearchResultRowFields": { "additionalProperties": true, "description": "Schema for the fields returned by a query search operation, a map of field name to value.", "type": "object" }, "SearchSort": { "description": "Schema for search sort array items", "maxLength": 7168, "minLength": 1, "pattern": "^-?[^<>]+(<(?:string|number)>)?$", "type": "string" }, "Security": { "additionalProperties": false, "description": "Schema for a Cloudant security document.", "properties": { "admins": { "$ref": "#/components/schemas/SecurityObject" }, "cloudant": { "$ref": "#/components/schemas/SecurityObjectCloudant" }, "couchdb_auth_only": { "description": "Manage permissions using the `_users` database only.", "type": "boolean" }, "members": { "$ref": "#/components/schemas/SecurityObject" } }, "type": "object" }, "SecurityObject": { "additionalProperties": false, "description": "Schema for names and roles to map to a database permission.", "properties": { "names": { "description": "List of usernames.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "roles": { "description": "List of roles.", "items": { "maxLength": 238, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "type": "object" }, "SecurityObjectCloudant": { "additionalProperties": { "items": { "$ref": "#/components/schemas/Role" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "description": "Database permissions for Cloudant users, API keys or both.", "type": "object" }, "Selector": { "additionalProperties": true, "description": "JSON object describing criteria used to select documents.\nThe selector specifies fields in the document, and provides\nan expression to evaluate with the field content or other data.\n\nThe selector object must:\n * Be structured as valid JSON.\n * Contain a valid query expression.\n\nUsing a selector is significantly more efficient than using a JavaScript\nfilter function, and is the recommended option if filtering on\ndocument attributes only.\n\nElementary selector syntax requires you to specify one or more fields,\nand the corresponding values required for those fields. You can create\nmore complex selector expressions by combining operators.\n\nOperators are identified by the use of a dollar sign `$` prefix in\nthe name field.\n\nThere are two core types of operators in the selector syntax:\n* Combination operators: applied at the topmost level of selection.\nThey are used to combine selectors. A combination operator takes a\nsingle argument. The argument is either another selector, or an\narray of selectors.\n* Condition operators: are specific to a field, and are used to evaluate\nthe value stored in that field. For instance, the basic `$eq` operator\nmatches when the specified field contains a value that is equal to the\nsupplied argument.\n\nIt is important for query performance to use appropriate selectors:\n* Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and\n`$lte` (but not `$ne`) can be used as the basis of a query. You should\ninclude at least one of these in a selector.\n* Some operators such as `$not`, `$or`, `$in`, and `$regex` cannot be\nanswered from an index. For query selectors use these operators in\nconjunction with equality operators or create and use a partial index to\nreduce the number of documents that will need to be scanned.\n\nSee [the Cloudant Docs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-operators)\nfor a list of all available combination and conditional operators.\n\nFor further reference see [selector syntax](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-selector-syntax)", "type": "object" }, "SelectorHint": { "additionalProperties": false, "description": "Schema for extra information on the selector.", "properties": { "indexable_fields": { "description": "A list of fields in the given selector that can be used to restrict the query.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "type": { "description": "A type of the index.", "enum": [ "json", "text" ], "type": "string" }, "unindexable_fields": { "description": "A list of fields in the given selector that can't be used to restrict the query.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 4294967295, "minItems": 0, "type": "array" } }, "required": [ "indexable_fields", "type", "unindexable_fields" ], "type": "object" }, "SelectorHints": { "description": "Schema for a list of objects with extra information on the selector to provide insights about its usability.", "items": { "$ref": "#/components/schemas/SelectorHint" }, "maxItems": 3, "minItems": 1, "type": "array" }, "Sequence": { "description": "Schema for sequence.", "maxLength": 7168, "minLength": 1, "pattern": "^([1-9]\\d*-[A-Za-z0-9-_]+)$", "type": "string" }, "ServerInformation": { "additionalProperties": false, "description": "Schema for information about the server instance.", "properties": { "couchdb": { "description": "Welcome message.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string", "x-terraform-exclude": true }, "features": { "description": "List of enabled optional features.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "features_flags": { "description": "List of feature flags.", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 4294967295, "minItems": 1, "type": "array" }, "vendor": { "$ref": "#/components/schemas/ServerVendor" }, "version": { "description": "Apache CouchDB version.", "maxLength": 7168, "minLength": 5, "pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-([0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?(?:\\+[0-9A-Za-z-]+)?$", "type": "string", "x-terraform-exclude": true } }, "required": [ "couchdb", "features", "vendor", "version", "features_flags" ], "type": "object", "x-terraform-datasource-name": "cloudant_server_information" }, "ServerVendor": { "additionalProperties": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "description": "Schema for server vendor information.", "properties": { "name": { "description": "Vendor name.", "maxLength": 12, "minLength": 12, "pattern": "^IBM Cloudant$", "type": "string", "x-terraform-exclude": true }, "variant": { "description": "Vendor variant", "enum": [ "paas" ], "type": "string", "x-terraform-exclude": true }, "version": { "description": "Vendor version.", "maxLength": 9, "minLength": 1, "pattern": "^\\d+$", "type": "string" } }, "required": [ "name", "variant", "version" ], "type": "object" }, "SessionAuthentication": { "additionalProperties": false, "description": "Schema for session authentication information.", "properties": { "authenticated": { "description": "authenticated", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "authentication_db": { "description": "authentication_db", "maxLength": 238, "minLength": 1, "pattern": "^_users$|^[a-z][a-z0-9_$()+/-]*$", "type": "string" }, "authentication_handlers": { "description": "authentication_handlers", "items": { "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 4294967295, "minItems": 1, "type": "array" } }, "required": [ "authentication_handlers" ], "type": "object" }, "SessionConfiguration": { "additionalProperties": false, "description": "Schema for configuring a session.", "properties": { "password": { "description": "The password associated with the username.", "maxLength": 7168, "minLength": 16, "pattern": "^(?:(?=.*\\d)(?=.*[a-z])(?=.*[A-Z]).*){8,}$", "type": "string" }, "username": { "$ref": "#/components/schemas/SessionConfigurationUsername" } }, "required": [ "username", "password" ], "type": "object" }, "SessionConfigurationUsername": { "allOf": [ { "$ref": "#/components/schemas/Username" } ], "x-alias": "name" }, "SessionInformation": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/Ok" }, { "additionalProperties": false, "properties": { "info": { "$ref": "#/components/schemas/SessionAuthentication" }, "userCtx": { "$ref": "#/components/schemas/UserContext" } }, "type": "object" } ], "description": "Schema for information about a session.", "required": [ "ok", "info", "userCtx" ] }, "SessionResult": { "additionalProperties": false, "description": "Schema for the result of requesting a session.", "properties": { "name": { "description": "name", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "ok": { "default": true, "description": "ok", "type": "boolean" }, "roles": { "description": "roles", "items": { "$ref": "#/components/schemas/Role" }, "maxItems": 4294967295, "minItems": 0, "type": "array" } }, "required": [ "name", "ok", "roles" ], "type": "object" }, "ShardCount": { "default": 16, "description": "Schema for the number of shards in a database. Each shard is a partition of the hash value range.", "format": "int64", "maximum": 120, "minimum": 1, "type": "integer" }, "ShardRange": { "additionalProperties": { "description": "List of node names.", "items": { "maxLength": 255, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 3, "minItems": 1, "type": "array" }, "description": "Mapping of shard hash value range to a list of nodes.", "type": "object" }, "ShardsInformation": { "additionalProperties": false, "description": "Schema for a shards object that maps the hash value range for each shard to the array of nodes that contain a copy of that shard.", "properties": { "shards": { "$ref": "#/components/schemas/ShardRange" } }, "required": [ "shards" ], "type": "object" }, "Since": { "description": "Schema for 'since' parameter.", "maxLength": 7168, "minLength": 1, "pattern": "^0|([1-9]\\d*-[A-Za-z0-9-_]+)|now$", "type": "string" }, "SortDirection": { "default": "asc", "description": "Schema for sort direction.", "enum": [ "asc", "desc" ], "type": "string" }, "ThroughputBlocks": { "description": "A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global queries/sec of provisioned throughput capacity. Not available for some plans.", "format": "int64", "maximum": 100, "minimum": 1, "type": "integer" }, "ThroughputInformation": { "additionalProperties": false, "description": "Schema for detailed information about throughput capacity with breakdown by specific throughput requests classes.", "properties": { "blocks": { "$ref": "#/components/schemas/ThroughputBlocks" }, "query": { "description": "Provisioned global queries capacity in operations per second", "format": "int64", "maximum": 2500, "minimum": 0, "type": "integer" }, "read": { "description": "Provisioned reads capacity in operations per second", "format": "int64", "maximum": 50000, "minimum": 0, "type": "integer" }, "write": { "description": "Provisioned writes capacity in operations per second", "format": "int64", "maximum": 25000, "minimum": 0, "type": "integer" } }, "required": [ "read", "write", "query" ], "type": "object" }, "Timestamp": { "description": "Schema for a Unix epoch timestamp.", "format": "int64", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "TotalRows": { "description": "Number of total rows.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "UpInformation": { "additionalProperties": false, "description": "Schema for information about the up state of the server.", "properties": { "cluster": { "description": "cluster", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "seeds": { "description": "seeds", "type": "object" }, "status": { "description": "status", "enum": [ "maintenance_mode", "nolb", "ok" ], "type": "string" } }, "required": [ "status" ], "type": "object" }, "UpdatesPending": { "additionalProperties": false, "description": "Schema for an ability to tell if view is up-to-date without querying it.", "properties": { "minimum": { "description": "Sum of shard copies with the least amount of work to do.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "preferred": { "description": "Sum of unique shards. This value is zero when at least one copy of every shard range is up-to-date and the view is able to answer a query without index building delays.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "total": { "description": "Sum of all shard copies.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "minimum", "preferred", "total" ], "type": "object" }, "UsageDataVolume": { "additionalProperties": false, "description": "Schema for UsageDataVolume.", "properties": { "data_vol": { "additionalProperties": { "$ref": "#/components/schemas/UsageDataVolumeDataPoint" }, "description": "An object representing data points for an average amount of data stored over the granularity period.", "type": "object" }, "end": { "description": "The timestamp of an endpoint for the usage report.", "format": "date-time", "maxLength": 26, "minLength": 1, "type": "string" }, "granularity": { "default": "12h", "description": "The granularity is the period for each record in the 'data_vol' object. By default it is 12h, but the user may add a query string option with a different granularity between 1 and 24 which evenly divides 24.", "maxLength": 3, "minLength": 2, "pattern": "^([123468]|12|24)h$", "type": "string" }, "start": { "description": "The timestamp of a start point for the usage report.", "format": "date-time", "maxLength": 26, "minLength": 1, "type": "string" } }, "type": "object" }, "UsageDataVolumeDataPoint": { "additionalProperties": false, "description": "Schema for UsageDataVolumeDataPoint.", "properties": { "dbs": { "description": "The average amount of data in bytes stored over the granularity period for requests of 'dbs' type.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "search": { "description": "The average amount of data in bytes stored over the granularity period for requests of 'search' type.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "views": { "description": "The average amount of data in bytes stored over the granularity period for requests of 'views' type.", "format": "int64", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "type": "object" }, "UserContext": { "additionalProperties": false, "description": "Schema for the user context of a session.", "properties": { "db": { "allOf": [ { "$ref": "#/components/schemas/DatabaseName" }, { "description": "Database name in the context of the provided operation." } ] }, "name": { "$ref": "#/components/schemas/UsernameNullable" }, "roles": { "description": "List of user roles.", "items": { "$ref": "#/components/schemas/Role" }, "maxItems": 4294967295, "minItems": 0, "type": "array" } }, "required": [ "name", "roles" ], "type": "object" }, "UserInformation": { "additionalProperties": true, "description": "Schema for UserInformation.", "type": "object" }, "UserPlan": { "additionalProperties": false, "description": "Schema for UserPlan.", "properties": { "data_charging_model": { "description": "The data charging model for the authenticated user.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "data_quota": { "description": "The data quota for the authenticated user.", "maxLength": 7168, "minLength": 3, "pattern": "^[1-9][0-9]*(K|M|G)B$", "type": "string" }, "history": { "description": "The history of plan changes for the authenticated user.", "items": { "description": "The data point for the history of plan changes for the authenticated user.", "items": { "description": "The date of the change or plan name for the data point.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" }, "maxItems": 4294967295, "minItems": 0, "type": "array" }, "name": { "description": "The plan for the authenticated user.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "plan": { "description": "The plan for the authenticated user.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "throughput": { "$ref": "#/components/schemas/CcmDiagnosticsThroughputInformation" } }, "required": [ "history" ], "type": "object" }, "UserPlanConfiguration": { "additionalProperties": false, "description": "Schema for UserPlanConfiguration.", "properties": { "plan": { "description": "The name of the new plan for the account.", "maxLength": 7168, "minLength": 1, "pattern": "^.+$", "type": "string" }, "plan_multiple": { "description": "The optional plan multiplier.", "format": "int64", "maximum": 100, "minimum": 1, "type": "integer" } }, "required": [ "plan" ], "type": "object" }, "Username": { "description": "Schema for a username.", "maxLength": 63, "minLength": 1, "pattern": "^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])$", "type": "string" }, "UsernameNullable": { "allOf": [ { "$ref": "#/components/schemas/Username" }, { "description": "Name of user running the process." }, { "nullable": true } ] }, "UuidsResult": { "additionalProperties": false, "description": "Schema for a set of uuids generated by the server.", "properties": { "uuids": { "description": "uuids", "items": { "maxLength": 32, "minLength": 32, "pattern": "^[\\da-f]{32}$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" } }, "required": [ "uuids" ], "type": "object" }, "ViewQueriesQuery": { "additionalProperties": false, "description": "Schema for a queries view operation.", "properties": { "queries": { "description": "An array of query objects with fields for the parameters of each individual view query to be executed. The field names and their meaning are the same as the query parameters of a regular view request.", "items": { "$ref": "#/components/schemas/ViewQuery" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "required": [ "queries" ], "type": "object" }, "ViewQueriesResult": { "additionalProperties": false, "description": "Schema for the results of a queries view operation.", "properties": { "results": { "description": "An array of result objects - one for each query. Each result object contains the same fields as the response to a regular view request.", "items": { "$ref": "#/components/schemas/ViewResult" }, "maxItems": 65535, "minItems": 0, "type": "array" } }, "required": [ "results" ], "type": "object" }, "ViewQuery": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/CommonViewQuery" }, { "additionalProperties": false, "description": "Schema for a query view operation.", "properties": { "end_key": { "$ref": "#/components/schemas/AnyJsonType" }, "end_key_doc_id": { "allOf": [ { "$ref": "#/components/schemas/DocumentId" }, { "description": "Stop returning rows at the specified document ID. No effect if using `group` or not providing end key." } ] }, "group": { "default": false, "description": "Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the number of array elements with the `group_level` parameter.", "type": "boolean" }, "group_level": { "description": "Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. Implies group is `true`. Group level groups the reduced results by the specified number of array elements. If unset, results are grouped by the entire array key, returning a reduced value for each complete key.", "format": "int64", "maximum": 4294967295, "minimum": 1, "type": "integer" }, "key": { "allOf": [ { "$ref": "#/components/schemas/AnyJsonType" }, { "description": "Parameter to specify to return only rows that match the specified key. String representation of any JSON type that matches the key type emitted by the view function." } ] }, "keys": { "description": "Parameter to specify returning only rows that match any of the specified keys. A JSON array of keys that match the key type emitted by the view function.", "items": { "$ref": "#/components/schemas/AnyJsonType" }, "maxItems": 65535, "minItems": 0, "type": "array" }, "reduce": { "default": true, "description": "Parameter to specify whether to use the reduce function in\na map-reduce view. Default is true when a reduce function is\ndefined.\n\nA default `reduce` view type can be disabled to behave like a\n`map` by setting `reduce=false` explicitly.\n\nBe aware that `include_docs=true` is only for `map` views.\nReduced views do not include document IDs in view rows.", "type": "boolean" }, "stable": { "default": false, "description": "Query parameter to specify whether use the same replica of\nthe index on each request. The default value `false` contacts\nall replicas and returns the result from the first, fastest,\nresponder. Setting it to `true` when used in conjunction with\n`update=false` may improve consistency at the expense of\nincreased latency and decreased throughput if the selected\nreplica is not the fastest of the available replicas.\n\n**Note:** In general setting `true` is discouraged and is\nstrictly not recommended when using `update=true`.", "type": "boolean" }, "start_key": { "$ref": "#/components/schemas/AnyJsonType" }, "start_key_doc_id": { "allOf": [ { "$ref": "#/components/schemas/DocumentId" }, { "description": "Start returning rows at the specified document ID. No effect if using `group` or not providing start key." } ] }, "update": { "default": "true", "description": "Parameter to specify whether or not the view in question\nshould be updated prior to responding to the user.\n\n* `true` - Return results after the view is updated.\n* `false` - Return results without updating the view.\n* `lazy` - Return the view results without waiting for an\nupdate, but update them immediately after the request.", "enum": [ "true", "false", "lazy" ], "type": "string" } }, "type": "object", "x-alias": { "end_key": "endkey", "end_key_doc_id": "endkey_docid", "start_key": "startkey", "start_key_doc_id": "startkey_docid" } } ], "description": "Schema for a query view operation.", "type": "object" }, "ViewResult": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/CommonViewResult" }, { "$ref": "#/components/schemas/CommonViewResultUpdateSeq" }, { "additionalProperties": false, "properties": { "rows": { "description": "rows", "items": { "$ref": "#/components/schemas/ViewResultRow" }, "maxItems": 4294967295, "minItems": 0, "type": "array" } }, "required": [ "rows" ], "type": "object" } ], "description": "Schema for the result of a query view operation." }, "ViewResultRow": { "additionalProperties": false, "allOf": [ { "$ref": "#/components/schemas/Error" }, { "additionalProperties": false, "description": "Schema for a row of a view result.", "properties": { "doc": { "$ref": "#/components/schemas/Document" }, "id": { "$ref": "#/components/schemas/DocumentId" }, "key": { "$ref": "#/components/schemas/AnyJsonType" }, "value": { "$ref": "#/components/schemas/AnyJsonType" } }, "type": "object" } ], "description": "Schema for a row of a view result.", "required": [ "key", "value" ] } }, "securitySchemes": { "Basic": { "description": "Valid only for IBM Cloudant legacy authentication (including legacy IBM Cloudant API keys).\n\nAuthenticates with a `Authorization: Basic {credentials}` header where credentials is the Base64 encoding of your `username` and `password` joined by a single colon `:`. ", "scheme": "basic", "type": "http" }, "Cookie": { "description": "Valid only for IBM Cloudant legacy authentication\n(including legacy IBM Cloudant API keys).\n\nCreate a login session cookie via the `POST /_session` endpoint and\nreceive it in the standard `Set-Cookie` header. Store this `AuthSession` cookie\nand return it to the server in the `Cookie` header on later requests.\nThis process is automatic in IBM Cloudant's\nSDKs and other cookie aware HTTP clients like browsers.", "in": "cookie", "name": "AuthSession", "type": "apiKey" }, "IAM": { "bearerFormat": "JWT", "description": "Valid only for Cloud Identity and Access Management authentication.\n\nAuthenticates with a `Authorization: Bearer {access_token}` header\nwhere `access_token` is calculated from an appropriate IAM\nconfiguration (for example from\n[an IAM API key](/docs/account?topic=account-iamtoken_from_apikey),\nor IAM profile ID). This process is handled automatically by\nIBM Cloudant's SDKs.", "scheme": "bearer", "type": "http" } } }, "externalDocs": { "description": "IBM Cloudant documentation", "url": "https://cloud.ibm.com/docs/Cloudant" }, "info": { "contact": { "email": "cldtsdks@us.ibm.com", "name": "IBM", "url": "https://www.ibm.com/products/cloudant" }, "description": "## Introduction\n\nIBM® Cloudant® for IBM Cloud® is a document-oriented\ndatabase as a service (DBaaS). It stores data as documents in JSON\nformat. It is built with scalability, high availability, and\ndurability in mind. It comes with a wide variety of indexing options\nthat include MapReduce, IBM Cloudant\nQuery, and full-text indexing. The replication\ncapabilities make it easy to keep data in sync between database\nclusters, desktop PCs, and mobile devices.\n\nDetailed documentation is also available such as a\n[Getting started tutorial][gs], [API overview documentation, tutorials, and guides][about].\n\nIf you intend to store sensitive information in an IBM® Cloudant® for IBM Cloud® database you **must** use client-side encryption to render data unreadable to Cloudant operators. For example for PCI DSS compliance you **must** encrypt the Primary Account Number (PAN) before sending a document containing it to the database.\n\nThis documentation describes the SDKs and examples. To see usage information and examples in your preferred SDK, select the language tab in the right pane.\n\nThis documentation describes the Java SDK and examples. To see usage information and examples in your preferred SDK, select the language tab in the right pane.\n\nThis documentation describes the Node SDK and examples. To see usage information and examples in your preferred SDK, select the language tab in the right pane.\n\nThis documentation describes the Python SDK and examples. To see usage information and examples in your preferred SDK, select the language tab in the right pane.\n\nThis documentation describes the Go SDK and examples. To see usage information and examples in your preferred SDK, select the language tab in the right pane.\n\nThe code examples on this tab use the IBM Cloudant SDK for Java&trade.\n\nGradle\n\n```groovy\nimplementation 'com.ibm.cloud:cloudant:0.+'\n```\n\nMaven\n\n[Maven installation instructions](https://github.com/IBM/cloudant-java-sdk/#maven)\n\nGitHub\n\n\n\nThe code examples on this tab use the IBM Cloudant SDK for Node.js.\n\nInstallation\n\n```bash\nnpm install --save @ibm-cloud/cloudant\n```\n\nGitHub\n\n\n\nThe code examples on this tab use the IBM Cloudant SDK for Python.\n\nInstallation\n\n```bash\npip3 install ibmcloudant\n```\n\nGitHub\n\n\n\nThe code examples on this tab use the IBM Cloudant SDK for Go.\n\nInstallation\n\n```bash\ngo get -u github.com/IBM/cloudant-go-sdk/cloudantv1\n```\n\nGitHub\n\n\n\n## Endpoint URLs\n\nThe IBM Cloudant API uses an instance-specific endpoint URL for all regions. You can find your external endpoint by following these steps:\n\n1.\tGo to the IBM Cloud dashboard and open an instance.\n2.\tClick the Service credentials tab.\n3.\tClick the chevron next to the service credentials to open the credentials pane.\n4.\tCopy the value from the `host` field and prefix it with the `https://` protocol.\n This value is the external endpoint.\n\nFor more information, see the [Locating your service credentials][servicecreds] tutorial.\n\nOr you can copy your external endpoint by following these steps:\n\n1.\tGo to the IBM Cloud dashboard and open an instance.\n2.\tUnder the Manage tab on the Overview page, see the External endpoint in the table.\n3.\tClick **Copy** to copy the External endpoint.\n Paste the endpoint where you need your credentials.\n\nA public endpoint looks something like these examples:\n\n`https://5lll032-dd12-536e-09b3-432fg9f07e78-bluemix.cloudantnosqldb.appdomain.cloud`\n\nor\n\n`https://5lll032-dd12-536e-09b3-432fg9f07e78-bluemix.cloudant.com`\n\nA private endpoint is one that is only accessible through a non-public network, like IBM's internal network. Private endpoints are available to customers who have the Dedicated Hardware plan.\n\n[servicecreds]: /docs/Cloudant?topic=Cloudant-locating-your-service-credentials\n\n## Authentication\n\nYou can access IBM Cloudant with IBM Cloud® Identity and Access Management (IAM) or IBM Cloudant legacy access controls.\nThe choice between _Use only IAM_ and _Use both legacy credentials and IAM access control_ affects how credentials are delivered to your application when you bind and generate service credentials.\n\nThe _Use only IAM_ option is preferred. Review [Must I use _Use only IAM_ or _Use both legacy credentials and IAM_?](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-managing-access-for-cloudant#must-i-use-use-only-iam-or-use-both-legacy-credentials-and-iam-ai) to help with making a decision.\n\n**IAM authentication**\n\nAccess to IBM Cloudant is centrally controlled by\nIBM Cloud® Identity and Access Management (IAM), which provides\na unified approach to managing user identities, and access control across your\nIBM Cloud® services and applications using the same set of credentials.\n\nTo work with the API, authenticate your application or service by including your\nIBM Cloud® [IAM access token][iamtoken] in API requests.\n\n**Cloudant legacy authentication**\n\nLegacy access controls are unique to IBM Cloudant, which means that accessing each service instance requires its own set of credentials. These credentials can be used with HTTP basic and cookie authentication. IBM Cloudant _legacy_ API keys authenticate identically to username and password credentials but are generated and assigned differently. For more information, see [the documentation about IBM Cloudant legacy API keys](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-work-with-your-account#api-keys).\n\n**Additional authentication resources**\n\n- IBM Cloudant [client libraries][cl]\nprovide full integration with IAM's access controls and automatically\nretrieve an IAM access token when an appropriate IAM configuration is provided (for example, an IAM API key or IAM profile ID).\n- View IBM Cloudant [authentication documentation][1].\n\n### Authentication with external configuration\n\nIn this scenario, the configuration is defined with an external credentials file and an authenticator that is constructed by SDK's authenticator factory during client initialization. Using the external credentials file avoids hardcoded credentials within the application code.\n\nThe default name of the credentials file is `ibm-credentials.env`. It is expected to be located in either the current directory or in the user's home directory. The path and name of the file can be controlled by using the `IBM_CREDENTIALS_FILE` environment variable.\n\nCloudant configuration properties start with a chosen\nservice name prefix that identifies your service.\nBy default it is `CLOUDANT`.\n\nIf you would like to rename your Cloudant service from `CLOUDANT`, or\nuse multiple services at the same time you must use your defined\nservice name as the prefix for all of your Cloudant related configuration properties.\nYou also must use the same service name at instantiating your service.\n\nThis way, each configuration property includes both the name of the service and the specific attribute, combined in a format like `CLOUDANT_APIKEY`.\n\nIt is not necessary to use a .env file. These properties can be set by using environment variables with the same name in the environment where the application is run.\n\n#### Variable guide for the authentication code samples\n\n| Attribute name | Description |\n|----------|-------------|\n| `{apikey}` | IAM API key |\n| `{username}` | Cloudant username |\n| `{password}` | Cloudant password |\n| `{url}` | URL of Cloudant instance |\n| `{service-name}` | Chosen service name of your Cloudant instance. \\n Same as the prefix of your configuration properties. \\n Default value is `CLOUDANT`. |\n\nSDK managing the IAM token. Replace {apikey} and {url}.\n\n```generic\n{service-name}_URL={url}\n{service-name}_APIKEY={apikey}\n```\n\n```java\nimport com.ibm.cloud.cloudant.v1.Cloudant;\n\nCloudant service = Cloudant.newInstance(\"{service-name}\");\n```\n\n```javascript\nimport { CloudantV1 } from '@ibm-cloud/cloudant';\n\nconst service = CloudantV1.newInstance({\n serviceName: '{service-name}'\n});\n```\n\n```python\nfrom ibmcloudant.cloudant_v1 import CloudantV1\n\nservice = CloudantV1.new_instance(service_name=\"{service-name}\")\n```\n\n```go\nimport (\n \"github.com/IBM/cloudant-go-sdk/cloudantv1\"\n)\n\nservice, err := cloudantv1.NewCloudantV1UsingExternalConfig(\n &cloudantv1.CloudantV1Options{\n ServiceName: \"{service-name}\",\n },\n)\n```\n\nSDK managing session cookie.\n\n```generic\n{service-name}_AUTH_TYPE=COUCHDB_SESSION\n{service-name}_URL={url}\n{service-name}_USERNAME={username}\n{service-name}_PASSWORD={password}\n```\n\n```java\nimport com.ibm.cloud.cloudant.v1.Cloudant;\n\nCloudant service = Cloudant.newInstance(\"{service-name}\");\n```\n\n```javascript\nimport { CloudantV1 } from '@ibm-cloud/cloudant';\n\nconst service = CloudantV1.newInstance({\n serviceName: '{service-name}'\n});\n```\n\n```python\nfrom ibmcloudant.cloudant_v1 import CloudantV1\n\nservice = CloudantV1.new_instance(service_name=\"{service-name}\")\n```\n\n```go\nimport (\n \"github.com/IBM/cloudant-go-sdk/cloudantv1\"\n)\n\nservice, err := cloudantv1.NewCloudantV1UsingExternalConfig(\n &cloudantv1.CloudantV1Options{\n ServiceName: \"{service-name}\",\n },\n)\n```\n\nBasic authentication.\n\n```generic\n{service-name}_AUTH_TYPE=BASIC\n{service-name}_URL={url}\n{service-name}_USERNAME={username}\n{service-name}_PASSWORD={password}\n```\n\n```java\nimport com.ibm.cloud.cloudant.v1.Cloudant;\n\nCloudant service = Cloudant.newInstance(\"{service-name}\");\n```\n\n```javascript\nimport { CloudantV1 } from '@ibm-cloud/cloudant';\n\nconst service = CloudantV1.newInstance({\n serviceName: '{service-name}'\n});\n```\n\n```python\nfrom ibmcloudant.cloudant_v1 import CloudantV1\n\nservice = CloudantV1.new_instance(service_name=\"{service-name}\")\n```\n\n```go\nimport (\n \"github.com/IBM/cloudant-go-sdk/cloudantv1\"\n)\n\nservice, err := cloudantv1.NewCloudantV1UsingExternalConfig(\n &cloudantv1.CloudantV1Options{\n ServiceName: \"{service-name}\",\n },\n)\n```\n\n### Programmatic authentication\n\nIn this scenario, authentication is configured by constructing an authenticator instance, supplying the configuration attributes programmatically, and then passing this instance to a client constructor.\n\nSDK managing the IAM token.\n\n```java\nimport com.ibm.cloud.cloudant.v1.Cloudant;\nimport com.ibm.cloud.sdk.core.security.IamAuthenticator;\n\nIamAuthenticator authenticator = new IamAuthenticator.Builder()\n .apikey(\"{apikey}\")\n .build();\n\nCloudant service = new Cloudant(Cloudant.DEFAULT_SERVICE_NAME, authenticator);\n\nservice.setServiceUrl(\"{url}\");\n```\n\n```javascript\nimport { CloudantV1 } from '@ibm-cloud/cloudant';\nimport { IamAuthenticator } from 'ibm-cloud-sdk-core';\n\nconst authenticator = new IamAuthenticator({\n apikey: '{apikey}'\n});\n\nconst service = new CloudantV1({\n authenticator: authenticator\n});\n\nservice.setServiceUrl('{url}');\n```\n\n```python\nfrom ibmcloudant.cloudant_v1 import CloudantV1\nfrom ibm_cloud_sdk_core.authenticators import IAMAuthenticator\n\nauthenticator = IAMAuthenticator('{apikey}')\n\nservice = CloudantV1(authenticator=authenticator)\n\nservice.set_service_url('{url}')\n```\n\n```go\nimport (\n \"github.com/IBM/cloudant-go-sdk/cloudantv1\"\n \"github.com/IBM/go-sdk-core/core\"\n)\n\nauthenticator := &core.IamAuthenticator{\n ApiKey: \"{apikey}\",\n}\n\nservice, err := cloudantv1.NewCloudantV1(\n &cloudantv1.CloudantV1Options{\n URL: \"{url}\",\n Authenticator: authenticator,\n },\n)\nif err != nil {\n panic(err)\n}\n```\n\nSDK managing session cookie.\n\n```java\nimport com.ibm.cloud.cloudant.v1.Cloudant;\nimport com.ibm.cloud.sdk.core.security.Authenticator;\nimport com.ibm.cloud.cloudant.security.CouchDbSessionAuthenticator;\n\nAuthenticator authenticator = CouchDbSessionAuthenticator.newAuthenticator(\"{username}\", \"{password}\");\n\nCloudant service = new Cloudant(Cloudant.DEFAULT_SERVICE_NAME, authenticator);\n\nservice.setServiceUrl(\"{url}\");\n```\n\n```javascript\nimport { CloudantV1, CouchdbSessionAuthenticator } from '@ibm-cloud/cloudant';\n\nconst authenticator = new CouchdbSessionAuthenticator({\n username: '{username}',\n password: '{password}'\n});\n\nconst service = new CloudantV1({\n authenticator: authenticator\n});\n\nservice.setServiceUrl('{url}');\n```\n\n```python\nfrom ibmcloudant.cloudant_v1 import CloudantV1\nfrom ibmcloudant import CouchDbSessionAuthenticator\n\nauthenticator = CouchDbSessionAuthenticator('{username}', '{password}')\n\nservice = CloudantV1(authenticator=authenticator)\n\nservice.set_service_url('{url}')\n```\n\n```go\nimport (\n \"github.com/IBM/cloudant-go-sdk/cloudantv1\"\n \"github.com/IBM/cloudant-go-sdk/auth\"\n)\n\nauthenticator, err := auth.NewCouchDbSessionAuthenticator(\n \"{username}\",\n \"{password}\",\n)\nif err != nil {\n panic(err)\n}\n\nservice, err := cloudantv1.NewCloudantV1(\n &cloudantv1.CloudantV1Options{\n URL: \"{url}\",\n Authenticator: authenticator,\n },\n)\nif err != nil {\n panic(err)\n}\n```\n\nBasic authentication.\n\n```java\nimport com.ibm.cloud.cloudant.v1.Cloudant;\nimport com.ibm.cloud.sdk.core.security.BasicAuthenticator;\n\nBasicAuthenticator authenticator = new BasicAuthenticator.Builder()\n .username(\"{username}\")\n .password(\"{password}\")\n .build();\n\nCloudant service = new Cloudant(Cloudant.DEFAULT_SERVICE_NAME, authenticator);\n\nservice.setServiceUrl(\"{url}\");\n```\n\n```javascript\nimport { CloudantV1 } from '@ibm-cloud/cloudant';\nimport { BasicAuthenticator } from 'ibm-cloud-sdk-core';\n\nconst authenticator = new BasicAuthenticator({\n username: '{username}',\n password: '{password}'\n});\n\nconst service = new CloudantV1({\n authenticator: authenticator\n});\n\nservice.setServiceUrl('{url}');\n```\n\n```python\nfrom ibmcloudant.cloudant_v1 import CloudantV1\nfrom ibm_cloud_sdk_core.authenticators import BasicAuthenticator\n\nauthenticator = BasicAuthenticator('{username}', '{password}')\n\nservice = CloudantV1(authenticator=authenticator)\n\nservice.set_service_url('{url}')\n```\n\n```go\nimport (\n \"github.com/IBM/cloudant-go-sdk/cloudantv1\"\n \"github.com/IBM/go-sdk-core/core\"\n)\n\nauthenticator, err := core.NewBasicAuthenticator(\n \"{username}\",\n \"{password}\",\n)\nif err != nil {\n panic(err)\n}\n\nservice, err := cloudantv1.NewCloudantV1(\n &cloudantv1.CloudantV1Options{\n URL: \"{url}\",\n Authenticator: authenticator,\n },\n)\nif err != nil {\n panic(err)\n}\n```\n\n[about]: /docs/Cloudant\n[gs]: /docs/Cloudant?topic=Cloudant-getting-started-with-cloudant#getting-started-with-cloudant\n[1]: /docs/Cloudant?topic=Cloudant-work-with-your-account\n[cl]: /docs/Cloudant?topic=Cloudant-client-libraries#client-libraries\n[iamtoken]: /docs/account?topic=account-iamtoken_from_apikey\n\n## Error handling\n\nIBM Cloudant operation uses\nstandard HTTP response codes to indicate the status of the operation.\nHTTP response codes in the `2xx` range indicate success.\nA `4xx` range indicates a failure, and a `5xx` range usually indicates\nan internal system error. More detailed error information is available\nin the body of the response.\n\nFor some HTTP requests, for example bulk operations, a `2xx` response may\nindicate overall request success, but individual actions may have failed.\nFor these cases the HTTP status code is insufficient to indicate success\nor failure and the caller must inspect the response body contents.\n\n| HTTP Code | Meaning |\n|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `200 - OK` | Request completed successfully. |\n| `201 - Created` | Resource created or updated successfully. The resource could be a database or a document, for example. |\n| `202 - Accepted` | Request accepted, but failed to meet the [quorum](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-documents#quorum-writing-and-reading-data) for the operation. |\n| `206 - Partial Content` | Request was successful and the body contains the ranges of data, as described in the `Range` header of the request. |\n| `304 - Not Modified` | The requested content has not changed. The [ETag](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-how-http-works-with-cloudant#etag) system that identifies the version of information returned uses this code. |\n| `400 - Bad Request` | Bad request structure. The error can indicate an error with the request URL, path, or headers. Differences in the supplied MD5 hash and content also trigger this error, as this error might indicate message corruption. |\n| `401 - Unauthorized` | The item requested was not available with the supplied authorization, or authorization was not supplied. |\n| `402 - Payment required` | Either the account is in arrears or the amount of data exceeds the plan quota. You can delete data, upgrade plan, or bring the account up to date. |\n| `403 - Forbidden` | The server forbids access to the requested item or operation. |\n| `404 - Not Found` | The requested resource does not exist or is not visible. The content includes further information as a JSON object, if available. The structure contains two keys, `error` and `reason`, similar to the following example: `{ \"error\":\"not_found\", \"reason\":\"no_db_file\" }` |\n| `405 - Resource Not Allowed` | A request was made by using an invalid HTTP request type for the URL requested. For example, you requested a `PUT` when a `POST` is expected. Errors of this type can also be triggered by invalid URL strings. |\n| `406 - Not Acceptable` | The requested response content type is not supported by the server. |\n| `408 - Request Timeout` | Timeout during reading client request. |\n| `410 - Gone` | The requested resource is no longer available. |\n| `409 - Conflict` | Request resulted in an update conflict. The two most common causes are firstly, trying to update or delete a document without providing a revision and secondly, that the latest revision of the document on the server changed between a fetch and an update. |\n| `412 - Precondition Failed` | The request headers from the client and the capabilities of the server do not match. Alternatively, a request to create a database was denied because the database exists. |\n| `413 - Request Entity Too Large` | The request size exceeded the [limit](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-limits#request-payload-overview) for the IBM Cloudant API. |\n| `415 - Bad Content Type` | The content type of the request is not supported by the server. |\n| `416 - Requested Range Not Satisfiable` | The server cannot satisfy the range specified in the request header. |\n| `429 - Too Many Requests` | The user sent too many requests in a specific amount of time. More information is available in the corresponding [RFC 6585](https://datatracker.ietf.org/doc/html/rfc6585#section-4). |\n| `500 - Internal Server Error` | The server could not complete the request. It could be due to an internal error or sometimes invalid data in the request. |\n| `502 - Bad Gateway` | The server while acting as a gateway or proxy, received an invalid response from the upstream server. |\n| `503 - Service Unavailable` | The service is not available for the request. Seeing this response might indicate a misspelled IBM Cloudant account name. |\n| `504 - Gateway Timeout` | Timeout when the server is acting as a gateway and cannot get a response in time. |\n| `507 - Insufficient Storage` | There is insufficient storage space to complete the request. |\n\nIBM Cloudant HTTP API requests may also fail due to external factors,\nfor example, network errors. These kinds of errors may prevent the server receiving the request or\nthe client receiving the HTTP response. As a result the error format is different in these cases.\n\n### Error response\n\n| Name | Description |\n|------------------------------|---------------------------------------------------------------------------------------|\n| error `string` | the error message returned in the response |\n| reason `string` | a more detailed description about the cause of the failure |\n| caused_by (optional) `string`| the cause of the error |\n\n| Name | Description |\n|------------------------------|-----------------------------------------------------------------|\n| code `integer` | HTTP error code |\n| error `string` | a more detailed description about the cause of the failure code |\n\n| Name | Description |\n|------------------------------|-----------------------------------------------------|\n| message `string` | detailed description about the cause of the failure |\n\nThe [HTTP response headers](#response-headers) may contain additional information useful for tracing errors.\n\n```sh\ncurl -H \"Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\" -X GET 'https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/products'\n```\nError response\n```json\n{\n \"error\": \"not_found\",\n \"reason\": \"Database does not exist.\"\n}\n```\n\nError Responses specific to `/_api/v2/` endpoints\n\n```sh\ncurl -H \"Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\" 'https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/_api/v2/db/products/_security'\n```\n```json\n{\n \"code\": 400,\n \"error\": \"No DB products belonging to 00000000-0000-0000-0000-000000000000-bluemix\"\n}\n```\n\n```sh\ncurl -H \"Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\" -d '' 'https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/_api/v2/user/capacity/throughput'\n```\n```json\n{\n \"message\": \"The method is not allowed for the requested URL.\"\n}\n```\n\n### Error response\n\nWhen the Go SDK receives an error response from the server endpoint it returns a\nstandard Go `error`.\nThe `Error()` function of the `error` returns either the HTTP response error message\nor a generic error message.\n\nIn addition to an `error` SDK operations may also return a `DetailedResponse` with\nmethods to retrieve additional information.\n\n| Field | Method | Description |\n|------------|----------------|----------------------------------------------------------------------|\n| StatusCode | GetStatusCode | HTTP response status code. |\n| Result | GetResultAsMap | JSON error response object unmarshalled as `map[string]interface{}`. |\n| RawResult | GetRawResult | Raw error response body as `[]byte`. |\n\n| Key | Value description |\n|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| message | Human readable and printable error message of error and reason. |\n| error | Error type, for example `not_found`. |\n| reason | Error reason, for example `Database does not exist`. |\n| caused_by | Additional error cause information if available. |\n| trace | Trace UUID from the [`X-Request-ID`](#response-headers-x-request-id) or [`X-Couch-Request-ID`](#response-headers-x-couch-request-id) response header. |\n\n#### Other errors\n\nHTTP API requests may also fail with other error conditions, for example,\nvalidation or networking issues.\n\nFor errors unrelated to the HTTP status code the SDK still returns a\nstandard Go `error`. However, the `DetailedResponse` information is absent or limited.\n\nAn example would be an HTTP request that the server terminates when it exceeds a timeout.\nIn this case the request returns a `DetailedResponse` with only a `StatusCode`.\nThe `Result` and `RawResult` elements are `nil`.\n\nArgument validation prevents some invalid values and the SDK does not send the request.\nThis results in `Result` and `RawResult` being `nil`, and a returned\nerror message with no status code or reason.\n\nIn all other cases, `DetailedResponse` is `nil` because there is no JSON error\nresponse from the IBM Cloudant Service.\n\nExample error handling\n\n```go\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\n\t\"github.com/IBM/cloudant-go-sdk/cloudantv1\"\n\t\"github.com/IBM/go-sdk-core/v5/core\"\n)\n\nfunc errorHandlingExample() {\n\tservice, err := cloudantv1.NewCloudantV1(\n\t\t&cloudantv1.CloudantV1Options{},\n\t)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tgetDatabaseInformationOptions := service.NewGetDatabaseInformationOptions(\n\t\t\"products\",\n\t)\n\n\tvar response core.DetailedResponse\n\tdatabaseInformation, response, err := service.GetDatabaseInformation(getDatabaseInformationOptions)\n\tif err != nil {\n\t\t// Use the DetailedResponse to check the HTTP status code\n\t\tif response.StatusCode == 404 {\n\t\t\t// Handle database not existing, maybe create it\n\t\t} else {\n\t\t\tfmt.Println(\"Error: \", err.Error())\n\t\t\tfmt.Println(\"Error status code: \", response.StatusCode)\n\t\t\t// Handle other errors\n\t\t\terrorMap, ok := response.GetResultAsMap()\n\t\t\tif ok {\n\t\t\t\t// Get the request UUID for what went wrong\n\t\t\t\tfmt.Println(\"Trace request UUID: \", errorMap[\"trace\"])\n\t\t\t} else {\n\t\t\t\t// For example to handle non-JSON response bodies\n\t\t\t\tfmt.Println(\"Raw error response: \", response.RawResult)\n\t\t\t}\n\t\t}\n\t}\n\n\tb, _ := json.MarshalIndent(databaseInformation, \"\", \" \")\n\tfmt.Println(string(b))\n}\n```\n\n### Error response\n\nWhen the Java SDK receives an error response from the server endpoint it throws a\n`RuntimeException`. Specifically a subclass of `ServiceResponseException` from the\n`com.ibm.cloud.sdk.core.service.exception` package. The specific subclass depends\non the error encountered.\n\n| Exception class | Description including HTTP status code where applicable |\n|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| ServiceResponseException | Super class for all service response exceptions. |\n| BadRequestException | `400` Bad Request. |\n| UnauthorizedException | `401` Unauthorized. |\n| ForbiddenException | `403` Forbidden. |\n| NotFoundException | `404` Not Found. |\n| NotAcceptableException | `406` Not Acceptable. |\n| ConflictException | `409` Conflict. |\n| RequestTooLargeException | `413` Request Entity Too Large. |\n| UnsupportedException | `415` Unsupported media type. |\n| TooManyRequestsException | `429` Too Many Requests. |\n| InternalServerErrorException | `500` Internal server error. |\n| ServiceUnavailableException | `503` Service Unavailable. |\n| InvalidServiceResponseException | Could not process the response body. Most commonly caused when the server truncates a long running query that exceeded the time limit. |\n\nAll `ServiceResponseException` types have methods to retrieve additional error information.\n\n| Method | Description |\n|--------------------|---------------------------------------------------------------------------|\n| getStatusCode() | HTTP response status code. |\n| getMessage() | Human readable and printable error message. |\n| getDebuggingInfo() | JSON error response body as a `Map` |\n| getHeaders() | HTTP response headers. |\n| getResponseBody() | Raw error response body as `String`. |\n\n| Key | Value description |\n|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| message | Human readable and printable error message of error and reason. |\n| error | Error type, for example `not_found`. |\n| reason | Error reason, for example `Database does not exist`. |\n| caused_by | Additional error cause information if available. |\n| trace | Trace UUID from the [`X-Request-ID`](#response-headers-x-request-id) or [`X-Couch-Request-ID`](#response-headers-x-couch-request-id) response header. |\n\n#### Other errors\n\nHTTP API requests may also fail with other error conditions, for example,\nvalidation or networking issues.\n\nFor errors unrelated to the HTTP status code the SDK throws other `RuntimeException` types.\n\nFor example for many networking errors the SDK throws an `IOException` wrapped in a `RuntimeException`.\n\nArgument validation prevents some invalid values and the SDK does not send the request.\nFor these cases the SDK throws an `IllegalArgumentException`.\n\n| Exception class | Description |\n|--------------------------|------------------------------------------------------------------------------------------------------------|\n| RuntimeException | Use `getCause()` to identify the underlying cause. Typically an `IOException` caused by networking issues. |\n| IllegalArgumentException | Invalid argument passed to the method. |\n| IllegalStateException | The operation cannot be performed, for example starting a changes follower that is already started. |\n\nExample error handling\n\n```java\nimport com.ibm.cloud.cloudant.v1.Cloudant;\nimport com.ibm.cloud.cloudant.v1.model.DatabaseInformation;\nimport com.ibm.cloud.cloudant.v1.model.GetDatabaseInformationOptions;\nimport com.ibm.cloud.sdk.core.service.exception.NotFoundException;\nimport com.ibm.cloud.sdk.core.service.exception.ServiceResponseException;\n\npublic class ErrorHandlingExample {\n\n public static void main() {\n Cloudant service = Cloudant.newInstance();\n\n GetDatabaseInformationOptions databaseInfoOptions =\n new GetDatabaseInformationOptions.Builder().db(\"products\").build();\n\n try {\n DatabaseInformation response =\n service.getDatabaseInformation(databaseInfoOptions).execute().getResult();\n System.out.println(response);\n } catch (NotFoundException e) {\n // Handle database not existing, maybe create it\n } catch (ServiceResponseException e) {\n System.out.println(\"Error: \" + e.getMessage());\n System.out.println(\"Error status code: \" + e.getStatusCode());\n System.out.println(\"Trace UUID: \" + e.getDebuggingInfo().getOrDefault(\"trace\", \"No trace available\"));\n } catch (RuntimeException e) {\n e.printStackTrace();\n }\n }\n}\n```\n\n### Error response\n\nWhen the Node SDK receives an error response from the server endpoint it creates\nan `Error` that contains either the HTTP response error message or a generic error message.\nThe `Promise` returned from the SDK operation rejects with this `Error`.\n\nFor HTTP response errors the properties of the of `Error` include additional information.\n\n| Property | Description |\n|------------|---------------------------------------------|\n| status | HTTP response status code. |\n| statusText | Text description of the status code. |\n| message | Human readable and printable error message. |\n| result | Error JSON response body as an object. |\n| body | Raw error response body as a `string`. |\n\n| Key | Value description |\n|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| error | Error type, for example `not_found`. |\n| reason | Error reason, for example `Database does not exist`. |\n| caused_by | Additional error cause information if available. |\n| trace | Trace UUID from the [`X-Request-ID`](#response-headers-x-request-id) or [`X-Couch-Request-ID`](#response-headers-x-couch-request-id) response header. |\n\n#### Other errors\n\nHTTP API requests may also fail with other error conditions, for example,\nvalidation or networking issues.\n\nFor errors unrelated to the HTTP status code the SDK still rejects with an\n`Error`. However, the available error properties may be more limited.\n\nFor these errors `message` still provides a summary of the problem.\nThere is no `status` defined since there is no HTTP response status code.\nThe `statusText` or `body` contain additional information.\n\nWhen an error prevents the request reaching the service the `Error`\n`code` property may be useful.\n\nAn example is argument validation that prevents some invalid values\nand the SDK does not send the request. Invalid argument values reject\nwith an `Error` object containing a `code` field with the value\n`ERR_INVALID_ARG_VALUE`.\n\n| Property | Description |\n|------------|-----------------------------------------------------------|\n| message | Human readable and printable error message. |\n| statusText | Text description of the status code. |\n| body | Raw error response body as a `string`. |\n| code | Code for some errors that occur before sending a request. |\n\nExample error handling\n\n```javascript\nimport { CloudantV1 } from '@ibm-cloud/cloudant';\n\nfunction errorHandlingExample() {\n const service = CloudantV1.newInstance({});\n\n return service.getDatabaseInformation({ db: \"products\"})\n .then(response => {\n console.log(response.result);\n }).catch((error) => {\n console.log(`Error message: ${error.message}`);\n console.log(`Error status text: ${error.statusText}`);\n if (error.status) {\n if (error.status === 404) {\n // Handle database not existing, maybe create it\n } else {\n console.log(`Error status code: ${error.status}`);\n console.log(`Trace request UUID: ${error?.result?.trace}`);\n }\n } else if (error.code) {\n console.log(`Error code: ${error.code}`);\n } else {\n console.log(`Error body: ${error.body}`);\n }\n });\n}\n\nawait errorHandlingExample();\n```\n\n### Error response\n\nWhen the Python SDK receives an error response from the server endpoint it raises\na standard Python `Exception`. For HTTP response errors the subclass is `ApiException`\nfrom the `ibm_cloud_sdk_core` module. The `ApiException` includes more information about\nthe cause of the failure.\n\n| Attribute | Description |\n|---------------|------------------------------------------------------------|\n| code | HTTP response status code |\n| message | Human readable and printable error message. |\n| http_response | Raw `requests.response` object for the HTTP response body. |\n\nUse the `json()` method of the `http_response` attribute to obtain even more\ndetailed error information.\n\n| Key | Value description |\n|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| error | Error type, for example `not_found`. |\n| reason | Error reason, for example `Database does not exist`. |\n| caused_by | Additional error cause information if available. |\n| trace | Trace UUID from the [`X-Request-ID`](#response-headers-x-request-id) or [`X-Couch-Request-ID`](#response-headers-x-couch-request-id) response header. |\n\n#### Other errors\n\nHTTP API requests may also fail with other error conditions, for example,\nvalidation or networking issues.\n\nFor errors unrelated to the HTTP status code the SDK still raises an `Exception`.\nHowever, the available error properties are different.\n\nNetworking errors and issues like timeouts raise a `requests.RequestException`.\nConsult the `requests` documentation for details of the available subclasses for\nspecific connection related error conditions.\n\nArgument validation prevents some invalid values and the request is not sent.\nInvalid argument values raise a `ValueError` exception.\n\nExample error handling\n\n```python\nfrom ibmcloudant.cloudant_v1 import CloudantV1\nfrom ibm_cloud_sdk_core import ApiException\nfrom requests import RequestException\n\nservice = CloudantV1.new_instance()\n\ntry:\n response = service.get_database_information(db=\"products\").get_result()\n print(response)\nexcept ApiException as ae:\n print(\"Error message: \" + ae.message)\n if ae.status_code == 404:\n # Handle database not existing, maybe create it\n pass\n else:\n print(f'Error status code: {ae.status_code}')\n if 'trace' in (debugInfo := ae.http_response.json()):\n print(f'Trace request UUID: {debugInfo[\"trace\"]}')\nexcept (RequestException, ValueError) as err:\n print(err)\n\n```\n\n## Auditing\n\nYou can monitor API activity within your account by using the IBM Cloud® Activity Tracker service. An event is generated for most of the API endpoints when they are called, and you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method. For methods that don't list any events, no events are generated.\n\nFor more information about how to track IBM Cloudant activity, see [Audit logging](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-audit-logging).\n\n## Additional headers\n\nIBM Cloudant uses HTTP.\nSet the correct HTTP request headers and process the response headers inline with the HTTP specification.\nThis course of action ensures that you get the correct format and encoding.\nDifferent environments and clients are more or less strict on the effect of these HTTP headers,\nespecially when they are not present.\nTo reduce the likelihood of problems or unexpected behavior,\nbe as specific as possible for your client environment.\n\nIBM Cloudant SDKs handle required headers automatically.\nThe SDKs also allow for setting some headers as part of the request options\nwithout needing to use custom header code.\n\nYou can pass additional request header parameters in all requests or in a single request to the service.\n\nTo pass header parameters in a single `curl` request, use the `-H` option.\n\nExample header parameter in a request\n\n```sh\ncurl -H 'Custom-Header:custom_value' -H \"Authorization: Bearer A1b2C3QiOiIyMDE4MDgxNDAwMDAwMDAwMDAwMDBjNzYwNzY2YjYxYjYwYjYwIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJ1c2VyQGdtYWlsLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWF1LmNsb3VkLmlibS5jb20iLCJpYXQiOjE2ODg4ODg4ODgsImV4cCI6MTY4ODg5MjQ4OCwiaXNzIjoiaHR0cHM6Ly9pYXUuY2xvdWQuaWJtLmNvbSIsInNjb3BlIjpbImNsb3VkLnJlYWRlciJdfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\" -X GET https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud\n```\n\nTo pass header parameters with every request, use the `SetDefaultHeaders` method of the service object.\n\nTo pass header parameters in a single request, use `SetHeaders` to include the headers in the options struct before calling the operation.\n\nExample header parameter in all requests\n\n```go\ncustomHeaders := http.Header{}\ncustomHeaders.Add(\"Custom-Header\", \"custom_value\")\nservice.SetDefaultHeaders(customHeaders)\n```\n\nExample header parameter in a request\n\n```go\noptions := service.NewGetServerInformationOptions()\n\ncustomHeaders := make(map[string]string)\ncustomHeaders[\"Custom-Header\"] = \"custom_value\"\n\noptions.SetHeaders(customHeaders)\n\nserverInformation, response, err := service.GetServerInformation(options)\n```\n\nYou can pass request header parameters in all requests or in a single request to the service.\n\nTo pass header parameters with every request, use the `setDefaultHeaders` method of the service object.\n\nTo pass header parameters in a single request, use the `addHeader` method as a modifier before you execute the request.\n\nExample header parameter in all requests\n\n```java\nMap headers = new HashMap();\nheaders.put(\"Customer-Header\", \"custom_value\");\n\nservice.setDefaultHeaders(headers);\n```\n\nExample header parameter in a request\n\n```java\nServerInformation response = service.getServerInformation()\n .addHeader(\"Custom-Header\", \"custom_value\")\n .execute();\n```\n\nYou can pass request header parameters in all requests or in a single request to the service.\n\nTo pass header parameters with every request, specify the `set_default_headers` method of the service object.\n\nTo pass header parameters in a single request, include `headers` as a `dict` in the request.\n\nExample header parameter in all requests\n\n```javascript\nconst service = CloudantV1.newInstance({\n headers: {\n 'Custom-Header': 'custom_value',\n },\n});\n```\n\nExample header parameter in a request\n\n```javascript\nservice.getServerInformation({\n headers: {\n 'Custom-Header': 'custom_value'\n }\n}).then(response => {\n console.log(response.result);\n});\n```\n\nYou can pass request header parameters in all requests or in a single request to the service.\n\nTo pass header parameters with every request, specify the `set_default_headers` method of the service object.\n\nTo pass header parameters in a single request, include `headers` as a `dict` in the request.\n\nExample header parameter in all requests\n\n```python\nheaders = {\n 'Custom-Header': 'custom_value'\n}\n\nservice.set_default_headers(headers)\n```\n\nExample header parameter in a request\n\n```python\nresponse = service.get_server_information(\n headers = {\n 'Custom-Header': 'custom_value'\n })\n```\n\n### Request headers\n\nAdditional supported HTTP request headers are:\n\n*\t`Accept`\n*\t`Accept-Encoding`\n*\t`Content-Type`\n*\t`Content-Encoding`\n*\t`If-None-Match`\n*\t`Range`\n*\t`X-Request-ID`\n\n#### Accept\n\nThe `Accept` header specifies the list of potential data types returned by the server that\nthe client accepts.\nThe format is a list of one or more MIME types, separated by colons.\n\nFor the most requests,\nthe accepted list must include JSON data (`application/json`).\n\nFor attachments,\nyou can either specify the MIME type explicitly,\nor use `*/*` to specify that the client accepts any type.\n\nIf the `Accept` header is not supplied,\nthen the server assumes the `*/*` MIME type,\nwhich means that the client accepts all formats.\n\nThe use of `Accept` in queries to IBM Cloudant is not required,\nbut is highly recommended as it helps to ensure that the client can process the data returned.\n\nIf you specify a data type that uses the `Accept` header,\nIBM Cloudant honors the specified type in the `Content-Type` header field of responses.\nFor example,\nif you explicitly request `application/json` in the `Accept` of a request,\nthe returned HTTP headers use this value in the returned `Content-Type` field.\n\nIBM Cloudant SDKs set this header automatically except for requests\nwhere the user controls the content type, for example, attachments.\n\nExample of sending a request without an explicit `Accept` header, or when you specify `*/*`.\n```http\nGET /recipes HTTP/1.1\nHost: username.cloudant.com\nAccept: */*\n```\n\nExample of a returned header when the client accepts all formats.\n\nThe returned content type is `text/plain` even though the information returned by the request is in JSON format.\n\n```http\nServer: CouchDB/1.0.2 (Erlang OTP/R14B)\nDate: Thu, 13 Jan 2011 13:39:34 GMT\nContent-Type: text/plain;charset=utf-8\nContent-Length: #7\nCache-Control: must-revalidate\n```\n\nExample request that explicitly specifies the `Accept` header.\n\n```http\nGET /recipes HTTP/1.1\nHost: username.cloudant.com\nAccept: application/json\n```\n\nExample of the headers returned in response, including the `application/json` content type.\n\n```http\nServer: CouchDB/1.0.2 (Erlang OTP/R14B)\nDate: Thu, 13 Jan 2011 13:40:11 GMT\nContent-Type: application/json\nContent-Length: #7\nCache-Control: must-revalidate\n```\n\n#### Accept-Encoding\n\nThe `Accept-Encoding` header specifies the server encoding of the response body the client accepts.\nThe supported values are:\n\n* `gzip`\n* `identity`\n\n#### Content-Encoding\n\nThe `Content-Encoding` header specifies the encoding of the request body.\nThe supported value is `gzip`.\nIf the header is used,\nthe request body must be encoded with the corresponding format.\n\nIBM Cloudant SDKs set this header and compress request bodies automatically.\n\nYou can also send compressed request bodies using `gzip` and `curl`.\n\nExample creating a gzipped document.\n\n```sh\necho '{\"foo\":\"bar\"}' | gzip > doc.gzip\n```\n\nExample using the gzipped document in a `curl` request.\n\n```sh\ncurl \"https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud/db/doc\" \\\n\t-X PUT \\\n\t-T doc.gzip \\\n\t-H \"Content-Encoding: gzip\"\n```\n\n#### Content-Type\n\nThe `Content-Type` header specifies the content type of the HTTP request body.\nThe specification uses MIME type specifications.\nFor most requests,\nthe content type is JSON (`application/json`).\n\nFor some settings, the MIME type is plain text.\n\nIn particular,\nwhen you upload attachments the type must be the corresponding\nMIME type for the attachment or binary (`application/octet-stream`).\n\nThe use of the `Content-Type` on a request is highly recommended.\n\n#### If-None-Match\n\nThe `If-None-Match` header is optional.\nYou might send it to determine whether a document changed since it was last read or updated.\nThe value of the `If-None-Match` header must match the last `Etag` value received.\nIf the value matches the current revision of the document,\nthe server sends a `304 Not Modified` status code,\nand the response itself has no body.\n\nIf the document changed,\nyou get a normal `200` response,\nprovided the document still exists and no other errors occurred.\n\n#### Range\n\nThe `Range` header specifies the parts of an attachment that the server should return. Several parts can be requested at the same time in one `Range` header, and the server may send back these ranges in a multipart document. If the server sends back ranges, it uses the status line `206 Partial Content` for the response.\n\n#### X-Request-ID\n\nAssign a [UUIDv4 (random)](https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4) to a request for tracing.\nIf the supplied `X-Request-ID` header value is a valid UUIDv4 it is also returned in the response [`X-Request-ID` header](#response-headers-x-request-id).\nIf the `X-Request-ID` is not set on a request or the supplied value is not a valid UUIDv4 then the server generates a valid value and returns it in the response [`X-Couch-Request-ID` header](#response-headers-x-couch-request-id).\n\n### Response headers\n\nThe server returns response headers when you receive content.\nThey include a number of different fields. Many of the fields are standard HTTP response headers and have no significance regarding how IBM Cloudant operates.\nThe supported HTTP response headers that are important to IBM Cloudant are:\n\n* `Cache-Control`\n* `Content-Encoding`\n* `Content-Length`\n* `Content-Range`\n* `Content-Type`\n* `Etag`\n* `Via`\n* `X-Cloudant-Action`\n* `X-Cloudant-Backend`\n* `X-Cloudant-Request-Class`\n* `X-Content-Type-Options`\n* `X-Couch-Request-ID`\n* `X-Frame-Options`\n* `X-Request-ID`\n\nYou can access response headers returned by IBM Cloudant operations to retrieve metadata such as request IDs for tracing and debugging.\n\nThe examples show how to retrieve the `X-Couch-Request-ID` header from a response.\n\nTo view response headers in a `curl` request, use the `-i` or `--include` option.\n\nAccess the `Headers` field of the `DetailedResponse` returned by operations.\n\nAccess the `Headers` object from the `Response` returned by operations.\n\nAccess the `headers` field of the response object returned by operations.\n\nAccess headers using the `get_headers()` method of the `DetailedResponse` returned by operations.\n\n#### Cache-Control\n\nThe `Cache-Control` HTTP response header provides a suggestion for the client cache mechanisms\non how to treat the returned information.\nIBM Cloudant typically returns the `must-revalidate` value,\nwhich indicates that the information must be revalidated if possible.\nRevalidation ensures that the dynamic nature of the content is correctly updated.\n\n#### Content-Encoding\n\nIndicates the encoding of the response body as negotiated by the `Accept-Encoding` request header.\n\n#### Content-Length\n\nThe `Content-Length` header reports the length in bytes of the returned content.\n\n#### Content-Range\n\nThe `Content-Range` header specifies where in the full document's attachment a partial content belongs.\nThe value is in the form of `bytes /`.\nThe `Range` request header is required to specify the partial content to be returned.\n\n#### Content-Type\n\nThe `Content-Type` header specifies the MIME type of the returned data.\nFor most request,\nthe returned MIME type is `text/plain`.\nAll text is encoded in Unicode (UTF-8),\nwhich is explicitly stated in the returned `Content-Type` as `text/plain;charset=utf-8`.\n\n#### Etag\n\nThe `Etag` header is used to show the revision for a document,\nor the response from a show function.\nFor documents,\nthe value is identical to the revision of the document.\nThe value can be used with an `If-None-Match` request header\nto get a `304 Not Modified` response if the revision is still current.\n\nETags cannot currently be used with views or lists,\nsince the ETags returned from those requests are random numbers that change on every request.\n\n#### Via\n\nA name of an individual reverse proxy server that processed the request.\n\n#### X-Cloudant-Action\n\nAn auditing event's action name generated for the request.\n\n#### X-Cloudant-Backend\n\nA name of an individual backend server that processed the request.\n\n#### X-Cloudant-Request-Class\n\nA request class assigned to the request that count toward\nthe instance's throughput capacity's budget.\n\n#### X-Content-Type-Options\n\nThe `X-Content-Type-Options` response HTTP header is a marker\nused by the server to indicate that the MIME types advertised\nin the `Content-Type` headers should be followed and not be changed.\nThis is a security feature to block content sniffing that could transform\nnon-executable MIME types into executable MIME types.\nBy default Cloudant returns `X-Content-Type-Options: nosniff` that blocks\na request if the request destination is of type style and the MIME type\nis not `text/css`, or of type script and the MIME type is not\na JavaScript MIME type.\n\n#### X-Couch-Request-ID\n\nA unique identifier generated by the server if the request did not have a valid `X-Request-ID` header.\n\n#### X-Frame-Options\n\nThe `X-Frame-Options` is a response header that controls whether\nan HTTP response can be embedded in a ``, `