oracle / terraform-provider-oci

Terraform Oracle Cloud Infrastructure provider
https://www.terraform.io/docs/providers/oci/
Mozilla Public License 2.0
759 stars 675 forks source link

Documentation for data.oci_announcement_service_announcement_subscriptions is incorrect #1992

Open tomalok opened 10 months ago

tomalok commented 10 months ago

Affected Resource(s)

affected_resources = oci_announcement_service_announcement_subscriptions

Terraform Configuration Files

data oci_announcement_service_announcement_subscriptions these {
  compartment_id = "ocid..."
}

output DEBUG {
  value = data.oci_announcement_service_announcement_subscriptions.these.announcement_subscription_collection
}

Debug Output

DEBUG = {
          "items" = [ 
            { 
              "compartment_id" = "xxx" 
              "defined_tags" = { 
                "Oracle-Tags.CreatedBy" = "xxx" 
                "Oracle-Tags.CreatedOn" = "xxx" 
              } 
              "description" = "" 
              "display_name" = "xxx" 
              "filter_groups" = [] 
              "freeform_tags" = {} 
              "id" = "ocid1.announcementsubscription.xxx" 
              "lifecycle_details" = "" 
              "ons_topic_id" = "ocid1.onstopic.xxx" 
              "preferred_language" = "" 
              "preferred_time_zone" = "" 
              "state" = "ACTIVE" 
              "system_tags" = {} 
              "time_created" = "2023-09-14 22:04:29.068 +0000 UTC" 
              "time_updated" = "2023-09-14 22:04:29.068 +0000 UTC" 
            }, 
          ] 
        } 
}

Expected Behavior

Public documentation should call out the fact that announcement_subscription_collection is NOT a list, but it's a map containing an items key that contains the actual list of subscriptions we're looking for.

References

https://registry.terraform.io/providers/oracle/oci/latest/docs/data-sources/announcements_service_announcement_subscriptions

tf-oci-pub commented 10 months ago

Thank you for reporting the issue. We observed the affected resources are not provided in the description or it's incorrect. We request you to add it in issue description as mentioned in below format. Example: affected_resources = oci_core_instance , oci_core_instances

If it's not related to any particular resource then mention affected resource as terraform. Example: affected_resources = terraform

As this works through automation, request you to follow exact syntax.