Skip to content

Support nullable slice elements and map values #2185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mromaszewicz merged 1 commit into from
Feb 17, 2026
+47 −2
Merged

Support nullable slice elements and map values #2185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion pkg/codegen/codegen_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,14 @@ type GetTestByNameResponse struct {
assert.Contains(t, code, "Top *int `form:\"$top,omitempty\" json:\"$top,omitempty\"`")
assert.Contains(t, code, "func (c *Client) GetTestByName(ctx context.Context, name string, params *GetTestByNameParams, reqEditors ...RequestEditorFn) (*http.Response, error) {")
assert.Contains(t, code, "func (c *ClientWithResponses) GetTestByNameWithResponse(ctx context.Context, name string, params *GetTestByNameParams, reqEditors ...RequestEditorFn) (*GetTestByNameResponse, error) {")
assert.Contains(t, code, "DeadSince *time.Time `json:\"dead_since,omitempty\" tag1:\"value1\" tag2:\"value2\"`")
assert.Contains(t, code, "FavouriteBirds *[]*string `json:\"favourite_birds,omitempty\"`")
assert.Contains(t, code, "DetestedBirds *[]string `json:\"detested_birds,omitempty\"`")
assert.Contains(t, code, "SlicedBirds []string `json:\"sliced_birds\"`")
assert.Contains(t, code, "ForgettableBirds *map[string]*string `json:\"forgettable_birds,omitempty\"`")
assert.Contains(t, code, "MemorableBirds *map[string]string `json:\"memorable_birds,omitempty\"`")
assert.Contains(t, code, "VeryMemorableBirds map[string]string `json:\"very_memorable_birds\"`")
assert.Contains(t, code, "DeadSince *time.Time `json:\"dead_since,omitempty\" tag1:\"value1\" tag2:\"value2\"`")
assert.Contains(t, code, "VeryDeadSince time.Time `json:\"very_dead_since\"`")
assert.Contains(t, code, "type EnumTestNumerics int")
assert.Contains(t, code, "N2 EnumTestNumerics = 2")
assert.Contains(t, code, "type EnumTestEnumNames int")
Expand Down
10 changes: 9 additions & 1 deletion pkg/codegen/schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,6 +602,9 @@ func oapiSchemaToGoType(schema *openapi3.Schema, path []string, outSchema *Schem
if err != nil {
return fmt.Errorf("error generating type for array: %w", err)
}

var itemPrefix string

if (arrayType.HasAdditionalProperties || len(arrayType.UnionElements) != 0) && arrayType.RefType == "" {
// If we have items which have additional properties or union values,
// but are not a pre-defined type, we need to define a type
Expand All @@ -618,8 +621,13 @@ func oapiSchemaToGoType(schema *openapi3.Schema, path []string, outSchema *Schem

arrayType.RefType = typeName
}

if arrayType.OAPISchema != nil && arrayType.OAPISchema.Nullable {
itemPrefix = "*"
}

outSchema.ArrayType = &arrayType
outSchema.GoType = "[]" + arrayType.TypeDecl()
outSchema.GoType = "[]" + itemPrefix + arrayType.TypeDecl()
outSchema.AdditionalTypes = arrayType.AdditionalTypes
outSchema.Properties = arrayType.Properties
outSchema.DefineViaAlias = true
Expand Down
30 changes: 30 additions & 0 deletions pkg/codegen/test_spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,15 +164,45 @@ components:
format: date-time

CatDead:
required:
- sliced_birds
- very_dead_since
- very_memorable_birds
properties:
name:
type: string
favourite_birds:
type: array
items:
type: string
nullable: true
detested_birds:
type: array
items:
type: string
sliced_birds:
type: array
items:
type: string
forgettable_birds:
additionalProperties:
type: string
nullable: true
memorable_birds:
additionalProperties:
type: string
very_memorable_birds:
additionalProperties:
type: string
dead_since:
type: string
format: date-time
x-oapi-codegen-extra-tags:
tag1: value1
tag2: value2
very_dead_since:
type: string
format: date-time
cause:
type: string
enum: [ car, dog, oldage ]
Expand Down