Add description field to the OSResource in Inventory and REST API #3
Conversation
This file contains hidden or 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
pierventre
reviewed
Apr 15, 2025
| @@ -5991,6 +5991,11 @@ components: | |||
| type: string | |||
| maxLength: 128 | |||
| pattern: '^[a-zA-Z-_0-9. ()]+$' | |||
| description: | |||
pierventre
reviewed
Apr 15, 2025
| @@ -26,6 +26,7 @@ var OpenAPIOSResourceToProto = map[string]string{ | |||
| "kernelCommand": osv1.OperatingSystemResourceFieldKernelCommand, | |||
| "updateSources": osv1.OperatingSystemResourceFieldUpdateSources, | |||
| "installedPackages": osv1.OperatingSystemResourceFieldInstalledPackages, | |||
| "description": osv1.OperatingSystemResourceFieldDescription, | |||
There was a problem hiding this comment.
move to the slice below if we make it readonly
pierventre
reviewed
Apr 15, 2025
| @@ -409,6 +410,10 @@ func openapiToGrpcOSResource(body *api.OperatingSystemResource) (*osv1.Operating | |||
| os.Name = *body.Name | |||
| } | |||
|
|
|||
| if body.Description != nil { | |||
There was a problem hiding this comment.
this is not needed if the description cannot be changed by the user
pierventre
reviewed
Apr 15, 2025
| @@ -114,6 +114,17 @@ message OperatingSystemResource { | |||
| immutable: true | |||
| }]; // An opaque JSON string storing a reference to custom installation script(s) that supplements the base OS with additional OS-level dependencies/configurations. If empty, the default OS installation will be used. | |||
|
|
|||
| string description = 16 [ | |||
There was a problem hiding this comment.
should this be immutable?
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.
PULL DESCRIPTION
Provide a 1-2 line brief overview of the changes submitted through the Pull Request...
Impact Analysis
CODE MAINTAINABILITY
Code must act as a teacher for future developers