Repository navigation
Addition of policy and options to reserved names in #824 results in breaking changes to stable libraries #835
Description
These APIs have field renames resulting from this #824 which expanded the RESERVED_NAMES list. Some of them are GA, and even for beta APIs I'd prefer not to take changes that looks spurious from the user's perspective.
googleapis/python-artifact-registry#12
googleapis/python-cloudbuild#81
googleapis/python-iot#87
googleapis/python-functions#45
googleapis/python-securitycenter#120
googleapis/python-bigquery-connection#57
googleapis/python-containeranalysis#112
googleapis/python-bigtable#280
googleapis/python-tasks#85
googleapis/python-policy-troubleshooter#8
googleapis/python-asset#171
googleapis/python-org-policy#32
googleapis/python-binary-authorization#18
googleapis/python-spanner#303
googleapis/python-secret-manager#100
googleapis/python-firestore#336
googleapis/python-billing#55
googleapis/python-datacatalog#143
policy and options are the two that show up in these APIs.
From looking at the regen, it doesn't look like these need to be added to the reserved names list? f5e9f36 seems to result in the imports being renamed to not conflict. I see from google.iam.v1 import policy_pb2 as giv_policy (example) instead of from google.iam.v1 import policy_pb2 as policy.
Can policy and options be removed from the list? @software-dov
Activity
software-dov commentedon Apr 8, 2021
Options cannot, policy may be. @parthea can chime in for context, I think he's working with the APIs that require these names.
parthea commentedon Apr 9, 2021
The issue I encountered was with keyword
authin APIservicemanagementv1at this line. We could certainly limit the impact of this change if we only addauthas a reserved name.Prior to generator version 0.43.2 there was a conflict with
authWith the fix in version 0.43.2
You can see the change here:
https://github.com/googleapis/googleapis-gen/commit/107ed1217b5e87048263f52cd3911d5f851aca7e#diff-c8fa0e83f42f4ec28657fd35abc265e70911e8487762f7ae1891e4747ba791b9L28
busunkim96 commentedon Apr 9, 2021
Given what @parthea shared, is it possible to back out the change?
Or can we tweak the raw imports in the templates to use references that are less likely to conflict?
parthea commentedon Apr 16, 2021
@software-dov, PTAL
tswast commentedon Apr 20, 2021
I think this is breaking generation of the datacatalog library googleapis/python-datacatalog#143 (comment)
software-dov commentedon Apr 21, 2021
Do we have a sense of how time critical this issue is, or a required timeline?
busunkim96 commentedon Apr 21, 2021
@software-dov I'm currently blocking generator updates on the repos listed. So any features since that change (GAPIC metadata and self-signed JWT) will not land in those repos for the time being.
I could technically add synth replaces to avoid the breaking change, but would rather not do so for 10+ repos since it is error prone.
fix: remove auth, policy, and options from the reserved names list (#851