Skip to content

Commit a6f1706

Browse files
authored
docs: Distinguish between public/private docs in 2.0 guide (#1226)
Fixes #1225 🦕
1 parent 1b1171d commit a6f1706

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

UPGRADING.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,24 @@ please continue to use version 1.x as we will continue supporting python 2.7+ in
77

88
In addition, discovery documents will no longer be retrieved dynamically when
99
you call `discovery.build()`. The discovery documents will instead be retrieved
10-
from the client library directly. Existing code written for earlier versions of
11-
this library will not require updating. We believe this new default behaviour
12-
will provide a more predictable experience for users. If always using the latest
13-
version of a service definition is more important than reliability, users should
14-
set the `static_discovery` argument of `discovery.build()` to `False` to
10+
from the client library directly.
11+
12+
For users of public APIs
13+
------------------------
14+
Existing code written for earlier versions of this library will not require
15+
updating. We believe this new default behaviour will provide a more predictable
16+
experience for users. If always using the latest version of a service definition
17+
is more important than reliability, users should set the `static_discovery`
18+
argument of `discovery.build()` to `False` to retrieve the service definition
19+
from the internet.
20+
21+
For users of private APIs
22+
-------------------------
23+
If the discovery document requires an authentication key to access it, the
24+
discovery document is private and it will not be shipped with the library.
25+
Only discovery documents listed in [this public directory](https://www.googleapis.com/discovery/v1/apis/)
26+
are included in the library. Users of private APIs should set the
27+
`static_discovery` argument of `discovery.build()` to `False` to continue to
1528
retrieve the service definition from the internet.
1629

1730
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.
2740

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

3246
> **WARNING**: Breaking change
3347

0 commit comments

Comments
 (0)