fix: Schema Fields (#41)

* go mod

* fix schema fields

* replace README section

* Update main.go

Author: mgaeta

README.md

@@ -61,18 +61,23 @@ Usage:
   baton-github [command]
 
 Available Commands:
+  capabilities       Get connector capabilities
   completion         Generate the autocompletion script for the specified shell
   help               Help about any command
 
 Flags:
-  -f, --file string           The path to the c1z file to sync with ($BATON_FILE) (default "sync.c1z")
-  -h, --help                  help for baton-github
-      --instance-url string   The GitHub instance URL to connect to. ($BATON_INSTANCE_URL) (default "https://github.com")
-      --log-format string     The output format for logs: json, console ($BATON_LOG_FORMAT) (default "json")
-      --log-level string      The log level: debug, info, warn, error ($BATON_LOG_LEVEL) (default "info")
-      --orgs strings          Limit syncing to specific organizations. ($BATON_ORGS)
-      --token string          The GitHub access token used to connect to the GitHub API. ($BATON_TOKEN)
-  -v, --version               version for baton-github
+      --client-id string       The client ID used to authenticate with ConductorOne ($BATON_CLIENT_ID)
+      --client-secret string   The client secret used to authenticate with ConductorOne ($BATON_CLIENT_SECRET)
+  -f, --file string            The path to the c1z file to sync with ($BATON_FILE) (default "sync.c1z")
+  -h, --help                   help for baton-github
+      --instance-url string    The GitHub instance URL to connect to. (default "https://github.com") ($BATON_INSTANCE_URL)
+      --log-format string      The output format for logs: json, console ($BATON_LOG_FORMAT) (default "json")
+      --log-level string       The log level: debug, info, warn, error ($BATON_LOG_LEVEL) (default "info")
+      --orgs stringArray       Limit syncing to specific organizations. ($BATON_ORGS)
+  -p, --provisioning           This must be set in order for provisioning actions to be enabled ($BATON_PROVISIONING)
+      --ticketing              This must be set to enable ticketing support ($BATON_TICKETING)
+      --token string           The GitHub access token used to connect to the GitHub API. ($BATON_TOKEN)
+  -v, --version                version for baton-github
 
 Use "baton-github [command] --help" for more information about a command.
 ```

cmd/baton-github/config.go

@@ -1,40 +1,29 @@
 package main
 
 import (
-	"context"
-	"fmt"
-
 	"github.com/conductorone/baton-sdk/pkg/field"
-	"github.com/spf13/viper"
 )
 
 var (
 	accessTokenField = field.StringField(
 		"token",
-		field.WithDescription("The GitHub access token used to connect to the GitHub API. ($BATON_TOKEN)"),
+		field.WithDescription("The GitHub access token used to connect to the GitHub API."),
+		field.WithRequired(true),
 	)
-
-	orgsField = field.StringArrayField(
+	orgsField = field.StringSliceField(
 		"orgs",
-		field.WithDescription("Limit syncing to specific organizations. ($BATON_ORGS)"),
+		field.WithDescription("Limit syncing to specific organizations."),
 	)
 	instanceUrlField = field.StringField(
 		"instance-url",
-		field.WithDescription(`The GitHub instance URL to connect to. ($BATON_INSTANCE_URL) (default "https://github.com")`),
+		field.WithDescription(`The GitHub instance URL to connect to. (default "https://github.com")`),
 	)
-)
-
-// configurationFields defines the external configuration required for the connector to run.
-var configurationFields = []field.SchemaField{
-	accessTokenField,
-	orgsField,
-	instanceUrlField,
-}
-
-// validateConfig is run after the configuration is loaded, and should return an error if it isn't valid.
-func validateConfig(ctx context.Context, v *viper.Viper) error {
-	if v.GetString(accessTokenField.FieldName) == "" {
-		return fmt.Errorf("access token is missing")
+	// configuration defines the external configuration required for the connector to run.
+	configuration = field.Configuration{
+		Fields: []field.SchemaField{
+			accessTokenField,
+			orgsField,
+			instanceUrlField,
+		},
 	}
-	return nil
-}
+)

cmd/baton-github/main.go

@@ -25,10 +25,7 @@ func main() {
 		ctx,
 		"baton-github",
 		getConnector,
-		field.Configuration{
-			Fields: configurationFields,
-		},
-		nil,
+		configuration,
 	)
 	if err != nil {
 		fmt.Fprintln(os.Stderr, err.Error())
@@ -46,7 +43,8 @@ func main() {
 func getConnector(ctx context.Context, v *viper.Viper) (types.ConnectorServer, error) {
 	l := ctxzap.Extract(ctx)
 
-	if err := validateConfig(ctx, v); err != nil {
+	err := field.Validate(configuration, v)
+	if err != nil {
 		return nil, err
 	}
 

go.mod

@@ -5,7 +5,7 @@ go 1.21
 toolchain go1.22.3
 
 require (
-	github.com/conductorone/baton-sdk v0.2.8
+	github.com/conductorone/baton-sdk v0.2.14
 	github.com/deckarep/golang-set/v2 v2.6.0
 	github.com/google/go-github/v63 v63.0.0
 	github.com/grpc-ecosystem/go-grpc-middleware v1.4.0

go.sum

@@ -50,8 +50,8 @@ github.com/benbjohnson/clock v1.3.5/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZx
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
-github.com/conductorone/baton-sdk v0.2.8 h1:DLHTQXhl50A5AB0cbSoMOmzrUwwbpP7poCXI69Lcdtw=
-github.com/conductorone/baton-sdk v0.2.8/go.mod h1:cg5FyUcJnD7xK5SPbHe/KNpwUVVlpHJ9rnmd3UwxSkU=
+github.com/conductorone/baton-sdk v0.2.14 h1:6Z0n+yQv470XIO8T6DtkEiLP/2Gkz/lhFOzm//A8qJA=
+github.com/conductorone/baton-sdk v0.2.14/go.mod h1:cg5FyUcJnD7xK5SPbHe/KNpwUVVlpHJ9rnmd3UwxSkU=
 github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=