Skip to content
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.

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

Reintroduce *-format methods to clients that now have ResourceNames #4475

Closed
5 tasks done
andreamlin opened this issue Feb 9, 2019 · 3 comments
Closed
5 tasks done
Assignees
Labels
priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@andreamlin
Copy link
Contributor

andreamlin commented Feb 9, 2019

APIs that introduce resource name message configurations to their GAPIC yaml will lose the format-* methods that format resource names. So as to not break clients, we have to reintroduce these methods.
APIs affected:

Steps to fix:

  • check-in gapic-generator fix to reenable the formatting methods (DONE)~ edit: this turned out to be partially wrong
  • releasing artman v0.16.11 to pick up that fix (DONE)
  • fix bug introduced by above PR, BoolValue presence checking gapic-generator#2561
  • releasing artman v0.16.11 to pick up that fix
  • updating the GAPIC config for the affected APIs; this would be done internally and then bubble up to the github googleapis repo

Ideally we would deprecate these formatting functions, so in the next major version we wouldn't have them at all, since ResourceName classes are superior in static-type-checking and usability.

@andreamlin andreamlin self-assigned this Feb 9, 2019
@andreamlin
Copy link
Contributor Author

cc @sduskis @chingor13

@yoshi-automation yoshi-automation added the triage me I really want to be triaged. label Feb 9, 2019
@sduskis sduskis added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. and removed triage me I really want to be triaged. labels Feb 12, 2019
@sduskis
Copy link
Contributor

sduskis commented Feb 15, 2019

@andreamlin, can we close this issue?

@andreamlin
Copy link
Contributor Author

Yay!

I'll open another issue that follows up to this to add documentation or code changes that would prevent this from happening in the future hopefully.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

No branches or pull requests

3 participants