498 - docs - netapp-ontap_lun resource #516
Open
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
suhasbshekar
approved these changes
Jun 5, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR addresses Issue 498 by updating the documentation for the netapp-ontap_lun resource and introducing attribute validation that requires at least one of two attributes be provided.
- Updated attribute descriptions to provide clearer guidance on expected values.
- Added a configuration validator ensuring either the LUN path ("name") or the base name ("logical_unit") is set.
- Updated documentation examples and changelog to reflect these changes.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| internal/provider/storage/storage_lun_resource.go | Updated attribute descriptions and added a config validator for attribute validation. |
| docs/resources/lun.md | Revised attribute documentation and example configuration to align with the new validation requirements. |
| docs/data-sources/luns.md | Added the serial_number attribute to the read-only schema. |
| docs/data-sources/lun.md | Added the serial_number attribute to the read-only schema. |
| CHANGELOG.md | Updated changelog to document the docs update and attribute validation change. |
Comments suppressed due to low confidence (2)
internal/provider/storage/storage_lun_resource.go:164
- [nitpick] Consider expanding the doc comment for the ConfigValidators function to explain why at least one of 'name' or 'logical_unit' must be provided and how this validator impacts resource configuration.
// ConfigValidators validates entire resource configurations
internal/provider/storage/storage_lun_resource.go:83
- [nitpick] Consider updating this description to mention that this attribute is one of two options (the other being 'logical_unit') and that at least one of these must be provided, to reflect the logic in the config validator.
MarkdownDescription: "Path for the LUN you want to create or modify. Example of correct LUN path: /vol/vol1/lun1"
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.
Issue 498