For anyone using Swashbuckle with ASP.NET, you can use the following code to have the $ref construct put under the allOf (just like the : // do this wherever you are calling AddSwaggerGen() ArgBuilder.Services.AddSwaggerGen(opts => { opts.UseAllOfToExtendReferenceSchemas(); // add this line. }); Now if you have a model with two properties of the same type, … Read more
The solution that worked for me was to declare in @ApiProperty() the type with arrow function, like below: @Entity() export class Job { . . . @ManyToOne(type => Customer, customer => customer.jobs) @ApiProperty({ type: () => Customer }) customer: Customer; }
Okay, so based on the comments above, you want the following schema: { “definitions”: { “user”: { “type”: “object”, “required”: [ “name” ], “properties”: { “name”: { “type”: “string” }, “address”: { “type”: “array”, “items”: { “$ref”: “#/definitions/address” } } } }, “address”: { “type”: “object”, “properties”: { “type”: { “type”: “string”, “enum”: [ “home”, … Read more
I think enums can be defined only as object literals. Checkout this example it seems to explain quite well with an example. https://community.smartbear.com/t5/Swagger-Open-Source-Tools/Enum-of-defined-objects/m-p/198117/highlight/true#M988
responses: 200: description: Returns PDF schema: type: file Out of the options you gave, that’s the right option. Also, make sure to use produces: [application/pdf] If it fails for you, make sure you use the latest version of the editor. There was a bug related to the file type that was recently resolved.
I’m not sure to understand your question… If you are trying to define more than one body parameter for one operation, you can’t. As explained in swagger specification: Body […] there can only be one body parameter If you are trying to send a body with multiple parameters, add an object model in the definitions … Read more
You are using Swagger Codegen 2.x which does not support OpenAPI 3.0. You need to use Swagger Codegen 3.x instead. You can download the latest 3.x CLI JAR from Maven Central: https://mvnrepository.com/artifact/io.swagger.codegen.v3/swagger-codegen-cli Here’s a direct link to v. 3.0.20 CLI (the latest version as of the time of writing): https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.20/swagger-codegen-cli-3.0.20.jar Or if you prefer to … Read more
TL;DR: $ref siblings are supported (to an extent) in OpenAPI 3.1. In previous OpenAPI versions, any keywords alongside $ref are ignored. OpenAPI 3.1 Your definition will work as expected when migrated to OpenAPI 3.1. This new version is fully compatible with JSON Schema 2020-12, which allows $ref siblings in schemas. openapi: 3.1.0 … components: schemas: … Read more
In OpenAPI 3.0, header parameters are defined in the same way as in OpenAPI 2.0, except the type has been replaced with schema: paths: /post: post: parameters: – in: header name: X-username schema: type: string When in doubt, check out the Describing Parameters guide. But in Swagger 3.0.0 parameters are replaced by request bodies. This … Read more
It’s just an chrome extension which is causing this error. Try disabling your chrome extensions. In my case it was MetaMask extension.