Category "openapi"

Google API Gateway: Authorization Header not forwarded

I have a google cloud api gateway deployed to send requests to a cloud run service. The cloud run service hosts a laravel docker container image and to authenti

Override default auth in SAM templates and Open API

I have made a SAM template that deploys a mix of public and authenticated endpoints. The default auth is oauth. For public endpoints, I use overrides to make it

How to do multiple (simultaneous) versions of APIs with OpenAPI and express-openapi?

Re: https://www.npmjs.com/package/express-openapi#getting-started On many projects I've been worked on (in other technologies) we would always support multiple

Hide property in a subclass of a @ParameterObject with springdoc

We are migrating from spring-fox to springdoc. Sometimes we need to hide properties from common base classes that are used in @ParameterObjects. With spring-fox

Custom Connector ( JSON result convert into Paramters )

List item I am a newbie in the azure environment. I am getting JSON response from my custom connector but I need to convert that JSON into parameters so I can u

Swagger OpenAPI describing string array in multipart request

I need to describe a multipart query that has an array of strings. But I ran into a problem, in the query, the array elements are combined into one string inste

Configure Open API 3 - SpringBoot with multiple controller classes

Am trying to configure swagger 3 spring documentation for my springboot application. I have 3 controller classes with 1 functional endpoint method each. If I op

OpenApi generator doesn't allow multiple schema in content

I've an OpenAPI contract like this: openapi: 3.0.1 info: title: Internal API version: '' tags: - name: Calendar description: Api for Calendar resource

How to include members of base entity in Swagger API Documentation?

I have something like these: BaseDTO public record BaseDTO { public virtual int Id { get; protected init; } public DateTime Timestamp {

FastAPI Textarea OpenAPI for Form Data

I am using Form Data format for APIs. The thing is how I am going to make OpenAPI input being larger by using textarea?

Automatic OpenAPI YAML generation

I am working on the backend of a Spring Boot application that uses OpenAPI and Swagger to provide the interface for frontend application via an schema.yml file.

validating multiple input query params in Mule 4

I am using Mule 4.4 community edition I have a GET endpoint with 4 query params: empId ( mandatory ) collegeId ( mandatory ) subject ( either subject or

Getting 405 error in OpenAPI swagger page if I put only path variable attributes in a Rest Controller

I am trying to create Swagger documentation using OpenAPI 3.0. I am using spring-boot-starter 1.5.4.RELEASE and springdoc-openapi-ui version 1.4.2 <parent>

How to add a banner/label to redoc

Looking at the Redoc demo and they have used a "Webhook" label beside their title but I couldn't figure out how to implement it specifically for other labels. H

Exact purpose of tags in OpenAPI and why are they unique

By Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md A list of tags used by the specification with additional metadata

Spring Cloud Gateway and Springdoc OpenAPi integration

I was able to integrate Spring Cloud Gateway with the Springdoc OpenAPI in an small application with an architecture oriented to microservices. But now, when I

How to Integrate Open API 3 with Spring project (not Spring Boot) using springdoc-openapi

My Existing Project is on Spring Framework not Spring Boot. I want to integrate Open API 3 with it. I want to integrate using springdoc-openapi not using Jers

How to get pretty API names with RapidAPI from OpenAPI spec

I'm creating an API using RapidAPI and when I upload an OpenAPI spec, the web UI API names are populated using the OpenAPI spec operationId which is often camel

How to define in swagger spec either of two properties are not null and required

I have a requirement to have two properties in the payload say property1 and propert2. Both are array type. Condition is, that either both can have values, or o

What does 'required' in OpenAPI really mean

Given the following OpenAPI definition Person: required: - id type: object properties: id: type: string Which of the below objects are val