Is security scheme mTLS supported?

[yuanhh]

Is define security scheme as mutualTLS supported?
I'm surveying possible ways to generate openapi 3.1.x documentations, but I need to define the security scheme as mTLS.

[vearutop]

Mutual TLS is supported by OpenAPI 3.1, and by this library too. Please check an example below:

	reflector := openapi31.Reflector{}
	securityName := "mTLS-example"

	// Declare security scheme.
	reflector.SpecEns().ComponentsEns().WithSecuritySchemesItem(
		securityName,
		openapi31.SecuritySchemeOrReference{
			SecurityScheme: (&openapi31.SecurityScheme{MutualTLS: &openapi31.MutualTLS{}}).
				WithDescription("My mutual TLS security."),
		},
	)

	oc, err := reflector.NewOperationContext(http.MethodGet, "/secure")
	require.NoError(t, err)
	oc.AddRespStructure(struct {
		Secret string `json:"secret"`
	}{})

	// Add security requirement to operation.
	oc.AddSecurity(securityName)

	// Add operation to schema.
	require.NoError(t, reflector.AddOperation(oc))

Here is how resulting schema looks like:

	assertjson.EqMarshal(t, `{
	  "openapi":"3.1.0","info":{"title":"","version":""},
	  "paths":{
		"/secure":{
		  "get":{
			"responses":{
			  "200":{
				"description":"OK",
				"content":{
				  "application/json":{
					"schema":{"properties":{"secret":{"type":"string"}},"type":"object"}
				  }
				}
			  }
			},
			"security":[{"mTLS-example":[]}]
		  }
		}
	  },
	  "components":{
		"securitySchemes":{
		  "mTLS-example":{"description":"My mutual TLS security.","type":"mutualTLS"}
		}
	  }
	}`, reflector.SpecSchema())

[yuanhh]

Thank you!