fix: Rename spec structs for better representation in JSON schema

Makefile

@@ -8,6 +8,8 @@ lint:
 
 .PHONY: gen-spec-schema
 gen-spec-schema:
+	# vendor for gen
+	go mod vendor
 	go run schemagen/main.go
 
 # All gen targets

csv/spec.go

@@ -6,12 +6,13 @@ import (
 	"github.com/invopop/jsonschema"
 )
 
-type Spec struct {
+// nolint:revive
+type CSVSpec struct {
 	SkipHeader bool   `json:"skip_header,omitempty"`
 	Delimiter  string `json:"delimiter,omitempty"`
 }
 
-func (Spec) JSONSchema() *jsonschema.Schema {
+func (CSVSpec) JSONSchema() *jsonschema.Schema {
 	properties := jsonschema.NewProperties()
 	properties.Set("skip_header", &jsonschema.Schema{
 		Type:        "boolean",
@@ -32,13 +33,13 @@ func (Spec) JSONSchema() *jsonschema.Schema {
 	}
 }
 
-func (s *Spec) SetDefaults() {
+func (s *CSVSpec) SetDefaults() {
 	if s.Delimiter == "" {
 		s.Delimiter = ","
 	}
 }
 
-func (s *Spec) Validate() error {
+func (s *CSVSpec) Validate() error {
 	if len(s.Delimiter) != 1 {
 		return fmt.Errorf("delimiter must be a single character")
 	}

csv/spec_test.go

@@ -8,7 +8,7 @@ import (
 )
 
 func TestSpec_JSONSchema(t *testing.T) {
-	schema, err := jsonschema.Generate(Spec{})
+	schema, err := jsonschema.Generate(CSVSpec{})
 	require.NoError(t, err)
 
 	jsonschema.TestJSONSchema(t, string(schema), []jsonschema.TestCase{

json/spec.go

@@ -2,18 +2,19 @@ package json
 
 import "github.com/invopop/jsonschema"
 
-type Spec struct{}
+// nolint:revive
+type JSONSpec struct{}
 
-func (Spec) JSONSchema() *jsonschema.Schema {
+func (JSONSpec) JSONSchema() *jsonschema.Schema {
 	return &jsonschema.Schema{
 		Description:          "CloudQuery JSON file output spec.",
 		Type:                 "object",
 		AdditionalProperties: jsonschema.FalseSchema, // "additionalProperties": false
 	}
 }
 
-func (*Spec) SetDefaults() {}
+func (*JSONSpec) SetDefaults() {}
 
-func (*Spec) Validate() error {
+func (*JSONSpec) Validate() error {
 	return nil
 }

json/spec_test.go

@@ -8,7 +8,7 @@ import (
 )
 
 func TestSpec_JSONSchema(t *testing.T) {
-	schema, err := jsonschema.Generate(Spec{})
+	schema, err := jsonschema.Generate(JSONSpec{})
 	require.NoError(t, err)
 
 	jsonschema.TestJSONSchema(t, string(schema), []jsonschema.TestCase{

parquet/client.go

@@ -4,7 +4,7 @@ type Options func(*Client)
 
 // Client is a parquet client.
 type Client struct {
-	spec Spec
+	spec ParquetSpec
 }
 
 func NewClient(options ...Options) (*Client, error) {
@@ -16,7 +16,7 @@ func NewClient(options ...Options) (*Client, error) {
 	return c, nil
 }
 
-func WithSpec(spec Spec) Options {
+func WithSpec(spec ParquetSpec) Options {
 	return func(c *Client) {
 		c.spec = spec
 	}

parquet/spec.go

@@ -2,19 +2,20 @@ package parquet
 
 import "github.com/invopop/jsonschema"
 
-type Spec struct{}
+// nolint:revive
+type ParquetSpec struct{}
 
-func (Spec) JSONSchema() *jsonschema.Schema {
+func (ParquetSpec) JSONSchema() *jsonschema.Schema {
 	return &jsonschema.Schema{
 		Description:          "CloudQuery Parquet file output spec.",
 		Type:                 "object",
 		AdditionalProperties: jsonschema.FalseSchema, // "additionalProperties": false
 	}
 }
 
-func (*Spec) SetDefaults() {
+func (*ParquetSpec) SetDefaults() {
 }
 
-func (*Spec) Validate() error {
+func (*ParquetSpec) Validate() error {
 	return nil
 }

parquet/spec_test.go

@@ -8,7 +8,7 @@ import (
 )
 
 func TestSpec_JSONSchema(t *testing.T) {
-	schema, err := jsonschema.Generate(Spec{})
+	schema, err := jsonschema.Generate(ParquetSpec{})
 	require.NoError(t, err)
 
 	jsonschema.TestJSONSchema(t, string(schema), []jsonschema.TestCase{

schema.go

@@ -20,9 +20,9 @@ func (FileSpec) JSONSchemaOptions() []cqjsonschema.Option {
 				return nil
 			}
 			return reflect.VisibleFields(reflect.TypeOf(struct {
-				CSVSpec     csv.Spec
-				JSONSpec    jsonfile.Spec
-				ParquetSpec parquet.Spec
+				CSVSpec     csv.CSVSpec
+				JSONSpec    jsonfile.JSONSpec
+				ParquetSpec parquet.ParquetSpec
 			}{}))
 		}
 		if r.AdditionalFields == nil {

schema.json

@@ -3,6 +3,24 @@
   "$id": "https://github.com/cloudquery/filetypes/v4/file-spec",
   "$ref": "#/$defs/FileSpec",
   "$defs": {
+    "CSVSpec": {
+      "properties": {
+        "skip_header": {
+          "type": "boolean",
+          "description": "Specifies if the first line of a file should be the header.",
+          "default": false
+        },
+        "delimiter": {
+          "type": "string",
+          "pattern": "^.$",
+          "description": "Character that will be used as the delimiter.",
+          "default": ","
+        }
+      },
+      "additionalProperties": false,
+      "type": "object",
+      "description": "CloudQuery CSV file output spec."
+    },
     "FileSpec": {
       "oneOf": [
         {
@@ -14,7 +32,7 @@
             "format_spec": {
               "oneOf": [
                 {
-                  "$ref": "#/$defs/Spec"
+                  "$ref": "#/$defs/CSVSpec"
                 },
                 {
                   "type": "null"
@@ -32,7 +50,7 @@
             "format_spec": {
               "oneOf": [
                 {
-                  "$ref": "#/$defs/Spec-1"
+                  "$ref": "#/$defs/JSONSpec"
                 },
                 {
                   "type": "null"
@@ -50,7 +68,7 @@
             "format_spec": {
               "oneOf": [
                 {
-                  "$ref": "#/$defs/Spec-2"
+                  "$ref": "#/$defs/ParquetSpec"
                 },
                 {
                   "type": "null"
@@ -75,13 +93,13 @@
             {
               "anyOf": [
                 {
-                  "$ref": "#/$defs/Spec"
+                  "$ref": "#/$defs/CSVSpec"
                 },
                 {
-                  "$ref": "#/$defs/Spec-1"
+                  "$ref": "#/$defs/JSONSpec"
                 },
                 {
-                  "$ref": "#/$defs/Spec-2"
+                  "$ref": "#/$defs/ParquetSpec"
                 }
               ]
             },
@@ -105,30 +123,12 @@
         "format"
       ]
     },
-    "Spec": {
-      "properties": {
-        "skip_header": {
-          "type": "boolean",
-          "description": "Specifies if the first line of a file should be the header.",
-          "default": false
-        },
-        "delimiter": {
-          "type": "string",
-          "pattern": "^.$",
-          "description": "Character that will be used as the delimiter.",
-          "default": ","
-        }
-      },
-      "additionalProperties": false,
-      "type": "object",
-      "description": "CloudQuery CSV file output spec."
-    },
-    "Spec-1": {
+    "JSONSpec": {
       "additionalProperties": false,
       "type": "object",
       "description": "CloudQuery JSON file output spec."
     },
-    "Spec-2": {
+    "ParquetSpec": {
       "additionalProperties": false,
       "type": "object",
       "description": "CloudQuery Parquet file output spec."

spec.go

@@ -37,9 +37,9 @@ type FileSpec struct {
 	// Empty or missing stands for no compression.
 	Compression CompressionType `json:"compression,omitempty" jsonschema:"enum=,enum=gzip"`
 
-	csvSpec     *csv.Spec
-	jsonSpec    *jsonfile.Spec
-	parquetSpec *parquet.Spec
+	csvSpec     *csv.CSVSpec
+	jsonSpec    *jsonfile.JSONSpec
+	parquetSpec *parquet.ParquetSpec
 }
 
 func (s *FileSpec) SetDefaults() {
@@ -87,13 +87,13 @@ func (s *FileSpec) UnmarshalSpec() error {
 
 	switch s.Format {
 	case FormatTypeCSV:
-		s.csvSpec = &csv.Spec{}
+		s.csvSpec = &csv.CSVSpec{}
 		return dec.Decode(s.csvSpec)
 	case FormatTypeJSON:
-		s.jsonSpec = &jsonfile.Spec{}
+		s.jsonSpec = &jsonfile.JSONSpec{}
 		return dec.Decode(s.jsonSpec)
 	case FormatTypeParquet:
-		s.parquetSpec = &parquet.Spec{}
+		s.parquetSpec = &parquet.ParquetSpec{}
 		return dec.Decode(s.parquetSpec)
 	default:
 		return fmt.Errorf("unknown format %s", s.Format)

spec_test.go

@@ -11,19 +11,19 @@ import (
 func TestSpecMethods(t *testing.T) {
 	testCases := []struct {
 		FileSpec         *FileSpec
-		preDefaultsCSV   *csv.Spec
-		preDefaultsJSON  *json.Spec
-		postDefaultsCSV  *csv.Spec
-		postDefaultsJSON *json.Spec
+		preDefaultsCSV   *csv.CSVSpec
+		preDefaultsJSON  *json.JSONSpec
+		postDefaultsCSV  *csv.CSVSpec
+		postDefaultsJSON *json.JSONSpec
 		expectError      bool
 	}{
 		{
 			FileSpec: &FileSpec{
 				Format:     FormatTypeCSV,
 				FormatSpec: map[string]any{},
 			},
-			preDefaultsCSV: &csv.Spec{},
-			postDefaultsCSV: &csv.Spec{
+			preDefaultsCSV: &csv.CSVSpec{},
+			postDefaultsCSV: &csv.CSVSpec{
 				SkipHeader: false,
 				Delimiter:  ",",
 			},
@@ -36,11 +36,11 @@ func TestSpecMethods(t *testing.T) {
 					"skip_header": true,
 				},
 			},
-			preDefaultsCSV: &csv.Spec{
+			preDefaultsCSV: &csv.CSVSpec{
 				SkipHeader: true,
 				Delimiter:  ",",
 			},
-			postDefaultsCSV: &csv.Spec{
+			postDefaultsCSV: &csv.CSVSpec{
 				SkipHeader: true,
 				Delimiter:  ",",
 			},
@@ -50,11 +50,11 @@ func TestSpecMethods(t *testing.T) {
 				Format:     FormatTypeCSV,
 				FormatSpec: map[string]any{},
 			},
-			preDefaultsCSV: &csv.Spec{
+			preDefaultsCSV: &csv.CSVSpec{
 				SkipHeader: false,
 				Delimiter:  "",
 			},
-			postDefaultsCSV: &csv.Spec{
+			postDefaultsCSV: &csv.CSVSpec{
 				SkipHeader: false,
 				Delimiter:  ",",
 			},
@@ -63,8 +63,8 @@ func TestSpecMethods(t *testing.T) {
 			FileSpec: &FileSpec{
 				Format: FormatTypeJSON,
 			},
-			preDefaultsJSON:  &json.Spec{},
-			postDefaultsJSON: &json.Spec{},
+			preDefaultsJSON:  &json.JSONSpec{},
+			postDefaultsJSON: &json.JSONSpec{},
 		},
 
 		{