Skip to content

[Contribution Guide Update] Adding List guidance for sub-resources#32751

Open
promisinganuj wants to merge 2 commits into
hashicorp:mainfrom
promisinganuj:promisinganuj/subresources-list-guidance
Open

[Contribution Guide Update] Adding List guidance for sub-resources#32751
promisinganuj wants to merge 2 commits into
hashicorp:mainfrom
promisinganuj:promisinganuj/subresources-list-guidance

Conversation

@promisinganuj

Copy link
Copy Markdown
Collaborator

Community Note

  • Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
  • Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

Update the List Resource contributor guide to document how sub-resources should be handled.

This change adds a dedicated Handling List for Sub-resources section to contributing/topics/guide-list-resource.md and clarifies that:

  • sub-resources should be listed at the immediate parent scope
  • subscription_id and resource_group_name should not be exposed when the API only supports parent-scoped listing
  • the immediate parent resource ID should be used as the required input
  • the same pattern applies to deeper hierarchies

The new guidance is kept separate from the typed vs untyped implementation sections and includes a short implementation/doc reference example.

Testing

This is a documentation-only change.

PR Checklist

  • I have followed the guidelines in our Contributing Documentation.
  • I have checked to ensure there aren't other open Pull Requests for the same update/change.
  • I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
  • I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
  • I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
    For example: “resource_name_here - description of change e.g. adding property new_property_name_here

This is a (please select all that apply):

  • Bug Fix
  • New Feature (ie adding a service, resource, or data source)
  • Enhancement
  • Breaking Change

@promisinganuj promisinganuj requested review from a team, WodansSon and magodo as code owners July 9, 2026 00:44

@gerrytan gerrytan left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just a minor suggestion, otherwise this PR looks good. Thx for improving the contrib guide @promisinganuj .

Comment thread contributing/topics/guide-list-resource.md Outdated
Co-authored-by: Gerry Tan <2316198+gerrytan@users.noreply.github.com>
@promisinganuj promisinganuj requested a review from gerrytan July 9, 2026 01:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants