Feature request : describe a field with multiple types

[maitredede]

Hello,

Is your feature request related to a problem? Please describe.
I would like to describe a field with type any that can be filled with a list of types (like a C/C++ union). Example :

type SubOne struct {
}
type SubTwo struct {
}
type SubThree struct {
}
type Root struct {
	Field any //can be SubOne, SubTwo or SubThree
}

Describe the solution you'd like
I don't know if it is possible (in the spec), but I would like to tell swag to add these types in the generated data, and see that the Root.Field can be any of the given types.

Describe alternatives you've considered
I have not considered alternatives yet. At leat a way to include types not directly referenced.

Additional context
N/A.

[sdghchj]

Since swag follows swagger OpenAPI 2.0, while oneOf works in OpenAPI 3.0.

An alternative proposal is:

type SubOne struct {
}
type SubTwo struct {
}
type SubThree struct {
}
type Root struct {
        // type enums in [SubOne,SubTwo,SubThree]
	Field any  `oneof: "SubOne,SubTwo,SubThree"`
}

then, tell the given types in the field comment and output SubOne,SubTwo,SubThree into the definitions.

[harsh-98]

it doens't work.

[krasi-georgiev]

now that the v2 branch seems to have initial support for open API v3, any chance to add it?

Just updated to v2.0.0 and trying this with

type RequestReply struct {
	Params  any             `json:"params,omitempty" oneof:"SendBundleArgs,CancelBundleArgs"`
}

type SendBundleArgs struct {
	BlockNumber string `json:"blockNumber,omitempty"`
}

type CancelBundleArgs struct {
	ReplacementUUID string `json:"replacementUuid,omitempty"`
}

swag init --v3.1

produced a swagger file with no type for those

2023/04/19 13:51:02 Generating handler.RequestReply
found schema with no Type, returning any

handler.RequestReply:
      properties:
        error:
          $ref: '#/components/schemas/handler.Error'
        id:
          type: string
        jsonrpc:
          type: string
        method:
          type: string
        params: {}
        result:
          type: string
      type: object

[Nerzal]

The oneof feature is not yet implemented on the V2 branch.
My current goal for the V2 branch is to get feature parity between master & v2 branch.
Also I have a list of bugs in the V2 branch.

But if you want to add new features there, feel free to do so :)