Skip to content

docs: Distinguish between public/private docs in 2.0 guide #1226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gcf-merge-on-green merged 2 commits into from
Mar 15, 2021
Merged

docs: Distinguish between public/private docs in 2.0 guide #1226

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44c1805
docs: Distinguish between public/private docs in 2.0 guide
parthea Mar 5, 2021
5ca861b
Merge branch 'master' into update-release-2-0-docs
parthea Mar 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions UPGRADING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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

Expand Down