Skip to content
Permalink
Browse files
docs: Distinguish between public/private docs in 2.0 guide (#1226)
Fixes #1225  馃
  • Loading branch information
parthea committed Mar 15, 2021
1 parent 1b1171d commit a6f17066caf6e911b7e94e8feab52fa3af2def1b
Showing with 20 additions and 6 deletions.
  1. +20 鈭6 UPGRADING.md
@@ -7,11 +7,24 @@ please continue to use version 1.x as we will continue supporting python 2.7+ in

In addition, discovery documents will no longer be retrieved dynamically when
you call `discovery.build()`. The discovery documents will instead be retrieved
from the client library directly. Existing code written for earlier versions of
this library will not require updating. We believe this new default behaviour
will provide a more predictable experience for users. If always using the latest
version of a service definition is more important than reliability, users should
set the `static_discovery` argument of `discovery.build()` to `False` to
from the client library directly.

For users of public APIs
------------------------
Existing code written for earlier versions of this library will not require
updating. We believe this new default behaviour will provide a more predictable
experience for users. If always using the latest version of a service definition
is more important than reliability, users should set the `static_discovery`
argument of `discovery.build()` to `False` to retrieve the service definition
from the internet.

For users of private APIs
-------------------------
If the discovery document requires an authentication key to access it, the
discovery document is private and it will not be shipped with the library.
Only discovery documents listed in [this public directory](https://www.googleapis.com/discovery/v1/apis/)
are included in the library. Users of private APIs should set the
`static_discovery` argument of `discovery.build()` to `False` to continue to
retrieve the service definition from the internet.

If you experience issues or have questions, please file an [issue](https://github.com/googleapis/google-api-python-client/issues).
@@ -27,7 +40,8 @@ to use version 2.0.0.

**Note**: Existing code written for earlier versions of this library will not
require updating. You should only update your code if always using the latest
version of a service definition is more important than reliability.
version of a service definition is more important than reliability or if you
are using an API which does not have a public discovery document.

> **WARNING**: Breaking change

0 comments on commit a6f1706

Please sign in to comment.