[Feature request]: SwaggerIgnoreAttribute for FromForm requests

[jgarciadelanoceda]

Is your feature request related to a specific problem? Or an existing feature?

I have seen that you added this PR:
#2610

This PR adds the possibility of not loading certain properties in Swagger. With a previous version of the library I added a SchemaFilter and a OperationFilter to do this.

I needed to add a SchemaFilter for removing the property for a simple Json scenario, whereas for removing the property for a FromForm request I had to add the OperationFilter

Describe the solution you'd like

I will like to use the Built in attribute for the FromForm swagger property ignoring, and I like the solution to work also with the Microsoft.AspNetCore.Mvc.FromFormAttribute.

If you find this addition interesting I am happy to contribute to this project

Additional context

No response

[martincostello]

Could you provide some example code of what it is you're thinking about adding and how it would work? I'm not fully following what the actual changes would be to do what you're suggesting.

[jgarciadelanoceda]

I have just created a new repository to illustrate the behaviour. You will find 2 endpoints one with a FromBody and one with a FromForm.
The one with a FromForm with the OperationFilter SwaggerFromDataOperationFilter I was able to hide the property LocationId from the Swagger generation. You can guess that I want to hide it because the LocationId is for internal use only.

I want to make the new SwaggerIgnore attribute to also do not show the properties of a FromForm request.

[martincostello]

Could you illustrate it with a simple code snippet here in this issue comparing how it looks now with what you're envisioning it would become?

From looking at what I can see, it looks more like a bug and the existing attributes you've added to the two DTO properties should already be hidden by [SwaggerIgnore]?

[jgarciadelanoceda]

Hello,
Yes it could be seen as a Bug, but I leave you this decision to you :)
What I expect from the library is that if I mark a property with the [SwaggerIgnore] attribute to do not show this property in the openApi document. My final goal is to do not add the SwaggerFromDataOperationFilter to hide the LocationId property.

Right now without the OperationFilter the resulting document is:

{
	"multipart/form-data": {
		"schema": {
			"type": "object",
			"properties": {
				"client_id": {
					"type": "integer",
					"format": "int32"
				},
				"client_secret": {
					"type": "string"
				},
				"grant_type": {
					"type": "string"
				},
				"operational_country": {
					"type": "string"
				},
				"refresh_token": {
					"type": "string"
				},
				"client_location_id": {
					"type": "integer",
					"format": "int32"
				}
			}
		},
		"encoding": {
			"client_id": {
				"style": "form"
			},
			"client_secret": {
				"style": "form"
			},
			"grant_type": {
				"style": "form"
			},
			"operational_country": {
				"style": "form"
			},
			"refresh_token": {
				"style": "form"
			},
			"client_location_id": {
				"style": "form"
			}
		}
	}
}

I expect it to be:

{
	"multipart/form-data": {
		"schema": {
			"type": "object",
			"properties": {
				"client_id": {
					"type": "integer",
					"format": "int32"
				},
				"client_secret": {
					"type": "string"
				},
				"grant_type": {
					"type": "string"
				},
				"operational_country": {
					"type": "string"
				},
				"refresh_token": {
					"type": "string"
				}
			}
		},
		"encoding": {
			"client_id": {
				"style": "form"
			},
			"client_secret": {
				"style": "form"
			},
			"grant_type": {
				"style": "form"
			},
			"operational_country": {
				"style": "form"
			},
			"refresh_token": {
				"style": "form"
			}
		}
	}
}

This is the job that the OperationFilter does

[jgarciadelanoceda]

@martincostello Do you see this as a bug? Yo start implementing the solution

[martincostello]

If you're trying to use [SwaggerIgnore] on a property of an object and it's not working, then I would consider it a bug. If you're trying to use it in another manner, or you're considering adding further new public API for your use case, then that's a feature.

If you're considering adding new public API to Swashbuckle, please propose something so we can agree on a design before you spend any time on implementation. Otherwise, feel free to raise a PR to make this work at your convenience.