Skip to content

openapi3gen: Fix issue with separate component generated for time.Time#1052

Merged
fenollp merged 2 commits intogetkin:masterfrom
d1vbyz3r0:master
Feb 10, 2025
Merged

openapi3gen: Fix issue with separate component generated for time.Time#1052
fenollp merged 2 commits intogetkin:masterfrom
d1vbyz3r0:master

Conversation

@d1vbyz3r0
Copy link
Copy Markdown
Contributor

openapi3gen generates separate schema component for time.Time properies, when ExportComponentSchemas opt provided.
Here is a small example:

type Some struct {
	Name      string
	CreatedAt time.Time
}

func main() {
	schemas := make(openapi3.Schemas)
	g := openapi3gen.NewGenerator(
		openapi3gen.UseAllExportedFields(),
		openapi3gen.CreateComponentSchemas(openapi3gen.ExportComponentSchemasOptions{
			ExportComponentSchemas: true,
		}),
	)

	ref, err := g.NewSchemaRefForValue(&Some{}, schemas)
	if err != nil {
		panic(err)
	}

	schema, _ := json.MarshalIndent(ref, "", "  ")
	fmt.Println(string(schema))
}

Expected output is:

{
  "properties": {
    "CreatedAt": {
      "format": "date-time",
      "type": "string"
    },
    "Name": {
      "type": "string"
    }
  },
  "type": "object"
}

But for now generator produces following:

{
  "properties": {
    "CreatedAt": {
      "$ref": "#/components/schemas/Time"
    },
    "Name": {
      "type": "string"
    }
  },
  "type": "object"
}

…e fields, when ExportComponentSchemas opt provided
@fenollp
Copy link
Copy Markdown
Collaborator

fenollp commented Feb 10, 2025

Please add your example as a test and we should be good to go.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants