Clarification on swagger validation

Question

I am using swagger for API documentation. We have a JSON file that gets rendered by swagger.

for one of the API we have 3 input parameters

param1 param2 param3

if the user specifies values for param1,param2 then param3 should behave as optional.

if the user specifies values for param3 then the param1,param2 should behave as optional.

either param,param2 are required or only param3 is required.

Any suggestions would be greatly appreciated.

Thanks

Maktum

joejoyce · Answer

Hey&nbsp;Maktum_pasha.&nbsp;By default, OpenAPI treats all request parameters as optional. You can add&nbsp;required: true&nbsp;to mark a parameter as required. Note that path parameters must have&nbsp;required: true, because they are always required. You can find more information here:&nbsp;https://swagger.io/docs/specification/describing-parameters/. Let me know if this helps!

Forum Discussion

Clarification on swagger validation

1 Reply

Related Content

openapi.yaml valid in swagger editor, but won't show fields locally

Id property clarification

swagger- specific_Api

Swagger Response In Array

Log4j Vulnerability - Swagger

Recent Discussions

How to disable 500 code by default in swagger 3?

Long shot question from noob

GROUPING CONTROLLERS INTO SEPARATE SWAGGER UI PAGES

oneOf or anyOf for the header schema

Should the Curl command show the path to the file to be uploaded