style: ensure we use proper types in metadata files

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

bindings/apns/metadata.yaml

@@ -34,7 +34,7 @@ authenticationProfiles:
         example: '"-----BEGIN PRIVATE KEY-----\nMIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQg..."'
 metadata:
   - name: development
-    type: boolean
+    type: bool
     required: false
     description: "The APNS environment is development or not"
     example: true

bindings/kubemq/metadata.yaml

@@ -37,13 +37,13 @@ metadata:
     description: The KubeMQ channel name.
     example: "my-channel"
   - name: pollMaxItems
-    type: int
+    type: number
     required: false
     description: The maximum number of items to poll.
     example: 10
     default: 1
   - name: pollTimeoutSeconds
-    type: int
+    type: number
     required: false
     description: The timeout in seconds for polling.
     example: 3600

bindings/rethinkdb/statechange/metadata.yaml

@@ -69,7 +69,7 @@ metadata:
     example: false
     default: false
   - name: numRetries
-    type: int
+    type: number
     required: false
     description: Number of times to retry queries on connection errors.
     example: 3

middleware/http/oauth2clientcredentials/metadata.yaml

@@ -53,7 +53,7 @@ metadata:
     description: "Specifies additional parameters for requests to the token endpoint"
     example: "param1=value1&param2=value2"
   - name: authStyle
-    type: integer
+    type: number
     required: false
     description: "Optionally specifies how the endpoint wants the client ID & client secret sent. 0: Auto-detect (tries both ways and caches the successful way), 1: Sends client_id and client_secret in POST body as application/x-www-form-urlencoded parameters, 2: Sends client_id and client_secret using HTTP Basic Authorization"
     example: 0

middleware/http/opa/metadata.yaml

@@ -16,39 +16,8 @@ metadata:
     type: string
     required: true
     description: "The Rego policy code that will be evaluated for each request. The policy package must be http and the policy must set data.http.allow"
-    example: |
-      package http
-
-      default allow = true
-
-      # Allow may also be an object and include other properties
-
-      # For example, if you wanted to redirect on a policy failure, you could set the status code to 301 and set the location header on the response:
-      allow = {
-          "status_code": 301,
-          "additional_headers": {
-              "location": "https://my.site/authorize"
-          }
-      } {
-          not jwt.payload["my-claim"]
-      }
-
-      # You can also allow the request and add additional headers to it:
-      allow = {
-          "allow": true,
-          "additional_headers": {
-              "x-my-claim": my_claim
-          }
-      } {
-          my_claim := jwt.payload["my-claim"]
-      }
-      jwt = { "payload": payload } {
-          auth_header := input.request.headers["Authorization"]
-          [_, jwt] := split(auth_header, " ")
-          [_, payload, _] := io.jwt.decode(jwt)
-      }
   - name: defaultStatus
-    type: integer
+    type: number
     required: false
     description: "The status code to return for denied responses"
     example: 403

middleware/http/opa/middleware.go

