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.

Sign up for GitHub

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

Jump to bottom

docs/plugin-protocol: Add notes about missing configuration in ReadResource and UpgradeResourceState request messages #31998

Merged
merged 2 commits into from
Oct 13, 2022
Merged

docs/plugin-protocol: Add notes about missing configuration in ReadResource and UpgradeResourceState request messages #31998

merged 2 commits into from
Oct 13, 2022

Conversation

bflad
Copy link
Contributor

@bflad bflad commented Oct 12, 2022

This opts to inline document these intentional design decisions in the protocol definition as a catch-all for it not being documented elsewhere.

If there is a better place for this documentation, please let me know.

Partially relates to #29568 although I'm not actively working on that particular issue, just trying to capture some recent discussions that occurred out-of-band with GitHub.

Target Release

None (main branch for additional protocol definition file comments)

Draft CHANGELOG entry

None

@bflad
docs/plugin-protocol: Add notes about missing configuration in ReadRe…
66c6f74 
…source and UpgradeResourceState request messages

This opts to inline document these intentional design decisions in the protocol definition as a catch-all for it not being documented elsewhere.
@bflad bflad added documentation providers/protocol Potentially affecting the Providers Protocol and SDKs labels Oct 12, 2022
@jbardin
Copy link
Member

jbardin commented Oct 13, 2022

I think these comments look good, and we've been leaning on the proto files for this type of interoperability documentation. You do need to regenerate the proto files though to get the checks to pass, because the comments get written into the source.

@bflad
Copy link
Contributor Author

bflad commented Oct 13, 2022

Ah right! Will do that right now, thanks for the note.

@bflad
internal: Regenerate protobuf files
0bf9973 
Updated via:

```shell
make protobuf
```
@bflad bflad merged commit 8c93420 into main Oct 13, 2022
@bflad bflad deleted the bflad/protocol-missing-config-docs branch October 13, 2022 20:29
@github-actions
Copy link
Contributor

Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch.

bflad added a commit to hashicorp/terraform-plugin-go that referenced this pull request Oct 13, 2022
@bflad
tfprotov5+tfprotov6: Synchronize Protocol Buffers comments for ReadRe…
fb106c6 
…source and UpgradeResourceState

Reference: hashicorp/terraform#31998
@bflad bflad mentioned this pull request Oct 13, 2022
Merged
bflad added a commit to hashicorp/terraform-plugin-go that referenced this pull request Oct 14, 2022
@bflad
tfprotov5+tfprotov6: Synchronize Protocol Buffers comments for ReadRe…
c199d46 
…source and UpgradeResourceState (#231)

Reference: hashicorp/terraform#31998
@github-actions
Copy link
Contributor

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 13, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jbardin jbardin jbardin approved these changes

Assignees
No one assigned
Labels
documentation providers/protocol Potentially affecting the Providers Protocol and SDKs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bflad @jbardin