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

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

@@ -289,8 +289,8 @@ public Builder newBuilder() {
   /**
    * Gets the attEncodingInfo.
    *
-   * Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment
-   * is compressed.
+   * Parameter to specify whether to include the encoding information for compressed attachments. This only applies when
+   * requesting documents in the response.
    *
    * @return the attEncodingInfo
    */
@@ -301,7 +301,8 @@ public Boolean attEncodingInfo() {
   /**
    * Gets the attachments.
    *
-   * Parameter to specify whether to include attachments bodies in a response.
+   * 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.
    *
    * @return the attachments
    */
@@ -312,8 +313,8 @@ public Boolean attachments() {
   /**
    * Gets the conflicts.
    *
-   * Parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when
-   * `include_docs` is `true`.
+   * Parameter to specify whether to include a list of conflicted revisions in each returned document. This only applies
+   * when requesting documents in the response.
    *
    * @return the conflicts
    */
@@ -346,7 +347,7 @@ public Boolean includeDocs() {
   /**
    * Gets the inclusiveEnd.
    *
-   * Parameter to specify whether the specified end key should be included in the result.
+   * Parameter to specify whether to include the specified end key in the result.
    *
    * @return the inclusiveEnd
    */

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

@@ -216,9 +216,12 @@ public String contentType() {
   /**
    * Gets the data.
    *
-   * Base64-encoded content. Available if attachment content is requested by using the query parameters
-   * `attachments=true` or `atts_since`. Note that when used with a view or changes feed `include_docs` must also be
-   * `true`.
+   * 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`).
+   *
+   * Note that SDK deserialization of documents with included attachments automatically decodes the Base64 encoded
+   * attachment content string to bytes.
    *
    * @return the data
    */
@@ -229,8 +232,8 @@ public byte[] data() {
   /**
    * Gets the digest.
    *
-   * Content hash digest. It starts with prefix which announce hash type (e.g. `md5-`) and continues with Base64-encoded
-   * hash digest.
+   * Content hash digest. It starts with prefix declaring the hash type, `md5-` for example, and continues with the
+   * Base64-encoded hash digest.
    *
    * @return the digest
    */
@@ -241,9 +244,8 @@ public String digest() {
   /**
    * Gets the encodedLength.
    *
-   * Compressed attachment size in bytes. Available if content_type was in list of compressible types when the
-   * attachment was added and the query parameter `att_encoding_info` is `true`. Note that when used with a view or
-   * changes feed `include_docs` must also be `true`.
+   * 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.
    *
    * @return the encodedLength
    */
@@ -254,9 +256,8 @@ public Long encodedLength() {
   /**
    * Gets the encoding.
    *
-   * Compression codec. Available if content_type was in list of compressible types when the attachment was added and
-   * the and the query parameter `att_encoding_info` is `true`. Note that when used with a view or changes feed
-   * `include_docs` must also be `true`.
+   * 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.
    *
    * @return the encoding
    */
@@ -289,7 +290,7 @@ public Long length() {
   /**
    * Gets the revpos.
    *
-   * Revision number when attachment was added.
+   * Revision number at attachment addition.
    *
    * @return the revpos
    */
@@ -300,7 +301,7 @@ public Long revpos() {
   /**
    * Gets the stub.
    *
-   * Has `true` value if object contains stub info and no content. Otherwise omitted in response.
+   * Has `true` value if object has stub attachment metadata, but not attachment content. Otherwise omitted in response.
    *
    * @return the stub
    */

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

@@ -42,6 +42,8 @@ public Long getActive() {
    *
    * The total uncompressed size of the content, in bytes.
    *
+   * This is the value used for IBM Cloudant storage billing.
+   *
    * @return the external
    */
   public Long getExternal() {

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

@@ -82,7 +82,13 @@ public Builder newBuilder() {
   /**
    * Gets the partitioned.
    *
-   * Whether this design document describes partitioned or global indexes.
+   * 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. A 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. For non-partitioned
+   * databases, the default is `false` and design documents default to global. Only partitioned databases can have
+   * partitioned indexes.
    *
    * @return the partitioned
    */

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

@@ -142,7 +142,7 @@ public Builder newBuilder() {
   /**
    * Gets the descending.
    *
-   * Query parameter to specify whether to return the documents in descending by key order.
+   * Query parameter to specify whether to return rows in descending by key order.
    *
    * @return the descending
    */

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

@@ -171,7 +171,7 @@ public Builder newBuilder() {
   /**
    * Gets the descending.
    *
-   * Query parameter to specify whether to return the documents in descending by key order.
+   * Query parameter to specify whether to return rows in descending by key order.
    *
    * @return the descending
    */

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

@@ -311,7 +311,8 @@ public String ifNoneMatch() {
   /**
    * Gets the attachments.
    *
-   * Query parameter to specify whether to include attachments bodies in a response.
+   * 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.
    *
    * @return the attachments
    */
@@ -322,8 +323,8 @@ public Boolean attachments() {
   /**
    * Gets the attEncodingInfo.
    *
-   * Query parameter to specify whether to include the encoding information in attachment stubs if the particular
-   * attachment is compressed.
+   * 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.
    *
    * @return the attEncodingInfo
    */
@@ -334,8 +335,8 @@ public Boolean attEncodingInfo() {
   /**
    * Gets the conflicts.
    *
-   * Query parameter to specify whether to include a list of conflicted revisions in each returned document. Active only
-   * when `include_docs` is `true`.
+   * 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.
    *
    * @return the conflicts
    */

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

@@ -310,7 +310,8 @@ public String ifNoneMatch() {
   /**
    * Gets the attachments.
    *
-   * Query parameter to specify whether to include attachments bodies in a response.
+   * 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.
    *
    * @return the attachments
    */
@@ -321,8 +322,8 @@ public Boolean attachments() {
   /**
    * Gets the attEncodingInfo.
    *
-   * Query parameter to specify whether to include the encoding information in attachment stubs if the particular
-   * attachment is compressed.
+   * 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.
    *
    * @return the attEncodingInfo
    */
@@ -333,8 +334,8 @@ public Boolean attEncodingInfo() {
   /**
    * Gets the conflicts.
    *
-   * Query parameter to specify whether to include a list of conflicted revisions in each returned document. Active only
-   * when `include_docs` is `true`.
+   * 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.
    *
    * @return the conflicts
    */

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

@@ -231,7 +231,8 @@ public String ifNoneMatch() {
   /**
    * Gets the attachments.
    *
-   * Query parameter to specify whether to include attachments bodies in a response.
+   * 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.
    *
    * @return the attachments
    */
@@ -242,8 +243,8 @@ public Boolean attachments() {
   /**
    * Gets the attEncodingInfo.
    *
-   * Query parameter to specify whether to include the encoding information in attachment stubs if the particular
-   * attachment is compressed.
+   * 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.
    *
    * @return the attEncodingInfo
    */

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

@@ -280,7 +280,8 @@ public String ifNoneMatch() {
   /**
    * Gets the attachments.
    *
-   * Query parameter to specify whether to include attachments bodies in a response.
+   * 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.
    *
    * @return the attachments
    */
@@ -291,8 +292,8 @@ public Boolean attachments() {
   /**
    * Gets the attEncodingInfo.
    *
-   * Query parameter to specify whether to include the encoding information in attachment stubs if the particular
-   * attachment is compressed.
+   * 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.
    *
    * @return the attEncodingInfo
    */
@@ -303,8 +304,8 @@ public Boolean attEncodingInfo() {
   /**
    * Gets the conflicts.
    *
-   * Query parameter to specify whether to include a list of conflicted revisions in each returned document. Active only
-   * when `include_docs` is `true`.
+   * 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.
    *
    * @return the conflicts
    */

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

@@ -319,8 +319,8 @@ public String db() {
   /**
    * Gets the attEncodingInfo.
    *
-   * Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment
-   * is compressed.
+   * Parameter to specify whether to include the encoding information for compressed attachments. This only applies when
+   * requesting documents in the response.
    *
    * @return the attEncodingInfo
    */
@@ -331,7 +331,8 @@ public Boolean attEncodingInfo() {
   /**
    * Gets the attachments.
    *
-   * Parameter to specify whether to include attachments bodies in a response.
+   * 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.
    *
    * @return the attachments
    */
@@ -342,8 +343,8 @@ public Boolean attachments() {
   /**
    * Gets the conflicts.
    *
-   * Parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when
-   * `include_docs` is `true`.
+   * Parameter to specify whether to include a list of conflicted revisions in each returned document. This only applies
+   * when requesting documents in the response.
    *
    * @return the conflicts
    */
@@ -376,7 +377,7 @@ public Boolean includeDocs() {
   /**
    * Gets the inclusiveEnd.
    *
-   * Parameter to specify whether the specified end key should be included in the result.
+   * Parameter to specify whether to include the specified end key in the result.
    *
    * @return the inclusiveEnd
    */

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

@@ -214,7 +214,8 @@ public List<BulkGetQueryDocument> docs() {
   /**
    * Gets the attachments.
    *
-   * Query parameter to specify whether to include attachments bodies in a response.
+   * 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.
    *
    * @return the attachments
    */
@@ -225,8 +226,8 @@ public Boolean attachments() {
   /**
    * Gets the attEncodingInfo.
    *
-   * Query parameter to specify whether to include the encoding information in attachment stubs if the particular
-   * attachment is compressed.
+   * 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.
    *
    * @return the attEncodingInfo
    */

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

@@ -516,8 +516,8 @@ public String lastEventId() {
   /**
    * Gets the attEncodingInfo.
    *
-   * Query parameter to specify whether to include the encoding information in attachment stubs if the particular
-   * attachment is compressed.
+   * 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.
    *
    * @return the attEncodingInfo
    */
@@ -528,7 +528,8 @@ public Boolean attEncodingInfo() {
   /**
    * Gets the attachments.
    *
-   * Query parameter to specify whether to include attachments bodies in a response.
+   * 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.
    *
    * @return the attachments
    */
@@ -539,8 +540,8 @@ public Boolean attachments() {
   /**
    * Gets the conflicts.
    *
-   * Query parameter to specify whether to include a list of conflicted revisions in each returned document. Active only
-   * when `include_docs` is `true`.
+   * 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.
    *
    * @return the conflicts
    */
@@ -551,7 +552,8 @@ public Boolean conflicts() {
   /**
    * Gets the descending.
    *
-   * Query parameter to specify whether to return the documents in descending by key order.
+   * 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.
    *
    * @return the descending
    */