I'm having trouble rendering an example request body in openapi. I've distilled it down to this simple example: openapi: 3.0.2 info: title: Test version: "1" paths: /Users: post: req...

Below is my api.yml: openapi: 3.0.0 info: title: 'AutoDelievery API' description: 'AutoDelievery API Documentation' termsOfService: 'https://www.yopmail.com' contact: name: yopmail url: 'htt...

I have the following OpenAPI definition: swagger: "2.0" info: version: 1.0.0 title: Simple API description: A simple API to learn how to write OpenAPI Specification schemes: - https host: no...

I am trying to add multiple examples for an Object property. The Swagger-Ui and Editor version that I am using are '{"swaggerEditor":"3.6.31/g10642b3c-dirty","swaggerUi&quo...

I am trying to get a multi-line literal in Swagger editor (awesome tool, by the way!). post: summary: Translate one or more identifiers description: | Translate one or more identifiers for one ...

I created an API spec from some JSON files and I am trying to test if the files validate against the API spec. There are some good tools to validate against JSON Schema, but I did not have chance...

I am getting the error below: Declared path parameter "imageId" needs to be defined as a path parameter at either the path or operation level This is the snapshot of my swagger definition '...

I'm using Swagger Editor with OpenAPI 3.0. I need to document a route which consists of uploading an image. When attempting to "Try it out", I don't get the file browser to choose the image to uplo...

I would like to format my Swagger API descriptions so that they are not simple paragraphs of text. Preferably, I'd like to add a small table to it. I did not find an online reference about text fo...

I am using Swagger Editor locally in my machine. When I start the Swagger Editor, it shows the spec for petstore by default at startup. I want to remove that and show a blank editor. Is there a w...

I'm using http://editor.swagger.io to design an API and I get an error which I don't know how to address: Schema error at paths['/employees/{employeeId}/roles'].get.parameters[0] should NOT have a...

I am writing Swagger documentation for an API, and one endpoint returns many nested objects and parameters. There is one returned array, however, which does not return regular parameters. Instead,...

I'm new to Swagger and using Swagger Editor running locally on my desktop to test an API. I'm not responsible for server configuration, and have no access to make changes. I have my security defini...

I'm using Swagger online editor. I create some model in definition Object: type: object properties: id: type: integer format: int32 name: type: string some_variable_to_exclude: type: str...

I am having a problem in defining the array of objects in swagger yaml. Swagger editor is giving an error everytime I try to define the type: array part of the yaml. I defined it, but it is not rig...

I was wondering if the, '😱 Could not render this component, see the console' (shown in first image) was an error message or if it can just be ignored (or maybe a warning that encompass a lot ...

I'm trying to document a model that always returns a custom response code and associated description. For a single HTTP response code, there could be multiple custom response codes. For example, a ...

I have a get call in my swagger REST API that needs to return a pdf file. There is no clear example / documentation on how to do this without causing a syntax error. responses: 200: description...

I am trying to convey that the authentication/security scheme requires setting a header as follows: Authorization: Bearer <token> This is what I have based on the swagger documentation: secu...

This is a simplified version of my OpenAPI 3.0 definition I'm viewing on the Swagger Editor online. I am trying to have the two responses for error codes 401 and 403, that share the same schema, sh...

I am trying to create API documentation using OpenAPI 3 but I get errors when I'm trying to use the allOf keyword in a parameter definition: components: parameters: idParam: name: id in: path ...

I'm building a set of APIs and webhooks. For the usual APIs, I have no problem writing the YAML file to document that in Swagger. However, I would like to also document the webhooks such as their r...

I want to insert the Swagger UI and Swagger Editor into my Angular project. So that it will look like this: http://editor.swagger.io/?docExpansion=none Thanks to the following instructions I was a...

I'm trying to define a POST method on a user class in the online Swagger editor. I want to be able to specify multiple fields in the request body and I would like the generated documentation to ref...

I'm currently using the Swagger Editor locally in my network. Is there any possibility that the editor can import a file directly from a git server? I'm defining an API and I would like to have th...