Set $ref in ISchemaFilter

[Hendrik Wunderlich (wunderlichh)]

Hi, i asked a question on the github.com/domaindrivendev/Swashbuckle.AspNetCore repository and been referred to this repository.

My problem is that the OpenApiSchema class no longer has a Reference property, which means I can no longer replace the schema with a reference to an existing schema.

My Use-Case is the following: i have a couple of DTO classes wich contains some string properties. Those properties are annotated using a custom attribute which tells the schema filter to replace the type from string to that of an special domain enumeration. This is done to not have to deal with my custom enum type & ASP.NET Core model binding and have a strongly typed value at the client side (i auto generate the TS client code).

Edit: Ok i guess the new way to reference a schema is to use the AllOf property an set only a single element? While this certainly works for my use-case the generated open api document is quite different. Is this really how this should be done?

[..]
if (schema is OpenApiSchema s)
{
  s.AllOf = [schemaRef];
}
[..]

// Now
"status": {
  "minLength": 1,
  "type": "string",
  "allOf": [
    {
      "$ref": "#/components/schemas/AuftragStatus"
    }
  ]
},

// Before
"status": {
  "$ref": "#/components/schemas/AuftragStatus"
},

[Vincent Biret (baywet)]

Hi Hendrik Wunderlich (@wunderlichh)

Thank you for using the SDK and for reaching out.

It really depends on your use case, and the additional context from the code.

Essentially:

• If you use OpenApiSchemaReference, you'll get a $ref at the root, and some of the properties are settable (based on the JSON schema semantics)
• if you use OpenApiSchema, all properties are settable, and the properties that are of type IOpenApiSchema, can either take a schema, or a schema reference, depending on your use case.

Let me know if you have any additional comments or questions.