Skip to content

Conversation

@nicsnet
Copy link
Member

@nicsnet nicsnet commented Dec 3, 2025

What

This PR adds a new entry for the API reference. It adds the documentation for these new APIs:

Method Path Action
GET /organizations/:organization_name/registry-components List Stack component configurations for an organization.
POST /organizations/:organization_name/registry-components Create a Stack component configuration (with or without VCS).
POST /api/v2/registry-components/:component_id/versions Create a new version of a Stack component configuration.
PUT https://archivist.terraform.io/v1/object/<UNIQUE OBJECT ID> Upload a Stack component configuration version archive.
GET /api/v2/registry-components/:component_id Get details of a Stack component configuration.
DELETE /api/v2/registry-components/:component_id/versions/:version Delete a specific version of a Stack component configuration.
DELETE /api/v2/registry-components/:component_id Delete an entire Stack component configuration.

Why

This is a new feature for the HCP Terraform private registry. It makes stacks configurations reusable across organizations.

Screenshots

image

Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

  • Description links to related pull requests or issues, if any.

Content

  • Redirects have been added to content/terraform-docs-common/redirects.jsonc for moved, renamed, or deleted pages.
  • API documentation and the API Changelog have been updated.
  • Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
  • Pages with related content are updated and link to this content when appropriate.
  • Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
  • New pages have metadata (page name and description) at the top.
  • New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
  • New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
  • UI elements (button names, page names, etc.) are bolded.
  • The Vercel website preview successfully deployed.

Reviews

  • I or someone else reviewed the content for technical accuracy.
  • I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 3, 2025

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Thu Dec 18 02:56:00 UTC 2025
Unified Docs API ✅ Ready (Inspect) Visit Preview Thu Dec 18 02:51:44 UTC 2025

@github-actions
Copy link
Contributor

github-actions bot commented Dec 3, 2025

Broken Link Checker

No broken links found! 🎉

Copy link
Contributor

@rkoron007 rkoron007 left a comment

Choose a reason for hiding this comment

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

Hello! So sorry for the delay in reviewing this, and apologies for the style nits. I left a few bigger comments about reorganizing content that are more important than those style nits for sure! Please let me know if anything is unclear, or feel free to push back on any suggestion that doesn't feel good to you!

Copy link
Contributor

@rkoron007 rkoron007 left a comment

Choose a reason for hiding this comment

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

Went through and added all the changes I suggested and this is looking great and ready to go in my opinion!

@rkoron007 rkoron007 marked this pull request as ready for review December 13, 2025 00:34
@rkoron007 rkoron007 requested review from a team as code owners December 13, 2025 00:34
@rkoron007
Copy link
Contributor

This is the API part of the work, the other usage docs are in this PR: #1417

@rkoron007 rkoron007 changed the title [draft] HCP Terraform Docs: API reference stacks in the registry HCP Terraform Docs: API reference stacks in the registry Dec 15, 2025
@rkoron007 rkoron007 merged commit 83cf0bd into main Dec 18, 2025
15 checks passed
@rkoron007 rkoron007 deleted the nicsnet/add-component-configurations-api-docs branch December 18, 2025 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants