Merge pull request #59 from planetscale/fix-oneOf

Adhere to oneOf schema rules in PlanetScale source specification.

Author: Phani Raj

cmd/airbyte-source/spec.go

@@ -1,13 +1,15 @@
 package airbyte_source
 
 import (
-	"encoding/json"
 	"fmt"
 
-	"github.com/planetscale/airbyte-source/cmd/internal"
+	_ "embed"
 	"github.com/spf13/cobra"
 )
 
+//go:embed spec.json
+var staticSpec string
+
 func init() {
 	rootCmd.AddCommand(SpecCommand())
 }
@@ -17,79 +19,8 @@ func SpecCommand() *cobra.Command {
 		Use:   "spec",
 		Short: "Describes inputs needed for connecting to PlanetScale databases",
 		Run: func(cmd *cobra.Command, args []string) {
-			specMessage := internal.SpecMessage{
-				Type: "SPEC",
-				Spec: internal.Spec{
-					DocumentationURL: "https://planetscale.com/docs/integrations/airbyte",
-					SupportedDestinationSyncModes: []string{
-						"overwrite",
-					},
-					SupportsIncremental: true,
-					ConnectionSpecification: internal.ConnectionSpecification{
-						Schema:   "http://json-schema.org/draft-07/schema#",
-						Type:     "object",
-						Title:    "PlanetScale Source Spec",
-						Required: []string{"host", "database", "username", "password"},
-						Properties: internal.ConnectionProperties{
-							Host: internal.ConnectionProperty{
-								Description: "The host name of the database.",
-								Title:       "Host",
-								Type:        "string",
-								Order:       0,
-							},
-							Database: internal.ConnectionProperty{
-								Title:       "Database",
-								Description: "The PlanetScale database name.",
-								Type:        "string",
-								Order:       1,
-							},
-							Username: internal.ConnectionProperty{
-								Description: "The username which is used to access the database.",
-								Title:       "Username",
-								Type:        "string",
-								Order:       2,
-							},
-							Password: internal.ConnectionProperty{
-								Description: "The password associated with the username.",
-								Title:       "Password",
-								Type:        "string",
-								Order:       3,
-								IsSecret:    true,
-							},
-							Shards: internal.ConnectionProperty{
-								Description: "Comma separated list of shards you'd like to sync, by default all shards are synced.",
-								Title:       "Shards",
-								Type:        "string",
-								Order:       4,
-							},
-							Options: internal.CustomOptionsSpecification{
-								Order:       5,
-								Type:        "object",
-								Title:       "Custom configuration options",
-								Description: "Configuration options to customize PlanetScale source",
-								Options: []internal.CustomOptions{
-									{
-										Type:        "object",
-										Title:       "options",
-										Description: "options",
-										Properties: internal.CustomOptionsProperties{
-											DoNotTreatTinyIntAsBoolean: internal.ConnectionProperty{
-												Description: "If enabled, properties of type TinyInt(1) are output as TinyInt, and not boolean.",
-												Title:       "Do Not Treat TinyInt(1) as boolean",
-												Type:        "boolean",
-												Order:       5,
-											},
-										},
-									},
-								},
-							},
-						},
-					},
-				},
-			}
+			fmt.Fprintf(cmd.OutOrStdout(), "%s\n", staticSpec)
 
-			msg, _ := json.Marshal(specMessage)
-			fmt.Fprintf(cmd.OutOrStdout(), "%s\n", string(msg))
 		},
 	}
 }

cmd/airbyte-source/spec.json

@@ -0,0 +1 @@
+{"type":"SPEC","spec":{"documentationUrl":"https://planetscale.com/docs/integrations/airbyte","connectionSpecification":{"$schema":"http://json-schema.org/draft-07/schema#","title":"PlanetScale Source Spec","type":"object","required":["host","database","username","password"],"additionalProperties":false,"properties":{"host":{"description":"The host name of the database.","title":"Host","type":"string","order":0},"shards":{"description":"Comma separated list of shards you'd like to sync, by default all shards are synced.","title":"Shards","type":"string","order":4},"database":{"description":"The PlanetScale database name.","title":"Database","type":"string","order":1},"username":{"description":"The username which is used to access the database.","title":"Username","type":"string","order":2},"password":{"description":"The password associated with the username.","title":"Password","type":"string","order":3,"airbyte_secret":true},"options":{"type":"object","title":"Customize serialization","description":"The storage Provider or Location of the file(s) which should be replicated.","default":"Public Web","oneOf":[{"title":"tinyint(1) serialization","required":["do_not_treat_tiny_int_as_boolean"],"properties":{"storage":{"type":"string","const":"HTTPS"},"do_not_treat_tiny_int_as_boolean":{"type":"boolean","title":"Do not treat tinyint(1) as boolean","default":false,"description":"If enabled, properties of type TinyInt(1) are output as TinyInt, and not boolean."}}}]}}}}}

