Skip to content

feat(AIP-121): require Get for mutable resources#993

Merged
shwoodard merged 5 commits intoaip-dev:masterfrom
toumorokoshi:toum/require-get-method
Dec 21, 2022
Merged

feat(AIP-121): require Get for mutable resources#993
shwoodard merged 5 commits intoaip-dev:masterfrom
toumorokoshi:toum/require-get-method

Conversation

@toumorokoshi
Copy link
Copy Markdown
Contributor

Resources that do not support Get but support mutable operations make customers unable to validate the
state of their resources for long-term synchronization use cases like drift detection or state management.

See pulumi/pulumi-google-native#47 for an example of the issue.

Resources that do not support Get but support mutable
operations make customers unable to validate the
state of their resources for long-term synchronization
use cases like drift detection or state management.

See pulumi/pulumi-google-native#47
for an example of the issue.
@toumorokoshi toumorokoshi requested a review from a team as a code owner December 20, 2022 00:23
Comment thread aip/general/0121.md Outdated
Comment thread aip/general/0121.md Outdated
Comment thread aip/general/0121.md Outdated
Comment thread aip/general/0121.md Outdated
use "validate the state of the resource", since that's actually what's being done here.
Not so much "operation completion", which should be detected via LRO or request completion.
@bgrant0607
Copy link
Copy Markdown
Contributor

Yeah! Thanks!

I'm not aware of any justified exceptions to this, but if any do arise, they should be enumerated explicitly rather than weakening the language.

Comment thread aip/general/0121.md Outdated
- Making Get and List required as requiring them for a mutable
  operation effectively makes a resource only valid if it supports
  these operations.
@bgrant0607
Copy link
Copy Markdown
Contributor

LGTM

Comment thread aip/general/0121.md Outdated
- Lists cannot exist in the case of singleton resources, so
  calling out that edge case specifically as not requiring List.
Copy link
Copy Markdown
Collaborator

@noahdietz noahdietz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but please allow @shwoodard to Approve

@shwoodard shwoodard merged commit 17039c3 into aip-dev:master Dec 21, 2022
toumorokoshi added a commit to toumorokoshi/google.aip.dev that referenced this pull request Dec 21, 2022
- fixing formatting (e.g. bolding of must)
- removing the CRUDL + custom methods restriction, as the
  terminology was not clear and very little is actually limited
  by adding that line.
- updating guidance for Get and List to match aip-dev#993.
- fixing wording of stateless to clarify referring to stateless protocols.
toumorokoshi added a commit to toumorokoshi/google.aip.dev that referenced this pull request Dec 21, 2022
- fixing formatting (e.g. bolding of must)
- removing the CRUDL + custom methods restriction, as the
  terminology was not clear and very little is actually limited
  by adding that line.
- updating guidance for Get and List to match aip-dev#993.
- fixing wording of stateless to clarify referring to stateless protocols.
toumorokoshi added a commit to toumorokoshi/google.aip.dev that referenced this pull request Dec 21, 2022
- fixing formatting (e.g. bolding of must)
- removing the CRUDL + custom methods restriction, as the
  terminology was not clear and very little is actually limited
  by adding that line.
- updating guidance for Get and List to match aip-dev#993.
- fixing wording of stateless to clarify referring to stateless protocols.
toumorokoshi added a commit to toumorokoshi/google.aip.dev that referenced this pull request Mar 17, 2023
With aip-dev#993, Get and List are required for resources as stated in AIP-121.

Fixe the guidance to match in the more specific AIPs.
toumorokoshi added a commit that referenced this pull request Mar 20, 2023
With #993, Get and List are required for resources as stated in AIP-121.

Fixe the guidance to match in the more specific AIPs.
nitinapi pushed a commit to nitinapi/google.aip.dev that referenced this pull request Apr 5, 2023
With aip-dev#993, Get and List are required for resources as stated in AIP-121.

Fixe the guidance to match in the more specific AIPs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants