Skip to content

Commit

Permalink
fix(discovery-v1): property indexed corrected to available for mo…
Browse files Browse the repository at this point in the history
…del `EnvironmentDocuments`

plus, docs changes
  • Loading branch information
dpopp07 committed Apr 24, 2020
1 parent 40fd822 commit 7bc2ccd
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions discovery/v1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2238,7 +2238,7 @@ class DiscoveryV1 extends BaseService {
* Query a collection.
*
* By using this method, you can construct long queries. For details, see the [Discovery
* documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts).
* documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.environmentId - The ID of the environment.
Expand Down Expand Up @@ -2383,8 +2383,8 @@ class DiscoveryV1 extends BaseService {
*
* Queries for notices (errors or warnings) that might have been generated by the system. Notices are generated when
* ingesting documents and performing relevance training. See the [Discovery
* documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts) for
* more details on the query language.
* documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts) for more details
* on the query language.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.environmentId - The ID of the environment.
Expand Down Expand Up @@ -2509,8 +2509,7 @@ class DiscoveryV1 extends BaseService {
* Query multiple collections.
*
* By using this method, you can construct long queries that search multiple collection. For details, see the
* [Discovery
* documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts).
* [Discovery documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.environmentId - The ID of the environment.
Expand Down Expand Up @@ -2649,8 +2648,8 @@ class DiscoveryV1 extends BaseService {
*
* Queries for notices (errors or warnings) that might have been generated by the system. Notices are generated when
* ingesting documents and performing relevance training. See the [Discovery
* documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts) for
* more details on the query language.
* documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts) for more details
* on the query language.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.environmentId - The ID of the environment.
Expand Down Expand Up @@ -3554,7 +3553,7 @@ class DiscoveryV1 extends BaseService {
*
* You associate a customer ID with data by passing the **X-Watson-Metadata** header with a request that passes data.
* For more information about personal data and customer IDs, see [Information
* security](https://cloud.ibm.com/docs/services/discovery?topic=discovery-information-security#information-security).
* security](https://cloud.ibm.com/docs/discovery?topic=discovery-information-security#information-security).
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.customerId - The customer ID for which all data is to be deleted.
Expand Down Expand Up @@ -6138,13 +6137,13 @@ namespace DiscoveryV1 {
/** The access key ID associated with the cloud object store. Only valid, and required, with a
* **credential_type** of `aws4_hmac`. This value is never returned and is only used when creating or modifying
* **credentials**. For more infomation, see the [cloud object store
* documentation](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-object-storage-using-hmac-credentials#using-hmac-credentials).
* documentation](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-using-hmac-credentials#using-hmac-credentials).
*/
access_key_id?: string;
/** The secret access key associated with the cloud object store. Only valid, and required, with a
* **credential_type** of `aws4_hmac`. This value is never returned and is only used when creating or modifying
* **credentials**. For more infomation, see the [cloud object store
* documentation](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-object-storage-using-hmac-credentials#using-hmac-credentials).
* documentation](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-using-hmac-credentials#using-hmac-credentials).
*/
secret_access_key?: string;
}
Expand Down Expand Up @@ -6298,7 +6297,7 @@ namespace DiscoveryV1 {
* When using `elements` the **options** object must contain Element Classification options. Additionally, when
* using the `elements` enrichment the configuration specified and files ingested must meet all the criteria
* specified in [the
* documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-element-classification#element-classification).
* documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-element-classification#element-classification).
*/
enrichment: string;
/** If true, then most errors generated during the enrichment process will be treated as warnings and will not
Expand Down Expand Up @@ -6359,7 +6358,7 @@ namespace DiscoveryV1 {
/** Summary of the document usage statistics for the environment. */
export interface EnvironmentDocuments {
/** Number of documents indexed for the environment. */
indexed?: number;
available?: number;
/** Total number of documents allowed in the environment's capacity. */
maximum_allowed?: number;
}
Expand Down

0 comments on commit 7bc2ccd

Please sign in to comment.