Add new section describing how to find module deprecation data using the API

[rkoron007]

Quick PR to add a section on how to use the Private Registry API to find details on a module's deprecation.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
terraform-docs-common	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 9, 2025 8:30pm

[robin-norwood]

lgtm!

[trujillo-adam]

A few suggestions on the wording. I think we should move this to this page, though, to start breaking the usage from the reference content: https://developer.hashicorp.com/terraform/cloud-docs/registry/manage-module-versions

[rkoron007]

I think we should move this to this page, though, to start breaking the usage from the reference content: https://developer.hashicorp.com/terraform/cloud-docs/registry/manage-module-versions

@trujillo-adam So, I disagree because of our current split in API v.s. non-API docs. The article you linked explains where to find deprecated data in the UI as part of the UI workflow of deprecating versions. However, if someone was looking for how to use the API to find deprecation data - this feels like where they would look because they are already presumably using the API to deprecate modules.

Does that make sense? We could put it on the the usage page and link to that section from the API reference page - but that feels a little less ideal then just putting the information on the API page itself.

However, I totally acknowledge this is just my two cents, so I don't feel super strongly and would be down to move it if you think that's better. 😅