Handle required nullable types.

VERSION_OMICRON

@@ -1 +1 @@
-e44ad55
+4a0cb6b

internal/generate/types.go

@@ -7,6 +7,7 @@ package main
 import (
 	"fmt"
 	"os"
+	"slices"
 	"sort"
 	"strings"
 
@@ -393,7 +394,7 @@ func populateTypeTemplates(name string, s *openapi3.Schema, enumFieldName string
 	typeTpl := TypeTemplate{}
 
 	// TODO: remove workaround once no more type objects are empty
-	if sliceContains(emptyTypes(), name) {
+	if slices.Contains(emptyTypes(), name) {
 		bgpOT := getObjectType(s)
 		if bgpOT != "" {
 			panic("[ERROR] " + name + " is no longer an empty type. Remove workaround in exceptions.go")
@@ -474,6 +475,7 @@ func createTypeObject(schema *openapi3.Schema, name, typeName, description strin
 	}
 
 	schemas := schema.Properties
+	required := schema.Required
 	fields := []TypeFields{}
 	keys := sortedKeys(schemas)
 	for _, k := range keys {
@@ -511,8 +513,12 @@ func createTypeObject(schema *openapi3.Schema, name, typeName, description strin
 			}
 		}
 
-		// If a type is nullable we'll want a pointer
-		if sliceContains(nullable(), typeName) {
+		// Omicron includes fields that are both required and nullable:
+		// they can be set to a null value, but they must not be
+		// omitted. The sdk should present these fields to the user as
+		// optional, and serialize them to `null` if not provided.
+		isRequiredNullable := v.Value.Nullable && slices.Contains(required, k)
+		if (slices.Contains(nullable(), typeName) || isRequiredNullable) && !strings.HasPrefix(typeName, "*") {
 			typeName = fmt.Sprintf("*%s", typeName)
 		}
 
@@ -528,9 +534,9 @@ func createTypeObject(schema *openapi3.Schema, name, typeName, description strin
 		// TODO: Set omitzero on all types.
 		// https://github.com/oxidecomputer/oxide.go/issues/290
 		serInfo := fmt.Sprintf("`json:\"%s,omitempty\" yaml:\"%s,omitempty\"`", k, k)
-		if isNullableArray(v) {
+		if isNullableArray(v) || isRequiredNullable {
 			serInfo = fmt.Sprintf("`json:\"%s\" yaml:\"%s\"`", k, k)
-		} else if sliceContains(omitzeroTypes(), typeName) {
+		} else if slices.Contains(omitzeroTypes(), typeName) {
 			serInfo = fmt.Sprintf("`json:\"%s,omitzero\" yaml:\"%s,omitzero\"`", k, k)
 		}
 
@@ -658,7 +664,7 @@ func createOneOf(s *openapi3.Schema, name, typeName string) ([]TypeTemplate, []E
 	for _, v := range properties {
 		parts := strings.Split(v, "=")
 		key := parts[0]
-		if !sliceContains(typeKeys, key) {
+		if !slices.Contains(typeKeys, key) {
 			typeKeys = append(typeKeys, key)
 		}
 	}
@@ -712,7 +718,7 @@ func createOneOf(s *openapi3.Schema, name, typeName string) ([]TypeTemplate, []E
 				}
 
 				// We set the type of a field as "any" if every element of the oneOf property isn't the same
-				if sliceContains(genericTypes, prop) {
+				if slices.Contains(genericTypes, prop) {
 					field.Type = "any"
 				}
 

internal/generate/utils.go

@@ -234,21 +234,7 @@ func verifyNotAGoType(str string) string {
 func isNumericType(str string) bool {
 	numTypes := []string{"int", "int8", "int16", "int32", "int64", "uint", "uint8",
 		"uint16", "uint32", "uint64", "uintptr", "float32", "float64"}
-	for _, v := range numTypes {
-		if str == v {
-			return true
-		}
-	}
-	return false
-}
-
-func sliceContains[T comparable](s []T, str T) bool {
-	for _, a := range s {
-		if a == str {
-			return true
-		}
-	}
-	return false
+	return slices.Contains(numTypes, str)
 }
 
 func allItemsAreSame[T comparable](a []T) bool {