[datadog_software_catalog] Fix software_catalog resource to handle empty API responses for deleted entities#3371
Merged
dd-mergequeue[bot] merged 1 commit intomasterfrom Dec 18, 2025
Conversation
christinexlee
approved these changes
Dec 16, 2025
fpighi
approved these changes
Dec 17, 2025
austindrenski
approved these changes
Dec 17, 2025
Contributor
Author
|
/merge |
|
View all feedbacks in Devflow UI.
The expected merge time in
|
paul-hf
pushed a commit
that referenced
this pull request
Dec 19, 2025
Handle entity not exists Co-authored-by: kruthi.vuppala <[email protected]>
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
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.
Summary
This PR fixes the
datadog_software_catalogresource to correctly handle the case when an entity no longer exists in the Software Catalog API.Fixes #3230
Problem
The Software Catalog API endpoint
GET /api/v2/catalog/entity?filter[ref]=<id>is a filtered collection endpoint that returns:includedarray when entities match the filterincludedarray when no entities match the filterThis is correct REST semantics for filtered collection endpoints (as opposed to direct resource lookups which return 404).
However, the Terraform provider was incorrectly:
This caused issues when:
terraform refreshorterraform planafter external deletionChanges
resource_datadog_software_catalog.goincludedarray → removes resource from Terraform state (drift detection)returnstatement after unmarshalling errorresource_datadog_software_catalog_test.gocheckCatalogEntityExiststo verify entity exists by checking response body (not just HTTP status)testAccCheckDatadogCatalogEntityDestroyto check for emptyincludedarray instead of 404 statusencoding/jsonimport for response parsingTesting
terraform planRelated
This follows proper REST API semantics where:
GET /entities?filter=xyz→ 200 with empty array (collection exists, filter yields nothing)GET /entities/{id}→ 404 if resource doesn't exist