Basically all my DTOs are generated with nullable fields like: id?: number;. How can I create non-nullable types for types which are not flagged as nullable. My DTO schema looks like this: "U...

My OpenAPI specification contains a lot of objects. According to the spec, a free-form object will by default have additionProperties:true. This is why when I use NSwag to generate a C# client, all...

For some reason handling Form Data and File Upload at the same time raises an error. from typing import Annotated from pydantic import BaseModel, StringConstraints, EmailStr class RouteBody(BaseMod...

I want to implement 2 Endpoints in my REST API: @PostMapping("/example") public ObjectResponse postObject(@RequestBody Example example){... //Add new Example to DB} @PutMapping("/ex...

There is some questions around this topic, but I dind't find the right way to do it. What I want is to define all parameters in a single place and reuse it with no need to write it again. I alread...

I am moving to Spring doc open Api and trying to hit the URL. I am getting the below error and logs from console. URL : http://localhost:8080/swagger-ui/index.html?url=v3/api-docs Logs : 2020-0...

I have a FlatDTO that needs to be mapped to a nested Response containing InfoData and MetaData The code for the response is generated by OpenAPI. So the below definitions can't be changed. package ...

I have a symfony project, where I use api-platform. I have an entity, and I have data providers for it. I am in trouble with definition of additional parameters for a collection endpoint. An entity...

I am using Spring Boot and Microservices stack using Spring Cloud APIGW. I am using the same code mentioned here: https://piotrminkowski.com/2020/02/20/microservices-api-documentation-with-springdo...

I'm trying to define a file download endpoint using the OpenAPI spec (v3). I am facing two problems. 1) the file is not being downloaded 2) within swagger-ui, the response body shows a message that...

We have a Swagger.json output by using AddOpenApiDocument (see below). A snippet from the swagger as below shows it returns a 200 response type of application/json. The schema part (which I am not ...

I am trying to generate OpenAPI (version 3.0.1) specification for my Java code. In order to achieve this I use Swagger Annotations (version 2.0.8) and Swagger Maven Plugin. I have a problem with E...

Is it possible to describe a HATEOAS REST API with OpenAPI? When I describe the API in HAL Format I would need to define three schemas for it (one for Request Payloads, one for Collection Resource ...

Following the example of an OpenAPI 3 definition: components: schemas: Foo: properties: string: type: string enumField: type: string enum: ['VALUE_1', 'VALUE_2'] Bar: properties: enumFi...

I want to use Arrow type in FastAPI response because I am using it already in SQLAlchemy model (thanks to sqlalchemy_utils). I prepared a small self-contained example with a minimal FastAPI app. I ...

I've managed to generate the interfaces from a .yaml open-api descriptor file, but, as in the question title, I'd love to change the response type of those interfaces from ResponseEntity to my own ...

I'm using Swashbuckle (6.1.1) in a .Net 5.0 Web API. I'm still learning, but I'd like to implement a class where certain properties only are valid when 'reading' with a GET, and other properties wh...

I'm building a fuzzer for a REST API that has an OpenAPI (Swagger) definition. I want to test all available path from the OpenAPI definition, generate data to test the servers, analyse responses c...

Is there a way to generate OpenAPI v3 specification from go source code? Let's say I have a go API like the one below and I'd like to generate the OpenAPI specification (yaml file) from it. Somethi...

I'm switching from Springfox 3.0 to OpenAPI 3.0 + Springdoc-openapi. In Springfox the tag order is alphabetical, but in Springdoc's Swagger UI, the order appears to be random. How do I control the ...

I use OpenAPI spec to generate Java POJOs. What do I need to specify in Open API yaml to generate the equivalent of below POJO ? ... @JsonIgnore public String ignoredProperty; ... I have the yaml ...

The @nestjs/swagger doc describes here that defining an extra model should be done this way: @ApiExtraModels(ExtraModel) export class CreateCatDto {} But what is ExtraModel here ? The doc is not...

There seems to be number of Python libraries dedicated to validate the correctness of an OpenAPI schema. While this might be useful, I can frankly just write my OpenAPI schema here it in https://ed...

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...

First to have a clear idea of the OpenAPI Specification itself is, let's see how it is defined on its official website (https://github.com/OAI/OpenAPI-Specification): The goal of The OpenAPI Speci...