Add serial number query option to device data source

docs/data-sources/device.md

@@ -21,13 +21,13 @@ data "catalystcenter_device" "example" {
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
-### Required
+### Optional
 
 - `id` (String) The id of the object
+- `serial_number` (String) Device serial number
 
 ### Read-Only
 
 - `hostname` (String) Device hostname
 - `pid` (String) Device product ID
-- `serial_number` (String) Device serial number
 - `stack` (Boolean) Device is a stacked switch

gen/definitions/device.yaml

@@ -8,6 +8,7 @@ attributes:
     data_path: deviceInfo
     type: String
     mandatory: true
+    data_source_query: true
     description: Device serial number
     example: FOC12345678
   - model_name: stack

gen/generator.go

@@ -119,7 +119,6 @@ type YamlConfig struct {
 	PutIdIncludePath         string                `yaml:"put_id_include_path"`
 	PutIdQueryParam          string                `yaml:"put_id_query_param"`
 	PutNoId                  bool                  `yaml:"put_no_id"`
-	DataSourceNameQuery      bool                  `yaml:"data_source_name_query"`
 	MinimumVersion           string                `yaml:"minimum_version"`
 	DsDescription            string                `yaml:"ds_description"`
 	ResDescription           string                `yaml:"res_description"`
@@ -141,6 +140,7 @@ type YamlConfigAttribute struct {
 	Id                bool                  `yaml:"id"`
 	Reference         bool                  `yaml:"reference"`
 	QueryParam        bool                  `yaml:"query_param"`
+	DataSourceQuery   bool                  `yaml:"data_source_query"`
 	Mandatory         bool                  `yaml:"mandatory"`
 	WriteOnly         bool                  `yaml:"write_only"`
 	WriteChangesOnly  bool                  `yaml:"write_changes_only"`
@@ -270,19 +270,30 @@ func GetQueryParam(attributes []YamlConfigAttribute) YamlConfigAttribute {
 	return YamlConfigAttribute{}
 }
 
+// Templating helper function to return true if data source query attribute(s) are present
+func HasDataSourceQuery(attributes []YamlConfigAttribute) bool {
+	for _, attr := range attributes {
+		if attr.DataSourceQuery {
+			return true
+		}
+	}
+	return false
+}
+
 // Map of templating functions
 var functions = template.FuncMap{
-	"toGoName":      ToGoName,
-	"camelCase":     CamelCase,
-	"snakeCase":     SnakeCase,
-	"sprintf":       fmt.Sprintf,
-	"toLower":       strings.ToLower,
-	"path":          BuildPath,
-	"hasId":         HasId,
-	"hasReference":  HasReference,
-	"hasQueryParam": HasQueryParam,
-	"getId":         GetId,
-	"getQueryParam": GetQueryParam,
+	"toGoName":           ToGoName,
+	"camelCase":          CamelCase,
+	"snakeCase":          SnakeCase,
+	"sprintf":            fmt.Sprintf,
+	"toLower":            strings.ToLower,
+	"path":               BuildPath,
+	"hasId":              HasId,
+	"hasReference":       HasReference,
+	"hasQueryParam":      HasQueryParam,
+	"getId":              GetId,
+	"getQueryParam":      GetQueryParam,
+	"hasDataSourceQuery": HasDataSourceQuery,
 }
 
 func augmentAttribute(attr *YamlConfigAttribute) {

gen/schema/schema.yaml

@@ -24,7 +24,6 @@ id_from_attribute: bool(required=False) # Set to true if the ID is derived from
 put_id_include_path: str(required=False) # If PUT needs to have specific JSON path where ID should be inserted
 put_id_query_param: str(required=False) # If PUT needs to have specific query parameter where ID should be inserted
 put_no_id: bool(required=False) # Set to true if the PUT request does not require an ID
-data_source_name_query: bool(required=False) # Set to true if the data source supports name queries
 minimum_version: str(required=False) # Define a minimum supported version
 ds_description: str(required=False) # Define a data source description
 res_description: str(required=False) # Define a resource description
@@ -44,6 +43,7 @@ attribute:
   id: bool(required=False) # Set to true if the attribute is part of the ID
   reference: bool(required=False) # Set to true if the attribute is a reference being used in the path (URL) of the REST endpoint
   query_param: bool(required=False) # Set to true if the attribute is a query parameter and being used for GET, POST and PUT requests
+  data_source_query: bool(required=False) # Set to true if the attribute is an alternative query parameter for the data source
   mandatory: bool(required=False) # Set to true if the attribute is mandatory
   write_only: bool(required=False) # Set to true if the attribute is write-only, meaning we cannot read the value
   write_changes_only: bool(required=False) # Set to true if the attribute should only be written (included in PUT payload) if it has changed