feat(generated): update API definition to 1.0.0-dev0.1.30

modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/Cloudant.java

@@ -1511,7 +1511,7 @@ public ServiceCall<InputStream> 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<MembershipInformation> 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<UpInformation> 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.
    *

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
    */

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
    */

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.

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
    */

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.

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.

modules/cloudant/src/main/java/com/ibm/cloud/cloudant/v1/model/PostChangesOptions.java

@@ -484,8 +484,8 @@ public List<String> 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,20 +577,20 @@ 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`.
    *
    * Additionally, the value can be the name of a JS filter function from a design document. For example:
    * `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
    */

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<String, Object> 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

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<String, Object> 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

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<String, Object> 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

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<String, Object> 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

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>",