feat: AIP-147 – Sensitive fields #26
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mkistler
approved these changes
Oct 30, 2022
added 2 commits
October 30, 2022 10:48
rofrankel
requested changes
Nov 1, 2022
| publicKey: Buffer; | ||
|
|
||
| // The private key data in PEM-encoded form. | ||
| set privateKey(k: Buffer): void; |
There was a problem hiding this comment.
Is this the right way to express input-only for OAS? I don't know if a TS interface is the right way to describe an RPC. What is someone supposed to do in OAS?
| ## Guidance | ||
|
|
||
| If the sensitive information is _required_ for the resource as a whole to | ||
| exist, the data **should** be accepted as an [input-only field][input-only] |
There was a problem hiding this comment.
I think we should probably actually draft AIP-203 first. Google's AIP-203 is all in terms of protobuf; I want to know what it means for a field to be required or input-only in OAS.
| for the resource to exist, users of the API may assume that existence of the | ||
| resource implies storage of the sensitive data. For example: | ||
|
|
||
| ```typescript |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.