Stack Overflow
Stack Overflow

Questions tagged [swagger-3.0]

121 questions
1
vote
0 answers

OpenAPI to define optional parameters with undefined names

Simple question: How do you write an OpenAPI spec. that accepts optional parameters with undefined names (i.e. the parameter names can be any random string)? Example: GET /api/someEndPoint GET…
user1589188
  • 5,316
  • 17
  • 67
  • 130
1
vote
0 answers

How to remove Request Body Examples Dropdown in swagger-php

I'm using Swagger 3.0 in tandem with swagger-php and getting strange behavior with request body markup . In the image, the "Examples:" dropdown shows up and "Example Value | Schema" shows up under that dropdown instead of "Example Value |…
user2701539
  • 11
  • 2
1
vote
0 answers

How to define Open Api 3.0 documentation for requestBody of content " text / csv (UTF-8)"

I am new to swagger. I have an endpoint which is accepting input in the format of 'text / csv (UTF-8). I want to add open api documentation for the end point. But I am not finding any examples from the official website request body description…
Shantiswarup Tunga
  • 591
  • 2
  • 12
1
vote
2 answers

Implementation of Swagger core v3 in java

I'm writing some API and I want to integrate Documentation while writing code, so I found Swagger as a good way to to this. I used Swagger core v3 notations, so my classes are something…
Heisenberg1
  • 49
  • 1
  • 6
1
vote
0 answers

How to use different labels for Basic Authentication credentials Swagger 3

My API is currently using Basic Authentication with api_xxx instead of username and api_xxy instead of password, do we have any specific schema for such a situation? Everything works exactly the same, I would like to change only the labels on the UI…
DanFlorin
  • 121
  • 1
  • 8
1
vote
1 answer

Serialize nested properties as form-data with swagger-php

This is how Encoding Object Example is done in OpenApi https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md requestBody: content: multipart/mixed: schema: type: object properties: id: …
Andrei Lupuleasa
  • 2,677
  • 3
  • 14
  • 32
1
vote
0 answers

Can there be parameter fields for content headers in the swagger-ui for specific form data contents under a multipart request body in swagger-3.0?

I am trying to create a swagger documentation for some REST API Calls. The POST method in one of the API Calls accept a multi-part form data content with 1st part as binary file data and 2nd part as json instance. I am looking for a way to allow the…
Shaon Dasgupta
  • 11
  • 1
0
votes
0 answers

How to validate parameter with array data type in Swagger 3.0.0

I have a swagger .yaml file which generates java class as below: AlleleExportRequest: type: object properties: speciesId: type: integer format: int64 example: 17 required: true …
Abdusoli
  • 661
  • 1
  • 8
  • 24
0
votes
0 answers

How to rename the generated client SDK project by modifying the input json

I am using the https://editor.swagger.io/ to generate SDK. When I generate the SDK by selecting Generate Client -> CSharp, the SDK project is generated. But the problem is, I could not modify the project-name and namespaces. It by default gives the…
IMK
  • 654
  • 9
  • 15
0
votes
1 answer

OpenAPI Swagger for springboot application

I've started to develop a small springboot application and I wanted to document it's API (every existing endpoint) using Swagger. However, doesn't matter which version of Swagger I'm trying to implement, I always end up with 404 response code while…
rysiu115
  • 1
  • 1
0
votes
1 answer

Swagger V3 UI Not Sending In Authorization Header When 'Trying it Out"

I have a Spring Boot App (2.7.10) and am using the Sprspringdoc-openapi-ui dependency (1.6.15). I have annotated my controller and it seems to be displaying correctly, however when I try and execute one of the endpoints which requires an…
ustad
  • 459
  • 1
  • 6
  • 21
0
votes
0 answers

Issues with openapi 3 documentation (swagger) in spring boot 3

When using the openapi 3 documentation (swagger) in a spring boot 3 application, swagger documents controllers and methods unknown to me, what could be the problem? @OpenAPIDefinition( info = @Info( title = "Billing System…
Kirill
  • 1
  • 1
0
votes
0 answers

Failed to get the response in Swagger 3 (open api) while using Java 19 and Spring Boot 3.0.x

I'm migrating from Spring Boot 2 to Spring Boot 3 with Java 19 and also using swagger 3 that's open api. I have added the "open api webmvc ui" dependency in POM file and also changed Javax to Jakarta. I have configured in open api configure file.…
VASANTHAPRIYA
  • 1
0
votes
0 answers

Add a pattern in a header parameter - Swagger OpenAPI

It is possible to add a pattern to a header parameter? I am putting patterns to some fields in an JAVA application using swagger OpenAPI in the YAML file. In the body fields, i was able to put some patterns with no problem at all. I also tried to…
Borsoi
  • 1
  • 3
0
votes
1 answer

Swagger 3 Open API doesn't display api details with same endpoint but with different parameter

I am working on Springboot 2.6.8 version and integrating Swagger 3 using springdoc-open-ui dependency. Integration works fine and Swagger-ui.html displays the API documentation. But I have multiple API's with same endpoint with different parameters.…
user1111880
  • 443
  • 5
  • 8
  • 26
1 2 3 4 5
6
7 8