style: update metadata files for the analyzer to be happy

Signed-off-by: Samantha Coyle <sam@diagrid.io>

.build-tools/pkg/metadataanalyzer/utils.go

@@ -120,7 +120,7 @@ func GenerateMetadataAnalyzer(contribRoot string, componentFolders []string, out
 			if methodFinderErr == nil {
 				methodFound = true
 			}
-		case "crypto":
+		case "cryptography":
 			method, methodFinderErr = getConstructorMethod("contribCrypto.SubtleCrypto", parsedFile)
 			if methodFinderErr == nil {
 				methodFound = true
@@ -136,6 +136,7 @@ func GenerateMetadataAnalyzer(contribRoot string, componentFolders []string, out
 				methodFound = true
 			}
 		}
+		// TODO: add conversation, nameresolution
 
 		if methodFound {
 			pkgs[packageName] = PkgInfo{

bindings/alicloud/oss/metadata.yaml

@@ -19,6 +19,11 @@ authenticationProfiles:
     description: |
       Authenticate using AliCloud access key credentials.
     metadata:
+      - name: accessKey
+        required: false
+        description: "The AliCloud access key"
+        example: '"your-access-key"'
+        sensitive: true
       - name: accessKeyID
         required: false
         description: "The AliCloud access key ID"

bindings/alicloud/tablestore/metadata.yaml

@@ -19,6 +19,11 @@ authenticationProfiles:
     description: |
       Authenticate using AliCloud access key credentials.
     metadata:
+      - name: accessKey
+        required: false
+        description: "The AliCloud access key"
+        example: '"your-access-key"'
+        sensitive: true
       - name: accessKeyID
         required: true
         description: "The AliCloud access key ID"

bindings/aws/dynamodb/metadata.yaml

@@ -41,4 +41,8 @@ metadata:
   - name: table
     required: true
     description: "The DynamoDB table name"
-    example: '"my-table"'
+    example: '"my-table"'
+  - name: endpoint
+    required: false
+    description: "The AWS DynamoDB endpoint"
+    example: '"https://dynamodb.us-east-1.amazonaws.com"'

bindings/aws/kinesis/metadata.yaml

@@ -59,4 +59,8 @@ metadata:
   - name: partitionKey
     required: false
     description: "The partition key for the Kinesis stream"
-    example: '"my-partition-key"'
+    example: '"my-partition-key"'
+  - name: endpoint
+    required: false
+    description: "The AWS Kinesis endpoint"
+    example: '"https://kinesis.us-east-1.amazonaws.com"'

bindings/aws/sqs/metadata.yaml

@@ -43,4 +43,8 @@ metadata:
   - name: queueName
     required: true
     description: "The SQS queue name"
-    example: '"my-queue"'
+    example: '"my-queue"'
+  - name: endpoint
+    required: false
+    description: "The AWS SQS endpoint"
+    example: '"https://sqs.us-east-1.amazonaws.com"'

bindings/cloudflare/queues/metadata.yaml

@@ -61,4 +61,8 @@ metadata:
     required: false
     description: "Timeout for network requests in seconds"
     example: '20'
-    default: '20'
+    default: '20'
+  - name: queueName
+    required: true
+    description: "The Cloudflare queue name"
+    example: '"my-queue"'

bindings/kubernetes/metadata.yaml

@@ -25,7 +25,7 @@ metadata:
     description: "The path to the kubeconfig file"
     example: '"~/.kube/config"'
     default: '"~/.kube/config"'
-  - name: resyncPeriodInSec
+  - name: resyncPeriod
     required: false
     type: duration
     description: "The resync period in seconds"

bindings/rethinkdb/statechange/metadata.yaml

@@ -84,4 +84,55 @@ metadata:
     required: false
     description: Whether to enable opentracing for queries.
     example: false
-    default: false 
+    default: false
+  - name: write_timeout
+    type: string
+    required: false
+    description: Write timeout duration."
+    example: "10s"
+  - name: read_timeout
+    type: string
+    required: false
+    description: Read timeout duration."
+    example: "10s"
+  - name: handshake_version
+    type: number
+    required: false
+    description: Handshake version for RethinkDB."
+    example: 1
+  - name: keep_alive_timeout
+    type: string
+    required: false
+    description: Keep alive period duration."
+    example: "30s"
+  - name: max_idle
+    type: number
+    required: false
+    description: Maximum number of idle connections."
+    example: 5
+  - name: auth_key
+    type: string
+    required: false
+    description: The authentication key for RethinkDB. This field is now deprecated."
+    example: "auth-key"
+    sensitive: true
+  - name: initial_cap
+    type: number
+    required: false
+    description: Initial connection pool capacity."
+    example: 5
+  - name: max_open
+    type: number
+    required: false
+    description: Maximum number of open connections."
+    example: 10
+  - name: discover_hosts
+    type: bool
+    required: false
+    description: Whether to discover hosts."
+    example: false
+  - name: node_refresh_interval
+    type: string
+    required: false
+    description: Node refresh interval duration."
+    example: "5m"

bindings/rethinkdb/statechange/statechange.go

@@ -107,7 +107,7 @@ func (b *Binding) Read(ctx context.Context, handler bindings.Handler) error {
 	go func() {
 		defer b.wg.Done()
 		for readCtx.Err() == nil {
-			var change interface{}
+			var change any
 			ok := cursor.Next(&change)
 			if !ok {
 				b.logger.Errorf("error detecting change: %v", cursor.Err())
@@ -149,7 +149,7 @@ func (b *Binding) Close() error {
 	return b.session.Close()
 }
 
-func metadataToConfig(cfg map[string]string, logger logger.Logger) (StateConfig, error) {
+func metadataToConfig(cfg map[string]string, _ logger.Logger) (StateConfig, error) {
 	c := StateConfig{}
 
 	// prepare metadata keys for decoding

bindings/twilio/sendgrid/metadata.yaml

@@ -52,4 +52,12 @@ metadata:
   - name: dynamicTemplateId
     required: false
     description: "The dynamic template ID"
-    example: '"your-template-id"'
+    example: '"your-template-id"'
+  - name: emailFromName
+    required: false
+    description: "The sender name"
+    example: '"John Doe"'
+  - name: emailToName
+    required: false
+    description: "The recipient name"
+    example: '"Jane Smith"'

lock/redis/metadata.yaml

@@ -19,11 +19,42 @@ authenticationProfiles:
     description: |
       Authenticate using Redis password.
     metadata:
+      - name: redisUsername
+        required: false
+        description: "The Redis username"
+        example: '"redis-user"'
       - name: redisPassword
         required: false
         sensitive: true
         description: "The Redis password"
         example: '"your-redis-password"'
+  - title: "Sentinel Authentication"
+    description: |
+      Authenticate using Redis Sentinel password.
+    metadata:
+      - name: sentinelUsername
+        required: false
+        description: "The Redis Sentinel username"
+        example: '"sentinel-user"'
+      - name: sentinelPassword
+        required: false
+        sensitive: true
+        description: "The Redis Sentinel password"
+        example: '"sentinel-password"'
+  - title: "TLS Authentication"
+    description: |
+      Authenticate using Redis TLS certificate.
+    metadata:
+      - name: clientCert
+        required: false
+        sensitive: true
+        description: "The Redis client certificate"
+        example: '"-----BEGIN CERTIFICATE-----\nXXX..."'
+      - name: clientKey
+        required: false
+        sensitive: true
+        description: "The Redis client key"
+        example: '"-----BEGIN PRIVATE KEY-----\nXXX..."'
 metadata:
   - name: redisHost
     required: true

pubsub/rocketmq/metadata.yaml

@@ -189,4 +189,14 @@ metadata:
     type: string
     required: false
     description: The message properties to pass to the application (comma-separated).
-    example: "UNIQ_KEY,MSG_ID" 
+    example: "UNIQ_KEY,MSG_ID"
+  - name: groupName
+    type: string
+    required: false
+    description: The consumer group name (deprecated, use consumerGroup instead).
+    example: "dapr-consumer-group"
+  - name: sendTimeOut
+    type: number
+    required: false
+    description: The send timeout in nanoseconds (deprecated, use sendTimeOutSec instead).
+    example: 10000000000 

state/gcp/firestore/metadata.yaml

@@ -80,4 +80,20 @@ metadata:
     required: false
     description: The entity kind (collection name) for storing state data.
     example: "dapr-state"
-    default: "DaprState" 
+    default: "DaprState"
+  - name: type
+    type: string
+    required: false
+    description: The type of service account.
+    example: "service_account"
+  - name: connectionEndpoint
+    type: string
+    required: false
+    description: The Firestore connection endpoint.
+    example: "https://firestore.googleapis.com"
+  - name: noIndex
+    type: bool
+    required: false
+    description: Whether to disable indexing for the entity.
+    example: false
+    default: false 

state/hazelcast/hazelcast.go

@@ -40,8 +40,8 @@ type Hazelcast struct {
 }
 
 type hazelcastMetadata struct {
-	HazelcastServers string `json:"hazelcastServers" mapstructure:"hazelcastServers,servers"`
-	HazelcastMap     string `json:"hazelcastMap" mapstructure:"hazelcastMap,map"`
+	HazelcastServers string `json:"hazelcastServers" mapstructure:"hazelcastServers"`
+	HazelcastMap     string `json:"hazelcastMap" mapstructure:"hazelcastMap"`
 }
 
 // NewHazelcastStore returns a new hazelcast backed state store.

state/hazelcast/metadata.yaml

@@ -9,12 +9,12 @@ urls:
   - title: Reference
     url: https://docs.dapr.io/reference/components-reference/supported-state-stores/setup-hazelcast/
 metadata:
-  - name: servers
+  - name: hazelcastServers
     type: string
     required: true
     description: Comma-separated list of Hazelcast servers.
     example: "localhost:5701"
-  - name: map
+  - name: hazelcastMap
     type: string
     required: true
     description: The Hazelcast map name.

state/oci/objectstorage/metadata.yaml

@@ -76,4 +76,9 @@ metadata:
     type: string
     required: true
     description: The OCID of the compartment containing the bucket.
-    example: "ocid1.compartment.oc1..example" 
+    example: "ocid1.compartment.oc1..example"
+  - name: namespace
+    type: string
+    required: false
+    description: The OCI namespace for the object storage.
+    example: "my-namespace"

state/oci/objectstorage/objectstorage.go

@@ -51,11 +51,9 @@ const (
 	privateKeyKey                      = "privateKey"
 	userKey                            = "userOCID"
 	bucketNameKey                      = "bucketName"
-	// TODO: this needs to be used or removed below!
-	metadataTTLKey          = "ttlInSeconds"
-	daprStateStoreMetaLabel = "dapr-state-store"
-	expiryTimeMetaLabel     = "expiry-time-from-ttl"
-	isoDateTimeFormat       = "2006-01-02T15:04:05"
+	daprStateStoreMetaLabel            = "dapr-state-store"
+	expiryTimeMetaLabel                = "expiry-time-from-ttl"
+	isoDateTimeFormat                  = "2006-01-02T15:04:05"
 )
 
 type StateStore struct {
@@ -81,7 +79,7 @@ type objectStoreMetadata struct {
 	InstancePrincipalAuthentication bool
 	ConfigFileAuthentication        bool
 
-	OCIObjectStorageClient *objectstorage.ObjectStorageClient
+	OCIObjectStorageClient *objectstorage.ObjectStorageClient `mapstructure:"-"`
 }
 
 type objectStoreClient interface {

state/rethinkdb/metadata.yaml

@@ -78,4 +78,55 @@ metadata:
     required: false
     description: Whether to enable opentracing for queries.
     example: false
-    default: false 
+    default: false
+  - name: write_timeout
+    type: string
+    required: false
+    description: Write timeout duration."
+    example: "10s"
+  - name: read_timeout
+    type: string
+    required: false
+    description: Read timeout duration."
+    example: "10s"
+  - name: handshake_version
+    type: number
+    required: false
+    description: Handshake version for RethinkDB."
+    example: 1
+  - name: keep_alive_timeout
+    type: string
+    required: false
+    description: Keep alive period duration."
+    example: "30s"
+  - name: max_idle
+    type: number
+    required: false
+    description: Maximum number of idle connections."
+    example: 5
+  - name: auth_key
+    type: string
+    required: false
+    description: The authentication key for RethinkDB."
+    example: "auth-key"
+    sensitive: true
+  - name: initial_cap
+    type: number
+    required: false
+    description: Initial connection pool capacity."
+    example: 5
+  - name: max_open
+    type: number
+    required: false
+    description: Maximum number of open connections."
+    example: 10
+  - name: discover_hosts
+    type: bool
+    required: false
+    description: Whether to discover hosts."
+    example: false
+  - name: node_refresh_interval
+    type: string
+    required: false
+    description: Node refresh interval duration."
+    example: "5m"