@@ -42,6 +42,7 @@ import (
 type Status int
 
 type middlewareMetadata struct {
+	// TODO: rego field needs to be updated to support the objects as input that the docs show for this field as inputs
 	Rego                          string   `json:"rego" mapstructure:"rego"`
 	DefaultStatus                 Status   `json:"defaultStatus,omitempty" mapstructure:"defaultStatus"`
 	IncludedHeaders               string   `json:"includedHeaders,omitempty" mapstructure:"includedHeaders"`

middleware/http/ratelimit/metadata.yaml

@@ -13,7 +13,7 @@ urls:
     url: https://docs.dapr.io/reference/components-reference/supported-middleware/middleware-rate-limit/
 metadata:
   - name: maxRequestsPerSecond
-    type: integer
+    type: number
     required: true
     description: "Maximum number of requests allowed per second"
     example: 100

nameresolution/hashicorp/consul/configuration.go

@@ -30,7 +30,7 @@ const defaultDaprPortMetaKey string = "DAPR_PORT" // default key for DaprPort in
 // that way breaking changes in future versions of the consul api cannot break user configuration.
 type intermediateConfig struct {
 	Client               *Config
-	Checks               []*AgentServiceCheck
+	Checks               []*AgentServiceCheck // TODO: update this to bring properly to metadata
 	Tags                 []string
 	Meta                 map[string]string
 	QueryOptions         *QueryOptions
@@ -43,7 +43,7 @@ type intermediateConfig struct {
 
 type configSpec struct {
 	Client               *consul.Config
-	Checks               []*consul.AgentServiceCheck
+	Checks               []*consul.AgentServiceCheck // TODO: update this to bring properly to metadata
 	Tags                 []string
 	Meta                 map[string]string
 	QueryOptions         *consul.QueryOptions

nameresolution/hashicorp/consul/metadata.yaml

@@ -56,7 +56,7 @@ authenticationProfiles:
         description: Path to the client private key file.
         example: "/path/to/client.key"
       - name: insecureSkipVerify
-        type: boolean
+        type: bool
         required: false
         description: Skip TLS certificate verification.
         example: false
@@ -95,50 +95,28 @@ metadata:
     example: "DAPR_PORT"
     default: "DAPR_PORT"
   - name: selfRegister
-    type: boolean
+    type: bool
     required: false
     description: Whether to register this service with Consul.
     example: true
     default: false
   - name: selfDeregister
-    type: boolean
+    type: bool
     required: false
     description: Whether to deregister this service from Consul on shutdown.
     example: true
     default: false
   - name: useCache
-    type: boolean
+    type: bool
     required: false
     description: Whether to use caching for service lookups.
     example: true
     default: false
   - name: tags
-    type: array
+    type: string
     required: false
     description: Tags to associate with the service registration.
-    example: ["dapr", "v1"]
-  - name: meta
-    type: object
-    required: false
-    description: Metadata to associate with the service registration.
-    example: |
-      {
-        "version": "v1",
-        "environment": "production"
-      }
-  - name: checks
-    type: array
-    required: false
-    description: Health checks to associate with the service registration.
-    example: |
-      [
-        {
-          "name": "dapr-health",
-          "http": "http://localhost:3500/health",
-          "interval": "10s",
-          "timeout": "5s"
-        }
-      ]
+    example: "dapr,v1"
   - name: namespace
     type: string
     required: false
@@ -166,13 +144,13 @@ metadata:
     description: The wait time for Consul queries.
     example: "5s"
   - name: allowStale
-    type: boolean
+    type: bool
     required: false
     description: Whether to allow stale results in queries.
     example: true
     default: false
   - name: requireConsistent
-    type: boolean
+    type: bool
     required: false
     description: Whether to require consistent reads in queries.
     example: false

pubsub/jetstream/metadata.yaml

@@ -95,12 +95,12 @@ metadata:
     description: The queue group name for load balancing.
     example: "my-queue-group"
   - name: startSequence
-    type: integer
+    type: number
     required: false
     description: The starting sequence number for message delivery.
     example: 1
   - name: startTime
-    type: integer
+    type: number
     required: false
     description: The starting time (Unix timestamp) for message delivery.
     example: 1640995200
@@ -117,17 +117,17 @@ metadata:
     description: The acknowledgment wait time.
     example: "30s"
   - name: maxDeliver
-    type: integer
+    type: number
     required: false
     description: The maximum number of message deliveries.
     example: 5
   - name: maxAckPending
-    type: integer
+    type: number
     required: false
     description: The maximum number of unacknowledged messages.
     example: 100
   - name: replicas
-    type: integer
+    type: number
     required: false
     description: The number of stream replicas.
     example: 3
@@ -138,7 +138,7 @@ metadata:
     example: false
     default: false
   - name: rateLimit
-    type: integer
+    type: number
     required: false
     description: The rate limit for message consumption.
     example: 1000
@@ -185,12 +185,12 @@ metadata:
     example: "single"
     default: "single"
   - name: backOff
-    type: array
+    type: string
     required: false
     description: The backoff configuration for message delivery for the consumer.
-    example: "[1s, 2s, 4s]"
+    example: "1s"
   - name: maxAckPending
-    type: integer
+    type: number
     required: false
     description: The maximum number of unacknowledged messages for the consumer.
     example: 100

pubsub/rocketmq/metadata.yaml

@@ -59,7 +59,7 @@ metadata:
     description: The RocketMQ name server domain.
     example: "rocketmq.example.com"
   - name: retries
-    type: integer
+    type: number
     required: false
     description: The number of retry attempts for sending messages.
     example: 3
@@ -102,17 +102,17 @@ metadata:
     example: false
     default: false
   - name: consumeMessageBatchMaxSize
-    type: integer
+    type: number
     required: false
     description: The maximum batch size for message consumption.
     example: 10
   - name: consumeConcurrentlyMaxSpan
-    type: integer
+    type: number
     required: false
     description: The maximum span for concurrent consumption.
     example: 10
   - name: maxReconsumeTimes
-    type: integer
+    type: number
     required: false
     description: The maximum number of reconsume times. -1 means 16 times.
     example: 10000
@@ -123,49 +123,49 @@ metadata:
     example: true
     default: false
   - name: consumeTimeout
-    type: integer
+    type: number
     required: false
     description: The consume timeout in minutes.
     example: 10
   - name: consumerPullTimeout
-    type: integer
+    type: number
     required: false
     description: The consumer pull timeout in milliseconds.
     example: 30
     default: 30
   - name: pullInterval
-    type: integer
+    type: number
     required: false
     description: The pull interval in minutes.
     example: 100
     default: 100
   - name: consumerBatchSize
-    type: integer
+    type: number
     required: false
     description: The consumer batch size.
     example: 10
   - name: pullBatchSize
-    type: integer
+    type: number
     required: false
     description: The pull batch size.
     example: 10
   - name: pullThresholdForQueue
-    type: integer
+    type: number
     required: false
     description: The pull threshold for queue.
     example: 100
   - name: pullThresholdForTopic
-    type: integer
+    type: number
     required: false
     description: The pull threshold for topic.
     example: 100
   - name: pullThresholdSizeForQueue
-    type: integer
+    type: number
     required: false
     description: The pull threshold size for queue.
     example: 10
   - name: pullThresholdSizeForTopic
-    type: integer
+    type: number
     required: false
     description: The pull threshold size for topic.
     example: 10
@@ -175,7 +175,7 @@ metadata:
     description: The content type for messages.
     example: "json"
   - name: sendTimeOutSec
-    type: integer
+    type: number
     required: false
     description: The send timeout in seconds.
     example: 10

state/couchbase/metadata.yaml

@@ -30,13 +30,13 @@ authenticationProfiles:
         example: "default"
 metadata:
   - name: numReplicasDurableReplication
-    type: integer
+    type: number
     required: false
     description: The number of replicas for durable replication.
     example: 1
     default: 0
   - name: numReplicasDurablePersistence
-    type: integer
+    type: number
     required: false
     description: The number of replicas for durable persistence.
     example: 1

state/etcd/metadata.yaml

@@ -62,7 +62,7 @@ metadata:
     example: "my_key_prefix_path"
     default: ""
   - name: maxTxnOps
-    type: integer
+    type: number
     required: false
     description: Maximum number of operations allowed in a transaction.
     example: 128

state/rethinkdb/metadata.yaml

@@ -63,7 +63,7 @@ metadata:
     example: false
     default: false
   - name: numRetries
-    type: int
+    type: number
     required: false
     description: Number of times to retry queries on connection errors.
     example: 3