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
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
Maybe this can help: swagger: ‘2.0’ info: version: 1.0.0 title: Bearer auth example description: > An example for how to use Bearer Auth with OpenAPI / Swagger 2.0. host: basic-auth-server.herokuapp.com schemes: – http – https securityDefinitions: Bearer: type: apiKey name: Authorization in: header description: >- Enter the token with the `Bearer: ` prefix, e.g. “Bearer … Read more
Swagger and Slate serve two different purposes. Swagger is an attempt at a standardized way of describing a RESTful API (similar, for example, to ApiBlueprint) Swagger is a JSON based API definition format, which allows for the description of REST APIs. ~ API Design Tooling From Swagger Slate, on the other hand is a pretty … Read more
Your usage of additionalProperties is correct and your model is correct. additionalProperties In Swagger/OpenAPI, hashmap keys are assumed to be strings, so the key type is not defined explicitly. additionalProperties define the type of hashmap values. So, this schema type: object additionalProperties: type: string defines a string-to-string map such as: { “en”: “English text”, “de”: … Read more
I believe the problem is the way you started the text on your description block. It must be indented one level to the right of description: Here’s an example of something that works for me: /{user-id}: get: summary: Facebook User description: | Displays all information about a Facebook user, depending on access privileges. Displays all … Read more
Your definition is perfectly fine. It’s a known issue with rendering recursive schemas in Swagger Editor and Swagger UI: https://github.com/swagger-api/swagger-ui/issues/3325 To work around the “Example Value” showing null/”string”/undefined instead of a recursive element, you can add a custom example to your schema: definitions: TreeNode: type: object properties: name: type: string description: The name of the … Read more
The error message is misleading. The actual error is that your path parameter is missing required: true. Path parameters are always required, so remember to add required: true to them.
Arnaud in the comments is correct that there are two separate questions here. Do you want to validate that your spec is a valid OpenAPI (fka. Swagger) spec You can Copy your spec to the online Swagger editor and it will throw errors. A quick dive through the source doesn’t tell me what it’s using … Read more