Category "openapi"

How to define a header parameter's default value is in OpenAPI 3.0

I have an endpoint that accepts a PUT without a body. The PUT causes an event to trigger on the backend, and our API design team decided that PUT was the best R

Can I generate an Open API 3 Python Flask server?

From http://editor.swagger.io/ with swagger 2.0 I am able to select: Generate Server-->python-flask and generate a python server that I can deploy and use.

How to document default None/null in OpenAPI/Swagger using FastAPI?

Using a ORM, I want to do a POST request letting some fields with a null value, which will be translated in the database for the default value specified there.

Swagger Codegen generates nested Lists by using array as response for spring server stub

I am using the cloud SwaggerHub Codegen Editor and wrote API like this: /foodlogs: get: tags: - foodlog summary: searches food logs operationId: searc

SpringDoc openAPI tool not scanning for APIs in Spring Boot Project

I'm having trouble getting this to work. I've started with a working SpringBoot (v2.2.2) app with a working @RestController. To get springdoc to work I've inclu

Can I suppress the default Optional<NativeWebRequest> getRequest() that OpenAPI generates into interfaces?

I have an OpenAPI 3.0 file that specifies two REST resources with operations, let's say: openapi: 3.0.0 [...] paths: /a: post: [...] /b post:

Springboot 2.6.7, springdoc 1.6.8 i need to have v3/api-docs and v1/api-docs

I'm trying to upgrade my springboot app from 2.5.9 to 2.6.7 so i needed to migrate from springfox 3.0.0 to springdoc 1.6.8 because of many compatibility issues.

Is an OpenAPI path with multiple variables in the same segment valid?

Is the following valid? GET image/{id}/{palette}.{file_extension} I want to be able to do something like this: example: GET image/1/falsecolor.jpg GET image/4/a

How to generate a PDF or markup from OpenAPI 3.0?

I have an OpenAPI 3.0 spec and I want to generate a PDF out of it so that it can be given to the end users. Currently, tools like swagger-spec-to-pdf or swagge

Freeform subobject in json-schema

I am drafting an API documentation with swagger.io and is trying to make it fit to our use case. The system is going to receive and process data from all source

How to define enum mapping in OpenAPI?

I am designing an API and I want to define an enum Severity which can have values LOW, MEDIUM or HIGH. Internally Severity gets stored as an integer so I want t

How to validate openapi 3.0.0 yaml spec?

I have a yaml specification that has been updated from swagger 2.0 to openapi 3.0.0. The file itself is about 7,000 lines so it is challenging to validate by h

Displaying of FastAPI validation errors to end users

I'm looking for some library or example of code to format FastAPI validation messages into human-readable format. E.g. this endpoint: @app.get("/") async def h

OpenAPI get Documentation only for one Path?

I'm using OpenAPI to Document a Microprofile application. As the Endpoint contains a large set of methods, I'd like to know if it's possible to filter through