Skip to content

added description to resolve_provider_doc_id tool#120

Merged
gautambaghel merged 5 commits intomainfrom
fix/improved-metadata
Jul 31, 2025
Merged

added description to resolve_provider_doc_id tool#120
gautambaghel merged 5 commits intomainfrom
fix/improved-metadata

Conversation

@gautambaghel
Copy link
Member

@gautambaghel gautambaghel commented Jul 31, 2025

PCI review checklist

  • I have documented a clear reason for, and description of, the change I am making.

  • If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.

  • If applicable, I've documented the impact of any changes to security controls.

    Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.

kartheek-hc
kartheek-hc previously approved these changes Jul 31, 2025
Copy link
Collaborator

@kartheek-hc kartheek-hc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, have a couple of questions and a suggestion

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances the resolve_provider_doc_id tool by adding description snippets to the documentation output. It extracts brief summaries from Terraform provider documentation to help users better understand what each document contains before selecting it.

Key changes:

  • Added description field to output format for both documentation handlers
  • Implemented getContentSnippet function to extract descriptions from provider documentation content
  • Updated output strings to include description information
Comments suppressed due to low confidence (1)

pkg/tools/resolve_provider_doc_id.go:242

  • The variable name 'desc' is too abbreviated and unclear. Consider using a more descriptive name like 'description' or 'descriptionText'.
	desc := ""

gautambaghel and others added 2 commits July 31, 2025 02:17
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
kartheek-hc
kartheek-hc previously approved these changes Jul 31, 2025
@gautambaghel gautambaghel merged commit 0caacaf into main Jul 31, 2025
31 checks passed
@gautambaghel gautambaghel deleted the fix/improved-metadata branch July 31, 2025 19:26
@R4M4NCHICK1
Copy link

PCI review checklist

  • I have documented a clear reason for, and description of, the change I am making.

  • If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.

  • If applicable, I've documented the impact of any changes to security controls.

    Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants