diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/Cloudant.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/Cloudant.java index fb1a6294f..bfc6945cb 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/Cloudant.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/Cloudant.java @@ -1511,7 +1511,7 @@ public ServiceCall getDocumentAsStream(GetDocumentOptions getDocume * * For creation, you must specify the document ID but you should not specify the revision. * - * For modification, you must specify the document ID and a revision identifier. + * For modification, you must specify the document ID and a revision identifier. * * @param putDocumentOptions the {@link PutDocumentOptions} containing the options for the call * @return a {@link ServiceCall} with a result of type {@link DocumentResult} @@ -4557,8 +4557,8 @@ public ServiceCall getMembershipInformation() { /** * Retrieve information about whether the server is up. * - * Confirms that the server is up, running, and ready to respond to requests. If `maintenance_mode` is `true` or - * `nolb`, the endpoint returns a 404 response. + * Confirms that the server is up, running, and ready to respond to requests. If the cluster is unavailable the + * endpoint returns a `503` response code. * * **Tip:** The authentication for this endpoint is only enforced when using IAM. * @@ -4580,8 +4580,8 @@ public ServiceCall getUpInformation(GetUpInformationOptions getUp /** * Retrieve information about whether the server is up. * - * Confirms that the server is up, running, and ready to respond to requests. If `maintenance_mode` is `true` or - * `nolb`, the endpoint returns a 404 response. + * Confirms that the server is up, running, and ready to respond to requests. If the cluster is unavailable the + * endpoint returns a `503` response code. * * **Tip:** The authentication for this endpoint is only enforced when using IAM. * diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/DatabaseInformation.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/DatabaseInformation.java index 4f25913dc..2d662b782 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/DatabaseInformation.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/DatabaseInformation.java @@ -152,7 +152,7 @@ public String getEngine() { * Gets the instanceStartTime. * * 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 infromation. Typically only used by replicators. + * replicator versions. Do not use the value to infer timing information. Typically only used by replicators. * * @return the instanceStartTime */ diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/DesignDocument.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/DesignDocument.java index c86746077..a41891071 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/DesignDocument.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/DesignDocument.java @@ -745,11 +745,13 @@ public void setOptions(final DesignDocumentOptions options) { * * * `newDoc` - New version of document that will be stored * from the update request. - * * `oldDoc` - Previous version of document that is already stored. - * * `userCtx` - User Context Object, containing information about the - * user writing the document (if present), see the `UserContext`. - * * `secObj` - Security Object, with lists of database security roles, - * see the `SecurityObject`. + * * `oldDoc` - Previous version of document that is already + * stored. + * * `userCtx` - User Context Object, containing information + * about the user writing the document (if present), see the + * `UserContext`. + * * `secObj` - Security Object, with lists of database security + * roles, see the `SecurityObject`. * * @return the validateDocUpdate */ diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/ExplainResult.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/ExplainResult.java index aa4d43b2e..c9b88d22b 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/ExplainResult.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/ExplainResult.java @@ -167,8 +167,8 @@ public Object getPartitioned() { * argument. * * It is important for query performance to use appropriate selectors: - * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis - * of a query. You should include at least one of these in a selector. + * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and + * `$lte` (but not `$ne`) can be used as the basis of a query. You should include at least one of these in a selector. * * Some operators such as `$not`, `$or`, `$in`, and `$regex` cannot be answered from an index. For query selectors * use these operators in conjunction with equality operators or create and use a partial index to reduce the number * of documents that will need to be scanned. diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/GetDbUpdatesOptions.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/GetDbUpdatesOptions.java index 066e9c1be..1874d07cc 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/GetDbUpdatesOptions.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/GetDbUpdatesOptions.java @@ -194,16 +194,16 @@ public String feed() { * Gets the heartbeat. * * Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off by - * default and only applicable for - * `continuous` and `eventsource` feeds. Overrides any timeout to keep the feed alive indefinitely. May also be `true` - * to use a value of `60000`. + * default and only applicable for `continuous` and `eventsource` feeds. Overrides any timeout to keep the feed alive + * indefinitely. May also be `true` to use a value of `60000`. * * **Note:** Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an * environment where idle network connections may break, `heartbeat` is not suitable as a keepalive mechanism. * Instead, consider one of the following options: - * * Use the `timeout` parameter with a value that is compatible with your network environment. - * * Switch to scheduled usage of one of the non-continuous changes feed types - * (`normal` or `longpoll`). + * * Use the `timeout` parameter with a value that is compatible with + * your network environment. + * * Switch to scheduled usage of one of the non-continuous changes feed + * types (`normal` or `longpoll`). * * Use TCP keepalive. * * @return the heartbeat @@ -240,8 +240,12 @@ public Long timeout() { /** * Gets the since. * - * Query parameter to specify to start the results from the change immediately after the given update sequence. Can be - * a valid update sequence or `now` value. Default is `0` i.e. all changes. + * Query parameter to specify to start the results from the change immediately after the given update sequence. + * Possible values are: + * * `0` for all available changes (default). + * * `now` for future changes. + * * A valid update sequence, for example, from the `seq` value of a + * change received before. * * @return the since */ diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/IndexAnalysisExclusionReason.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/IndexAnalysisExclusionReason.java index 038ace72f..ff2c922b5 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/IndexAnalysisExclusionReason.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/IndexAnalysisExclusionReason.java @@ -26,7 +26,8 @@ public class IndexAnalysisExclusionReason extends GenericModel { * The full list of possible reason codes is following: * * * alphabetically_comes_after: json - * There is another suitable index whose name comes before that of this index. + * There is another suitable index whose name comes before that of + * this index. * * empty_selector: text * "text" indexes do not support queries with empty selectors. * * excluded_by_user: any use_index was used to manually specify the index. @@ -77,7 +78,8 @@ protected IndexAnalysisExclusionReason() { } * The full list of possible reason codes is following: * * * alphabetically_comes_after: json - * There is another suitable index whose name comes before that of this index. + * There is another suitable index whose name comes before that of + * this index. * * empty_selector: text * "text" indexes do not support queries with empty selectors. * * excluded_by_user: any use_index was used to manually specify the index. diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/IndexDefinition.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/IndexDefinition.java index e6561f4cf..0bea07b7c 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/IndexDefinition.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/IndexDefinition.java @@ -259,8 +259,8 @@ public Boolean indexArrayLengths() { * argument. * * It is important for query performance to use appropriate selectors: - * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis - * of a query. You should include at least one of these in a selector. + * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and + * `$lte` (but not `$ne`) can be used as the basis of a query. You should include at least one of these in a selector. * * Some operators such as `$not`, `$or`, `$in`, and `$regex` cannot be answered from an index. For query selectors * use these operators in conjunction with equality operators or create and use a partial index to reduce the number * of documents that will need to be scanned. diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostChangesOptions.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostChangesOptions.java index a8829653f..f0dd914da 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostChangesOptions.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostChangesOptions.java @@ -484,8 +484,8 @@ public List fields() { * argument. * * It is important for query performance to use appropriate selectors: - * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis - * of a query. You should include at least one of these in a selector. + * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and + * `$lte` (but not `$ne`) can be used as the basis of a query. You should include at least one of these in a selector. * * Some operators such as `$not`, `$or`, `$in`, and `$regex` cannot be answered from an index. For query selectors * use these operators in conjunction with equality operators or create and use a partial index to reduce the number * of documents that will need to be scanned. @@ -577,11 +577,11 @@ public String feed() { * * The built-in filter types are: * * `_design` - Returns only changes to design documents. - * * `_doc_ids` - Returns changes for documents with an ID matching one specified in - * `doc_ids` request body parameter. (`POST` only) - * * `_selector` - Returns changes for documents that match the `selector` - * request body parameter. The selector syntax is the same as used for - * `_find`. (`POST` only) + * * `_doc_ids` - Returns changes for documents with an ID matching one + * specified in `doc_ids` request body parameter. (`POST` only) + * * `_selector` - Returns changes for documents that match the + * `selector` request body parameter. The selector syntax is the same + * as used for `_find`. (`POST` only) * * `_view` - Returns changes for documents that match an existing map * function in the view specified by the query parameter `view`. * @@ -589,8 +589,8 @@ public String feed() { * `design_doc/filtername`. * * **Note:** For better performance use the built-in `_selector`, `_design` or `_doc_ids` filters rather than JS based - * `_view` or design document filters. If you need to pass values to change the filtered content use the `_selector` - * filter type. + * `_view` or design document filters. If you need to pass values to change the filtered content use the + * `_selector` filter type. * * @return the filter */ @@ -602,16 +602,16 @@ public String filter() { * Gets the heartbeat. * * Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off by - * default and only applicable for - * `continuous` and `eventsource` feeds. Overrides any timeout to keep the feed alive indefinitely. May also be `true` - * to use a value of `60000`. + * default and only applicable for `continuous` and `eventsource` feeds. Overrides any timeout to keep the feed alive + * indefinitely. May also be `true` to use a value of `60000`. * * **Note:** Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an * environment where idle network connections may break, `heartbeat` is not suitable as a keepalive mechanism. * Instead, consider one of the following options: - * * Use the `timeout` parameter with a value that is compatible with your network environment. - * * Switch to scheduled usage of one of the non-continuous changes feed types - * (`normal` or `longpoll`). + * * Use the `timeout` parameter with a value that is compatible with + * your network environment. + * * Switch to scheduled usage of one of the non-continuous changes feed + * types (`normal` or `longpoll`). * * Use TCP keepalive. * * @return the heartbeat @@ -659,8 +659,12 @@ public Long seqInterval() { /** * Gets the since. * - * Query parameter to specify to start the results from the change immediately after the given update sequence. Can be - * a valid update sequence or `now` value. Default is `0` i.e. all changes. + * Query parameter to specify to start the results from the change immediately after the given update sequence. + * Possible values are: + * * `0` for all available changes (default). + * * `now` for future changes. + * * A valid update sequence, for example, from the `seq` value of a + * change received before. * * @return the since */ diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostExplainOptions.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostExplainOptions.java index 619899b5b..2b84a72fa 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostExplainOptions.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostExplainOptions.java @@ -393,8 +393,8 @@ public String db() { * argument. * * It is important for query performance to use appropriate selectors: - * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis - * of a query. You should include at least one of these in a selector. + * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and + * `$lte` (but not `$ne`) can be used as the basis of a query. You should include at least one of these in a selector. * * Some operators such as `$not`, `$or`, `$in`, and `$regex` cannot be answered from an index. For query selectors * use these operators in conjunction with equality operators or create and use a partial index to reduce the number * of documents that will need to be scanned. @@ -413,7 +413,7 @@ public Map selector() { /** * Gets the allowFallback. * - * Whether to allow fallback to other indexes. Default is true. + * Whether to allow fallback to other indexes. Default is true. * * @return the allowFallback */ @@ -497,7 +497,8 @@ public Long skip() { * field name and direction pair is the topmost level of sort. The second pair, if provided, is the next level of * sort. The field can be any field, using dotted notation if desired for sub-document fields. * - * For example in JSON: `[{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]` + * For example in JSON: + * `[{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]` * * When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the * same order and each object in the sort array has a single key or at least one of the sort fields is included in the diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostFindOptions.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostFindOptions.java index 761bc3e58..49801db11 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostFindOptions.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostFindOptions.java @@ -393,8 +393,8 @@ public String db() { * argument. * * It is important for query performance to use appropriate selectors: - * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis - * of a query. You should include at least one of these in a selector. + * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and + * `$lte` (but not `$ne`) can be used as the basis of a query. You should include at least one of these in a selector. * * Some operators such as `$not`, `$or`, `$in`, and `$regex` cannot be answered from an index. For query selectors * use these operators in conjunction with equality operators or create and use a partial index to reduce the number * of documents that will need to be scanned. @@ -413,7 +413,7 @@ public Map selector() { /** * Gets the allowFallback. * - * Whether to allow fallback to other indexes. Default is true. + * Whether to allow fallback to other indexes. Default is true. * * @return the allowFallback */ @@ -497,7 +497,8 @@ public Long skip() { * field name and direction pair is the topmost level of sort. The second pair, if provided, is the next level of * sort. The field can be any field, using dotted notation if desired for sub-document fields. * - * For example in JSON: `[{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]` + * For example in JSON: + * `[{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]` * * When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the * same order and each object in the sort array has a single key or at least one of the sort fields is included in the diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionExplainOptions.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionExplainOptions.java index 84b5c05af..b00714125 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionExplainOptions.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionExplainOptions.java @@ -408,8 +408,8 @@ public String partitionKey() { * argument. * * It is important for query performance to use appropriate selectors: - * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis - * of a query. You should include at least one of these in a selector. + * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and + * `$lte` (but not `$ne`) can be used as the basis of a query. You should include at least one of these in a selector. * * Some operators such as `$not`, `$or`, `$in`, and `$regex` cannot be answered from an index. For query selectors * use these operators in conjunction with equality operators or create and use a partial index to reduce the number * of documents that will need to be scanned. @@ -428,7 +428,7 @@ public Map selector() { /** * Gets the allowFallback. * - * Whether to allow fallback to other indexes. Default is true. + * Whether to allow fallback to other indexes. Default is true. * * @return the allowFallback */ @@ -512,7 +512,8 @@ public Long skip() { * field name and direction pair is the topmost level of sort. The second pair, if provided, is the next level of * sort. The field can be any field, using dotted notation if desired for sub-document fields. * - * For example in JSON: `[{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]` + * For example in JSON: + * `[{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]` * * When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the * same order and each object in the sort array has a single key or at least one of the sort fields is included in the diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionFindOptions.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionFindOptions.java index 7ecc335f4..7c95db318 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionFindOptions.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionFindOptions.java @@ -408,8 +408,8 @@ public String partitionKey() { * argument. * * It is important for query performance to use appropriate selectors: - * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis - * of a query. You should include at least one of these in a selector. + * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and + * `$lte` (but not `$ne`) can be used as the basis of a query. You should include at least one of these in a selector. * * Some operators such as `$not`, `$or`, `$in`, and `$regex` cannot be answered from an index. For query selectors * use these operators in conjunction with equality operators or create and use a partial index to reduce the number * of documents that will need to be scanned. @@ -428,7 +428,7 @@ public Map selector() { /** * Gets the allowFallback. * - * Whether to allow fallback to other indexes. Default is true. + * Whether to allow fallback to other indexes. Default is true. * * @return the allowFallback */ @@ -512,7 +512,8 @@ public Long skip() { * field name and direction pair is the topmost level of sort. The second pair, if provided, is the next level of * sort. The field can be any field, using dotted notation if desired for sub-document fields. * - * For example in JSON: `[{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]` + * For example in JSON: + * `[{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]` * * When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the * same order and each object in the sort array has a single key or at least one of the sort fields is included in the diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionSearchOptions.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionSearchOptions.java index b2c4e35e1..4ae7c7d87 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionSearchOptions.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionSearchOptions.java @@ -555,7 +555,7 @@ public Long limit() { * Gets the sort. * * 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 + * 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>", diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionViewOptions.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionViewOptions.java index 36fc70c0c..e6ce3a597 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionViewOptions.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostPartitionViewOptions.java @@ -629,7 +629,7 @@ public Object endKey() { /** * Gets the endKeyDocId. * - * Schema for a document ID. + * Stop returning rows at the specified document ID. No effect if using `group` or not providing end key. * * @return the endKeyDocId */ @@ -666,7 +666,8 @@ public Long groupLevel() { /** * Gets the key. * - * Schema for any JSON type. + * 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. * * @return the key */ @@ -677,8 +678,8 @@ public Object key() { /** * Gets the keys. * - * Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys that match - * the key type emitted by the view function. + * 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. * * @return the keys */ @@ -692,9 +693,10 @@ public List keys() { * Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce * function is defined. * - * A default `reduce` view type can be disabled to behave like a `map` by setting `reduce=false` explicitly. + * A default `reduce` view type can be disabled to behave like a + * `map` by setting `reduce=false` explicitly. * - * Be aware that `include_docs=true` can only be used with `map` views. + * Be aware that `include_docs=true` is only for `map` views. Reduced views do not include document IDs in view rows. * * @return the reduce */ @@ -716,7 +718,7 @@ public Object startKey() { /** * Gets the startKeyDocId. * - * Schema for a document ID. + * Start returning rows at the specified document ID. No effect if using `group` or not providing start key. * * @return the startKeyDocId */ diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostSearchOptions.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostSearchOptions.java index fed703292..279b54d77 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostSearchOptions.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostSearchOptions.java @@ -667,7 +667,7 @@ public Long limit() { * Gets the sort. * * 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 + * 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>", diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostViewOptions.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostViewOptions.java index 7d470b50b..8d506933d 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostViewOptions.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostViewOptions.java @@ -614,7 +614,7 @@ public Object endKey() { /** * Gets the endKeyDocId. * - * Schema for a document ID. + * Stop returning rows at the specified document ID. No effect if using `group` or not providing end key. * * @return the endKeyDocId */ @@ -651,7 +651,8 @@ public Long groupLevel() { /** * Gets the key. * - * Schema for any JSON type. + * 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. * * @return the key */ @@ -662,8 +663,8 @@ public Object key() { /** * Gets the keys. * - * Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys that match - * the key type emitted by the view function. + * 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. * * @return the keys */ @@ -677,9 +678,10 @@ public List keys() { * Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce * function is defined. * - * A default `reduce` view type can be disabled to behave like a `map` by setting `reduce=false` explicitly. + * A default `reduce` view type can be disabled to behave like a + * `map` by setting `reduce=false` explicitly. * - * Be aware that `include_docs=true` can only be used with `map` views. + * Be aware that `include_docs=true` is only for `map` views. Reduced views do not include document IDs in view rows. * * @return the reduce */ @@ -690,10 +692,11 @@ public Boolean reduce() { /** * Gets the stable. * - * Query parameter to specify whether use the same replica of the index on each request. The default value `false` - * contacts all replicas and returns the result from the first, fastest, responder. Setting it to `true` when used in - * conjunction with `update=false` may improve consistency at the expense of increased latency and decreased - * throughput if the selected replica is not the fastest of the available replicas. + * Query parameter to specify whether use the same replica of the index on each request. The default value `false` + * contacts all replicas and returns the result from the first, fastest, responder. Setting it to `true` when used in + * conjunction with + * `update=false` may improve consistency at the expense of increased latency and decreased throughput if the selected + * replica is not the fastest of the available replicas. * * **Note:** In general setting `true` is discouraged and is strictly not recommended when using `update=true`. * @@ -717,7 +720,7 @@ public Object startKey() { /** * Gets the startKeyDocId. * - * Schema for a document ID. + * Start returning rows at the specified document ID. No effect if using `group` or not providing start key. * * @return the startKeyDocId */ diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/ReplicationDocument.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/ReplicationDocument.java index b4018c1cc..1f2dee36f 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/ReplicationDocument.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/ReplicationDocument.java @@ -1177,8 +1177,8 @@ public void setRetriesPerRequest(final long retriesPerRequest) { * argument. * * It is important for query performance to use appropriate selectors: - * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and `$lte` (but not `$ne`) can be used as the basis - * of a query. You should include at least one of these in a selector. + * * Only equality operators such as `$eq`, `$gt`, `$gte`, `$lt`, and + * `$lte` (but not `$ne`) can be used as the basis of a query. You should include at least one of these in a selector. * * Some operators such as `$not`, `$or`, `$in`, and `$regex` cannot be answered from an index. For query selectors * use these operators in conjunction with equality operators or create and use a partial index to reduce the number * of documents that will need to be scanned. diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/SearchIndexDefinition.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/SearchIndexDefinition.java index cdc98107f..188ca48b5 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/SearchIndexDefinition.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/SearchIndexDefinition.java @@ -123,21 +123,23 @@ public AnalyzerConfiguration analyzer() { * document as a parameter, extracts some data from it, and then calls the `index` function to index that data. The * index function takes 2, or optionally 3, parameters. * - * * The first parameter is the name of the field you intend to use when - * querying the index. If the special value `"default"` is used when you - * define the name, you do not have to specify a field name at query time. - * * The second parameter is the data to be indexed. This data must be only a - * string, number, or boolean. Other types will cause an error to be thrown - * by the index function call. + * * The first parameter is the name of the field you intend to use + * when querying the index. If the special value `"default"` is used + * when you define the name, you do not have to specify a field name + * at query time. + * * The second parameter is the data to be indexed. This data must be + * only a string, number, or boolean. Other types will cause an error + * to be thrown by the index function call. * * The optional third parameter is a JavaScript object with these * properties: * * * `facet` - boolean, default `false` - Creates a faceted index. - * * `index` - boolean, default `true` - If set to `false`, the data - * cannot be used for searches, but can still be retrieved from the - * index if `store` is set to `true`. - * * `store` - boolean, default `true` - If true, the value is returned - * in the search result; otherwise, the value is not returned. + * * `index` - boolean, default `true` - If set to `false`, the + * data cannot be used for searches, but can still be retrieved + * from the index if `store` is set to `true`. + * * `store` - boolean, default `true` - If true, the value is + * returned in the search result; otherwise, the value is not + * returned. * * @return the index */ diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/Security.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/Security.java index a8461738f..dfa12c18d 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/Security.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/Security.java @@ -20,7 +20,7 @@ import com.ibm.cloud.sdk.core.service.model.GenericModel; /** - * Schema for a security document. + * Schema for a Cloudant security document. */ public class Security extends GenericModel { diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/UpInformation.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/UpInformation.java index bc0faf9b5..af4f66291 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/UpInformation.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/UpInformation.java @@ -34,11 +34,23 @@ public interface Status { String OK = "ok"; } + protected String cluster; protected Map seeds; protected String status; protected UpInformation() { } + /** + * Gets the cluster. + * + * cluster. + * + * @return the cluster + */ + public String getCluster() { + return cluster; + } + /** * Gets the seeds. * diff --git a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/ViewQuery.java b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/ViewQuery.java index f7ae4d804..582ad9087 100644 --- a/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/ViewQuery.java +++ b/modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/ViewQuery.java @@ -526,7 +526,7 @@ public Object endKey() { /** * Gets the endKeyDocId. * - * Schema for a document ID. + * Stop returning rows at the specified document ID. No effect if using `group` or not providing end key. * * @return the endKeyDocId */ @@ -563,7 +563,8 @@ public Long groupLevel() { /** * Gets the key. * - * Schema for any JSON type. + * 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. * * @return the key */ @@ -574,8 +575,8 @@ public Object key() { /** * Gets the keys. * - * Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys that match - * the key type emitted by the view function. + * 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. * * @return the keys */ @@ -589,9 +590,10 @@ public List keys() { * Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce * function is defined. * - * A default `reduce` view type can be disabled to behave like a `map` by setting `reduce=false` explicitly. + * A default `reduce` view type can be disabled to behave like a + * `map` by setting `reduce=false` explicitly. * - * Be aware that `include_docs=true` can only be used with `map` views. + * Be aware that `include_docs=true` is only for `map` views. Reduced views do not include document IDs in view rows. * * @return the reduce */ @@ -602,10 +604,11 @@ public Boolean reduce() { /** * Gets the stable. * - * Query parameter to specify whether use the same replica of the index on each request. The default value `false` - * contacts all replicas and returns the result from the first, fastest, responder. Setting it to `true` when used in - * conjunction with `update=false` may improve consistency at the expense of increased latency and decreased - * throughput if the selected replica is not the fastest of the available replicas. + * Query parameter to specify whether use the same replica of the index on each request. The default value `false` + * contacts all replicas and returns the result from the first, fastest, responder. Setting it to `true` when used in + * conjunction with + * `update=false` may improve consistency at the expense of increased latency and decreased throughput if the selected + * replica is not the fastest of the available replicas. * * **Note:** In general setting `true` is discouraged and is strictly not recommended when using `update=true`. * @@ -629,7 +632,7 @@ public Object startKey() { /** * Gets the startKeyDocId. * - * Schema for a document ID. + * Start returning rows at the specified document ID. No effect if using `group` or not providing start key. * * @return the startKeyDocId */ diff --git a/modules/cloudant/src/test/java/com/ibm/cloud/cloudant/v1/CloudantIT.java b/modules/cloudant/src/test/java/com/ibm/cloud/cloudant/v1/CloudantIT.java index debe28db0..db455bd74 100644 --- a/modules/cloudant/src/test/java/com/ibm/cloud/cloudant/v1/CloudantIT.java +++ b/modules/cloudant/src/test/java/com/ibm/cloud/cloudant/v1/CloudantIT.java @@ -625,7 +625,7 @@ public void testPostDocument() throws Exception { .add("keywords", "[\"Foo\",\"Scales\",\"Weight\",\"Digital\",\"Kitchen\"]") .add("name", "Digital Kitchen Scales") .add("price", "14.99") - .add("productid", "1000042") + .add("productId", "1000042") .add("taxonomy", "[\"Home\",\"Kitchen\",\"Small Appliances\"]") .add("type", "product") .build(); @@ -1185,7 +1185,7 @@ public void testPutDocument() throws Exception { .add("keywords", "[\"Foo\",\"Scales\",\"Weight\",\"Digital\",\"Kitchen\"]") .add("name", "Digital Kitchen Scales") .add("price", "14.99") - .add("productid", "1000042") + .add("productId", "1000042") .add("taxonomy", "[\"Home\",\"Kitchen\",\"Small Appliances\"]") .add("type", "product") .build(); @@ -1316,7 +1316,7 @@ public void testPutDesignDocument() throws Exception { .build(); DesignDocumentViewsMapReduce designDocumentViewsMapReduceModel = new DesignDocumentViewsMapReduce.Builder() - .map("function(doc) { \n emit(doc.productid, [doc.brand, doc.name, doc.description]) \n}") + .map("function(doc) {\n emit(doc.productId, [doc.brand, doc.name, doc.description])\n}") .reduce("testString") .build(); @@ -1920,7 +1920,7 @@ public void testPostPartitionExplain() throws Exception { .bookmark("testString") .conflicts(true) .executionStats(true) - .fields(java.util.Arrays.asList("productid", "name", "description")) + .fields(java.util.Arrays.asList("productId", "name", "description")) .limit(Long.valueOf("25")) .skip(Long.valueOf("0")) .sort(java.util.Arrays.asList(java.util.Collections.singletonMap("key1", "asc"))) @@ -1955,7 +1955,7 @@ public void testPostPartitionFind() throws Exception { .bookmark("testString") .conflicts(true) .executionStats(true) - .fields(java.util.Arrays.asList("productid", "name", "description")) + .fields(java.util.Arrays.asList("productId", "name", "description")) .limit(Long.valueOf("25")) .skip(Long.valueOf("0")) .sort(java.util.Arrays.asList(java.util.Collections.singletonMap("key1", "asc"))) @@ -1990,7 +1990,7 @@ public void testPostPartitionFindAsStream() throws Exception { .bookmark("testString") .conflicts(true) .executionStats(true) - .fields(java.util.Arrays.asList("productid", "name", "description")) + .fields(java.util.Arrays.asList("productId", "name", "description")) .limit(Long.valueOf("25")) .skip(Long.valueOf("0")) .sort(java.util.Arrays.asList(java.util.Collections.singletonMap("key1", "asc"))) @@ -3102,7 +3102,7 @@ public void testPutLocalDocument() throws Exception { .add("keywords", "[\"Foo\",\"Scales\",\"Weight\",\"Digital\",\"Kitchen\"]") .add("name", "Digital Kitchen Scales") .add("price", "14.99") - .add("productid", "1000042") + .add("productId", "1000042") .add("taxonomy", "[\"Home\",\"Kitchen\",\"Small Appliances\"]") .add("type", "product") .build(); diff --git a/modules/cloudant/src/test/java/com/ibm/cloud/cloudant/v1/CloudantTest.java b/modules/cloudant/src/test/java/com/ibm/cloud/cloudant/v1/CloudantTest.java index 707cc49ac..4f2417f02 100644 --- a/modules/cloudant/src/test/java/com/ibm/cloud/cloudant/v1/CloudantTest.java +++ b/modules/cloudant/src/test/java/com/ibm/cloud/cloudant/v1/CloudantTest.java @@ -1065,7 +1065,7 @@ public void testPostDocumentWOptions() throws Throwable { .add("keywords", "[\"Foo\",\"Scales\",\"Weight\",\"Digital\",\"Kitchen\"]") .add("name", "Digital Kitchen Scales") .add("price", "14.99") - .add("productid", "1000042") + .add("productId", "1000042") .add("taxonomy", "[\"Home\",\"Kitchen\",\"Small Appliances\"]") .add("type", "product") .build(); @@ -2160,7 +2160,7 @@ public void testPutDocumentWOptions() throws Throwable { .add("keywords", "[\"Foo\",\"Scales\",\"Weight\",\"Digital\",\"Kitchen\"]") .add("name", "Digital Kitchen Scales") .add("price", "14.99") - .add("productid", "1000042") + .add("productId", "1000042") .add("taxonomy", "[\"Home\",\"Kitchen\",\"Small Appliances\"]") .add("type", "product") .build(); @@ -2459,7 +2459,7 @@ public void testPutDesignDocumentWOptions() throws Throwable { // Construct an instance of the DesignDocumentViewsMapReduce model DesignDocumentViewsMapReduce designDocumentViewsMapReduceModel = new DesignDocumentViewsMapReduce.Builder() - .map("function(doc) { \n emit(doc.productid, [doc.brand, doc.name, doc.description]) \n}") + .map("function(doc) {\n emit(doc.productId, [doc.brand, doc.name, doc.description])\n}") .reduce("testString") .build(); @@ -3506,7 +3506,7 @@ public void testPostPartitionExplainWOptions() throws Throwable { .bookmark("testString") .conflicts(true) .executionStats(true) - .fields(java.util.Arrays.asList("productid", "name", "description")) + .fields(java.util.Arrays.asList("productId", "name", "description")) .limit(Long.valueOf("25")) .skip(Long.valueOf("0")) .sort(java.util.Arrays.asList(java.util.Collections.singletonMap("key1", "asc"))) @@ -3570,7 +3570,7 @@ public void testPostPartitionFindWOptions() throws Throwable { .bookmark("testString") .conflicts(true) .executionStats(true) - .fields(java.util.Arrays.asList("productid", "name", "description")) + .fields(java.util.Arrays.asList("productId", "name", "description")) .limit(Long.valueOf("25")) .skip(Long.valueOf("0")) .sort(java.util.Arrays.asList(java.util.Collections.singletonMap("key1", "asc"))) @@ -3634,7 +3634,7 @@ public void testPostPartitionFindAsStreamWOptions() throws Throwable { .bookmark("testString") .conflicts(true) .executionStats(true) - .fields(java.util.Arrays.asList("productid", "name", "description")) + .fields(java.util.Arrays.asList("productId", "name", "description")) .limit(Long.valueOf("25")) .skip(Long.valueOf("0")) .sort(java.util.Arrays.asList(java.util.Collections.singletonMap("key1", "asc"))) @@ -5961,7 +5961,7 @@ public void testPutLocalDocumentWOptions() throws Throwable { .add("keywords", "[\"Foo\",\"Scales\",\"Weight\",\"Digital\",\"Kitchen\"]") .add("name", "Digital Kitchen Scales") .add("price", "14.99") - .add("productid", "1000042") + .add("productId", "1000042") .add("taxonomy", "[\"Home\",\"Kitchen\",\"Small Appliances\"]") .add("type", "product") .build(); @@ -6514,7 +6514,7 @@ public void testGetMembershipInformationWRetries() throws Throwable { @Test public void testGetUpInformationWOptions() throws Throwable { // Register a mock response - String mockResponseBody = "{\"seeds\": {\"anyKey\": \"anyValue\"}, \"status\": \"maintenance_mode\"}"; + String mockResponseBody = "{\"cluster\": \"cluster\", \"seeds\": {\"anyKey\": \"anyValue\"}, \"status\": \"maintenance_mode\"}"; String getUpInformationPath = "/_up"; server.enqueue(new MockResponse() .setHeader("Content-type", "application/json") diff --git a/modules/cloudant/src/test/java/com/ibm/cloud/cloudant/v1/model/UpInformationTest.java b/modules/cloudant/src/test/java/com/ibm/cloud/cloudant/v1/model/UpInformationTest.java index 5cc9ba03d..162df5cb9 100644 --- a/modules/cloudant/src/test/java/com/ibm/cloud/cloudant/v1/model/UpInformationTest.java +++ b/modules/cloudant/src/test/java/com/ibm/cloud/cloudant/v1/model/UpInformationTest.java @@ -32,6 +32,7 @@ public class UpInformationTest { @Test public void testUpInformation() throws Throwable { UpInformation upInformationModel = new UpInformation(); + assertNull(upInformationModel.getCluster()); assertNull(upInformationModel.getSeeds()); assertNull(upInformationModel.getStatus()); } diff --git a/stubs/gen-its-mappings.json b/stubs/gen-its-mappings.json index dc148f99a..5c5bce1b5 100644 --- a/stubs/gen-its-mappings.json +++ b/stubs/gen-its-mappings.json @@ -2829,7 +2829,7 @@ "method": "POST", "bodyPatterns": [ { - "equalToJson": "{\"bookmark\": \"testString\",\"conflicts\" : true, \"execution_stats\" : true, \"fields\" : [ \"productid\", \"name\", \"description\" ], \"limit\" : 25, \"selector\" : { }, \"skip\" : 0, \"sort\" : [ { \"key1\": \"asc\" } ], \"stable\" : true, \"update\" : \"true\", \"use_index\" : [ \"testString\" ]}", + "equalToJson": "{\"bookmark\": \"testString\",\"conflicts\" : true, \"execution_stats\" : true, \"fields\" : [ \"productId\", \"name\", \"description\" ], \"limit\" : 25, \"selector\" : { }, \"skip\" : 0, \"sort\" : [ { \"key1\": \"asc\" } ], \"stable\" : true, \"update\" : \"true\", \"use_index\" : [ \"testString\" ]}", "ignoreArrayOrder": false, "ignoreExtraElements": true } @@ -2918,7 +2918,7 @@ "method": "POST", "bodyPatterns": [ { - "equalToJson": "{\"bookmark\" : \"testString\",\"conflicts\" : true, \"execution_stats\" : true, \"fields\" : [ \"productid\", \"name\", \"description\" ], \"limit\" : 25, \"selector\" : { }, \"skip\" : 0, \"sort\" : [ { \"key1\": \"asc\" } ], \"stable\" : true, \"update\" : \"true\", \"use_index\" : [ \"testString\" ]}", + "equalToJson": "{\"bookmark\" : \"testString\",\"conflicts\" : true, \"execution_stats\" : true, \"fields\" : [ \"productId\", \"name\", \"description\" ], \"limit\" : 25, \"selector\" : { }, \"skip\" : 0, \"sort\" : [ { \"key1\": \"asc\" } ], \"stable\" : true, \"update\" : \"true\", \"use_index\" : [ \"testString\" ]}", "ignoreArrayOrder": false, "ignoreExtraElements": true }