Add configuration objects and JSON serialization #231
Closed
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
Added `FileConfiguration` and `HashConfiguration` with serialize/deserialize to JSON. Also added helper to get the schema. The file resource MVP provides basic configuration of files and their content.
Replace the auto-generated metadata with simpler, fixed text. The generated metadata for `title` and `description` is coming from the comments. It's overly verbose and a little out of context.
SteveL-MSFT
requested changes
Oct 20, 2023
| #[schemars(title = "DSC.FileConfiguration", description = "File resource configuration.")] | ||
| pub struct File { | ||
| pub path: String, | ||
| #[serde(rename = "hash", skip_serializing_if = "Option::is_none")] |
There was a problem hiding this comment.
Looks like rename is not needed here
Suggested change
| #[serde(rename = "hash", skip_serializing_if = "Option::is_none")] | |
| #[serde(skip_serializing_if = "Option::is_none")] |
| Ok(json) => json, | ||
| Err(e) => { | ||
| eprintln!("Failed to serialize to JSON: {e}"); | ||
| String::new() |
There was a problem hiding this comment.
Does it make sense to return an empty string if it fails to serialize? Seems better to return a Result<>.
| Ok(file) => Some(file), | ||
| Err(e) => { | ||
| eprintln!("Failed to deserialize from JSON: {e}"); | ||
| None |
There was a problem hiding this comment.
Same here, return a Result<>
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.
PR Summary
This change adds the configuration data for the File resource. This includes all the initial properties, and code to serialize/deserialize the configuration and the schema.
PR Context
The
Fileconfiguration will provide the user interface for configuring the File resource behavior.