X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/571b278b35fa2702b7fb4bbe22ed0fe10d966cb8..7ed22caf822b166651cabd78ff6c5a3488681e00:/README.md diff --git a/README.md b/README.md index 43b40b71d4..03124d5ccc 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,10 @@ The Google API Ruby Client makes it trivial to discover and access supported APIs. +## Alpha + +This library is in Alpha. We will make an effort to support the library, but we reserve the right to make incompatible changes when necessary. + ## Install Be sure `https://rubygems.org/` is in your gem sources. @@ -119,6 +123,8 @@ in the credentials. Detailed instructions on how to enable delegation for your d The API client can automatically retry requests for recoverable errors. To enable retries, set the `client.retries` property to the number of additional attempts. To avoid flooding servers, retries invovle a 1 second delay that increases on each subsequent retry. +In the case of authentication token expiry, the API client will attempt to refresh the token and retry the failed operation - this +is a specific exception to the retry rules. The default value for retries is 0, but will be enabled by default in future releases.