Merge branch 'main' into add-missing-fields-to-network-types

Author: internet-diglett

.changelog/v0.5.0.toml

@@ -7,8 +7,8 @@ title = ""
 description = ""
 
 [[bugs]]
-title = ""
-description = ""
+title = "Type fields"
+description = "All arrays that are nullable in the API no longer have `omitempty` to avoid panics if unset. [#283](https://github.com/oxidecomputer/oxide.go/pull/283)"
 
 [[enhancements]]
 title = ""

internal/generate/exceptions.go

@@ -4,31 +4,16 @@
 
 package main
 
-// Returns a list of types that should not be omitted when empty
-// for json serialisation
-func omitemptyExceptions() []string {
-	return []string{
-		"[]VpcFirewallRuleUpdate",
-		"[]NameOrId",
-
-		// Networking Types
-		"[]AddressConfig",
-		"[]BgpPeerConfig",
-		"[]SwitchInterfaceConfigCreate",
-		"[]LinkConfigCreate",
-		"[]RouteConfig",
-	}
-}
-
 func emptyTypes() []string {
 	return []string{
 		"BgpMessageHistory",
 		"SwitchLinkState",
 	}
 }
 
-// TODO: Actually handle nullable fields properly
 func nullable() []string {
+	// TODO: This type has a nested required "Type" field, which hinders
+	// the usage of this type. Remove when this is fixed in the upstream API
 	return []string{
 		"InstanceDiskAttachment",
 		"TxEqConfig",

internal/generate/types.go

@@ -541,12 +541,12 @@ func createTypeObject(schema *openapi3.Schema, name, typeName, description strin
 
 		field.Name = strcase.ToCamel(k)
 		field.Type = typeName
+
 		serInfo := fmt.Sprintf("`json:\"%s,omitempty\" yaml:\"%s,omitempty\"`", k, k)
-		// There are a few types we do not want to omit if empty
-		// TODO: Keep an eye out to see if there is a way to identify all of
-		if sliceContains(omitemptyExceptions(), typeName) {
+		if isNullableArray(v) {
 			serInfo = fmt.Sprintf("`json:\"%s\" yaml:\"%s\"`", k, k)
 		}
+
 		field.SerializationInfo = serInfo
 
 		fields = append(fields, field)
@@ -724,6 +724,7 @@ func createOneOf(s *openapi3.Schema, name, typeName string) ([]TypeTemplate, []E
 			}
 
 			propertyName := strcase.ToCamel(prop)
+
 			// Avoids duplication for every enum
 			if !containsMatchFirstWord(parsedProperties, propertyName) {
 				field := TypeFields{
@@ -753,6 +754,15 @@ func createOneOf(s *openapi3.Schema, name, typeName string) ([]TypeTemplate, []E
 
 				enumFieldName = strcase.ToCamel(p.Value.Enum[0].(string))
 			}
+
+			// Enums can appear in a valid OpenAPI spec as a OneOf without necessarily
+			// being identified as such. If we find an object with a single property
+			// nested inside a OneOf we will assume this is an enum and modify the name of
+			// the struct that will be created out of this object.
+			// e.g. https://github.com/oxidecomputer/omicron/blob/158c0b205f23772dc6c4c97633fd1769cc0e00d4/openapi/nexus.json#L18637-L18682
+			if len(keys) == 1 && p.Value.Enum == nil {
+				enumFieldName = propertyName
+			}
 		}
 
 		// TODO: This is the only place that has an "additional name" at the end

internal/generate/utils.go

@@ -59,6 +59,10 @@ func isObjectArray(v *openapi3.SchemaRef) bool {
 	return false
 }
 
+func isNullableArray(v *openapi3.SchemaRef) bool {
+	return v.Value.Type.Is("array") && v.Value.Nullable
+}
+
 // formatStringType converts a string schema to a valid Go type.
 func formatStringType(t *openapi3.Schema) string {
 	var format string