You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 5, 2023. It is now read-only.
docs: update the upgrade guide to be from 1.0 to 3.0 (#77)
- [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-datacatalog/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- Ensure the tests and linter pass - N/A
- Code coverage does not decrease (if any source code was changed) - N/A
- [x] Appropriate docs were updated (if necessary)
Fixes#76 🦕
Copy file name to clipboardExpand all lines: UPGRADING.md
+12-17Lines changed: 12 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
-
# 2.0.0 Migration Guide
1
+
# 3.0.0 Migration Guide
2
2
3
-
The 2.0 release of the `google-cloud-datacatalog` client is a significant upgrade based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-python), and includes substantial interface changes. Existing code written for earlier versions of this library will likely require updates to use this version. This document describes the changes that have been made, and what you need to do to update your usage.
3
+
The 3.0 release of the `google-cloud-datacatalog` client is a significant upgrade based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-python), and includes substantial interface changes. Existing code written for earlier versions of this library will likely require updates to use this version. This document describes the changes that have been made, and what you need to do to update your usage.
4
4
5
5
If you experience issues or have questions, please file an [issue](https://github.com/googleapis/python-datacatalog/issues).
In `google-cloud-datacatalog<2.0.0`, parameters required by the API were positional parameters and optional parameters were keyword parameters.
48
+
In `google-cloud-datacatalog<=1.0.0`, parameters required by the API were positional parameters and optional parameters were keyword parameters.
49
49
50
50
**Before:**
51
51
```py
@@ -60,7 +60,7 @@ In `google-cloud-datacatalog<2.0.0`, parameters required by the API were positio
60
60
):
61
61
```
62
62
63
-
In the 2.0.0 release, all methods have a single positional parameter `request`. Method docstrings indicate whether a parameter is required or optional.
63
+
In the 3.0.0 release, all methods have a single positional parameter `request`. Method docstrings indicate whether a parameter is required or optional.
64
64
65
65
Some methods have additional keyword only parameters. The available parameters depend on the `google.api.method_signature` annotation specified by the API producer.
66
66
@@ -127,24 +127,19 @@ The submodules `enums` and `types` have been removed.
The project path helper method `project_path` has been removed. Please construct
145
-
this path manually.
146
-
147
-
```py
148
-
project ='my-project'
149
-
project_path =f'projects/{project}'
150
-
```
144
+
The `location_path` method existing in `google-cloud-datacatalog<=1.0.0` was renamed to `common_location_path`.
145
+
And more resource path helper methods were added: `common_billing_account_path`, `common_folder_path`, `common_organization_path`, and `common_project_path`.
0 commit comments