cmd/airbyte-source/spec_test.go

@@ -42,9 +42,6 @@ func (a *airbyteLogger) Log(level, message string) {
 	})
 }
 
-func (a *airbyteLogger) Spec(spec Spec) {
-}
-
 func (a *airbyteLogger) Catalog(catalog Catalog) {
 	a.recordEncoder.Encode(AirbyteMessage{
 		Type:    CATALOG,

cmd/internal/logger.go

@@ -160,78 +160,3 @@ type AirbyteMessage struct {
 	Record           *AirbyteRecord     `json:"record,omitempty"`
 	State            *AirbyteState      `json:"state,omitempty"`
 }
-
-type SpecMessage struct {
-	Type string `json:"type"`
-	Spec Spec   `json:"spec"`
-}
-
-type ConnectionPropertyHash struct {
-	Description string                             `json:"description"`
-	Title       string                             `json:"title"`
-	Type        string                             `json:"type"`
-	Order       int                                `json:"order"`
-	Options     []ConnectionPropertyHashProperties `json:"oneOf"`
-}
-
-type ConnectionPropertyHashProperties struct {
-	DoNotTreatTinyIntAsBoolean ConnectionProperty `json:"do_not_treat_tiny_int_as_boolean"`
-}
-
-type CustomOptionsSpecification struct {
-	Description string          `json:"description"`
-	Title       string          `json:"title"`
-	Type        string          `json:"type"`
-	Order       int             `json:"order"`
-	Options     []CustomOptions `json:"oneOf"`
-}
-
-type CustomOptions struct {
-	Description string                  `json:"description"`
-	Title       string                  `json:"title"`
-	Type        string                  `json:"type"`
-	Order       int                     `json:"order"`
-	Properties  CustomOptionsProperties `json:"properties"`
-}
-
-type CustomOptionsProperties struct {
-	DoNotTreatTinyIntAsBoolean ConnectionProperty `json:"do_not_treat_tiny_int_as_boolean"`
-}
-
-type ConnectionProperties struct {
-	Host     ConnectionProperty         `json:"host"`
-	Shards   ConnectionProperty         `json:"shards"`
-	Database ConnectionProperty         `json:"database"`
-	Username ConnectionProperty         `json:"username"`
-	Password ConnectionProperty         `json:"password"`
-	Options  CustomOptionsSpecification `json:"options"`
-}
-
-type ConnectionProperty struct {
-	Description string      `json:"description"`
-	Title       string      `json:"title"`
-	Type        string      `json:"type"`
-	Order       int         `json:"order"`
-	IsSecret    bool        `json:"airbyte_secret,omitempty"`
-	Minimum     int         `json:"minimum,omitempty"`
-	Maximum     int         `json:"maximum,omitempty"`
-	Default     interface{} `json:"default,omitempty"`
-}
-
-type ConnectionSpecification struct {
-	Schema               string               `json:"$schema"`
-	Title                string               `json:"title"`
-	Type                 string               `json:"type"`
-	Required             []string             `json:"required"`
-	AdditionalProperties bool                 `json:"additionalProperties"`
-	Properties           ConnectionProperties `json:"properties"`
-}
-
-type Spec struct {
-	DocumentationURL              string                  `json:"documentationUrl"`
-	ConnectionSpecification       ConnectionSpecification `json:"connectionSpecification"`
-	SupportsIncremental           bool                    `json:"supportsIncremental"`
-	SupportsNormalization         bool                    `json:"supportsNormalization"`
-	SupportsDBT                   bool                    `json:"supportsDBT"`
-	SupportedDestinationSyncModes []string                `json:"supported_destination_sync_modes"`
-}