Add JSON Schema generation for V1 CRDs

Makefile

@@ -152,7 +152,7 @@ generate: $(CONTROLLER_GEN) generate-openapi generate-docs ## Generate code
 
 .PHONY: generate-docs
 generate-docs: manifests
-	go run ./hack/generate-docs.go
+	go run ./hack/generate-docs/generate-docs.go
 
 # Build the docker images, for local use
 .PHONY: docker-build

config/crd/bases/v1/datadoghq.com_datadogdashboards_v1alpha1.json

@@ -0,0 +1,247 @@
+{
+  "additionalProperties": false,
+  "description": "DatadogDashboard is the Schema for the datadogdashboards API",
+  "properties": {
+    "apiVersion": {
+      "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
+      "type": "string"
+    },
+    "kind": {
+      "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
+      "type": "string"
+    },
+    "metadata": {
+      "type": "object"
+    },
+    "spec": {
+      "additionalProperties": false,
+      "description": "DatadogDashboardSpec defines the desired state of DatadogDashboard",
+      "properties": {
+        "description": {
+          "description": "Description is the description of the dashboard.",
+          "type": "string"
+        },
+        "layoutType": {
+          "description": "LayoutType is the layout type of the dashboard.",
+          "type": "string"
+        },
+        "notifyList": {
+          "description": "NotifyList is the list of handles of users to notify when changes are made to this dashboard.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array",
+          "x-kubernetes-list-type": "set"
+        },
+        "reflowType": {
+          "description": "Reflowtype is the reflow type for a 'new dashboard layout' dashboard. Set this only when layout type is 'ordered'.\nIf set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto',\nwidgets should not have layouts.",
+          "type": "string"
+        },
+        "tags": {
+          "description": "Tags is a list of team names representing ownership of a dashboard.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array",
+          "x-kubernetes-list-type": "set"
+        },
+        "templateVariablePresets": {
+          "description": "TemplateVariablePresets is an array of template variables saved views.",
+          "items": {
+            "additionalProperties": false,
+            "description": "DashboardTemplateVariablePreset Template variables saved views.",
+            "properties": {
+              "name": {
+                "description": "The name of the variable.",
+                "type": "string"
+              },
+              "templateVariables": {
+                "description": "List of variables.",
+                "items": {
+                  "additionalProperties": false,
+                  "description": "DashboardTemplateVariablePresetValue Template variables saved views.",
+                  "properties": {
+                    "name": {
+                      "description": "The name of the variable.",
+                      "type": "string"
+                    },
+                    "values": {
+                      "description": "One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. Cannot be used in conjunction with `value`.",
+                      "items": {
+                        "type": "string"
+                      },
+                      "type": "array",
+                      "x-kubernetes-list-type": "set"
+                    }
+                  },
+                  "required": [
+                    "name"
+                  ],
+                  "type": "object"
+                },
+                "type": "array",
+                "x-kubernetes-list-map-keys": [
+                  "name"
+                ],
+                "x-kubernetes-list-type": "map"
+              }
+            },
+            "required": [
+              "name"
+            ],
+            "type": "object"
+          },
+          "type": "array",
+          "x-kubernetes-list-map-keys": [
+            "name"
+          ],
+          "x-kubernetes-list-type": "map"
+        },
+        "templateVariables": {
+          "description": "TemplateVariables is a list of template variables for this dashboard.",
+          "items": {
+            "additionalProperties": false,
+            "description": "DashboardTemplateVariable Template variable.",
+            "properties": {
+              "availableValues": {
+                "description": "The list of values that the template variable drop-down is limited to.",
+                "items": {
+                  "type": "string"
+                },
+                "type": "array"
+              },
+              "defaults": {
+                "description": "One or many default values for template variables on load. If more than one default is specified, they will be unioned together with `OR`. Cannot be used in conjunction with `default`.",
+                "items": {
+                  "type": "string"
+                },
+                "type": "array",
+                "x-kubernetes-list-type": "set"
+              },
+              "name": {
+                "description": "The name of the variable.",
+                "type": "string"
+              },
+              "prefix": {
+                "description": "The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "name"
+            ],
+            "type": "object"
+          },
+          "type": "array",
+          "x-kubernetes-list-map-keys": [
+            "name"
+          ],
+          "x-kubernetes-list-type": "map"
+        },
+        "title": {
+          "description": "Title is the title of the dashboard.",
+          "type": "string"
+        },
+        "widgets": {
+          "description": "Widgets is a JSON string representation of a list of Datadog API Widgets",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "status": {
+      "additionalProperties": false,
+      "description": "DatadogDashboardStatus defines the observed state of DatadogDashboard",
+      "properties": {
+        "conditions": {
+          "description": "Conditions represents the latest available observations of the state of a DatadogDashboard.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Condition contains details for one aspect of the current state of this API Resource.",
+            "properties": {
+              "lastTransitionTime": {
+                "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.",
+                "format": "date-time",
+                "type": "string"
+              },
+              "message": {
+                "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
+                "maxLength": 32768,
+                "type": "string"
+              },
+              "observedGeneration": {
+                "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
+                "format": "int64",
+                "minimum": 0,
+                "type": "integer"
+              },
+              "reason": {
+                "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
+                "maxLength": 1024,
+                "minLength": 1,
+                "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
+                "type": "string"
+              },
+              "status": {
+                "description": "status of the condition, one of True, False, Unknown.",
+                "enum": [
+                  "True",
+                  "False",
+                  "Unknown"
+                ],
+                "type": "string"
+              },
+              "type": {
+                "description": "type of condition in CamelCase or in foo.example.com/CamelCase.",
+                "maxLength": 316,
+                "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
+                "type": "string"
+              }
+            },
+            "required": [
+              "lastTransitionTime",
+              "message",
+              "reason",
+              "status",
+              "type"
+            ],
+            "type": "object"
+          },
+          "type": "array",
+          "x-kubernetes-list-map-keys": [
+            "type"
+          ],
+          "x-kubernetes-list-type": "map"
+        },
+        "created": {
+          "description": "Created is the time the dashboard was created.",
+          "format": "date-time",
+          "type": "string"
+        },
+        "creator": {
+          "description": "Creator is the identity of the dashboard creator.",
+          "type": "string"
+        },
+        "currentHash": {
+          "description": "CurrentHash tracks the hash of the current DatadogDashboardSpec to know\nif the Spec has changed and needs an update.",
+          "type": "string"
+        },
+        "id": {
+          "description": "ID is the dashboard ID generated in Datadog.",
+          "type": "string"
+        },
+        "lastForceSyncTime": {
+          "description": "LastForceSyncTime is the last time the API dashboard was last force synced with the DatadogDashboard resource",
+          "format": "date-time",
+          "type": "string"
+        },
+        "syncStatus": {
+          "description": "SyncStatus shows the health of syncing the dashboard state to Datadog.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}

config/crd/bases/v1/datadoghq.com_datadogmetrics_v1alpha1.json

@@ -0,0 +1,104 @@
+{
+  "additionalProperties": false,
+  "description": "DatadogMetric allows autoscaling on arbitrary Datadog query",
+  "properties": {
+    "apiVersion": {
+      "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
+      "type": "string"
+    },
+    "kind": {
+      "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
+      "type": "string"
+    },
+    "metadata": {
+      "type": "object"
+    },
+    "spec": {
+      "additionalProperties": false,
+      "description": "DatadogMetricSpec defines the desired state of DatadogMetric",
+      "properties": {
+        "externalMetricName": {
+          "description": "ExternalMetricName is reserved for internal use",
+          "type": "string"
+        },
+        "maxAge": {
+          "description": "MaxAge provides the max age for the metric query (overrides the default setting\n`external_metrics_provider.max_age`)",
+          "type": "string"
+        },
+        "query": {
+          "description": "Query is the raw datadog query",
+          "type": "string"
+        },
+        "timeWindow": {
+          "description": "TimeWindow provides the time window for the metric query, defaults to MaxAge.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "status": {
+      "additionalProperties": false,
+      "description": "DatadogMetricStatus defines the observed state of DatadogMetric",
+      "properties": {
+        "autoscalerReferences": {
+          "description": "List of autoscalers currently using this DatadogMetric",
+          "type": "string"
+        },
+        "conditions": {
+          "description": "Conditions Represents the latest available observations of a DatadogMetric's current state.",
+          "items": {
+            "additionalProperties": false,
+            "description": "DatadogMetricCondition describes the state of a DatadogMetric at a certain point.",
+            "properties": {
+              "lastTransitionTime": {
+                "description": "Last time the condition transitioned from one status to another.",
+                "format": "date-time",
+                "type": "string"
+              },
+              "lastUpdateTime": {
+                "description": "Last time the condition was updated.",
+                "format": "date-time",
+                "type": "string"
+              },
+              "message": {
+                "description": "A human readable message indicating details about the transition.",
+                "type": "string"
+              },
+              "reason": {
+                "description": "The reason for the condition's last transition.",
+                "type": "string"
+              },
+              "status": {
+                "description": "Status of the condition, one of True, False, Unknown.",
+                "type": "string"
+              },
+              "type": {
+                "description": "Type of DatadogMetric condition.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "status",
+              "type"
+            ],
+            "type": "object"
+          },
+          "type": "array",
+          "x-kubernetes-list-map-keys": [
+            "type"
+          ],
+          "x-kubernetes-list-type": "map"
+        },
+        "currentValue": {
+          "description": "Value is the latest value of the metric",
+          "type": "string"
+        }
+      },
+      "required": [
+        "currentValue"
+      ],
+      "type": "object"
+    }
+  },
+  "type": "object"
+}