cancel
Showing results for 
Search instead for 
Did you mean: 

Can we describe the json inside a zip file in swagger.

SOLVED
Highlighted
Occasional Visitor

Can we describe the json inside a zip file in swagger.

I have an API  (/report) which returns zip file in response. I can describe the output in the swagger using schema.format=binary. Is it possible to describe the contents of the zip file in the swagger ?

Zip file contains a report folder and report folder cotains report.json.

 

1 ACCEPTED SOLUTION

Accepted Solutions
Moderator

Re: Can we describe the json inside a zip file in swagger.

Hi @discard,

 

OpenAPI Specification does not have a way to define the contents of ZIP files, but you can provide any additional information in the "description" key of the operation or response.


Helen Kosova
SmartBear Technical Writer
________________________
Vote up helpful replies.
Accept this reply if you think it's the best solution to your question.

Join the September Hub-bub to show off, learn and win
1 REPLY 1
Moderator

Re: Can we describe the json inside a zip file in swagger.

Hi @discard,

 

OpenAPI Specification does not have a way to define the contents of ZIP files, but you can provide any additional information in the "description" key of the operation or response.


Helen Kosova
SmartBear Technical Writer
________________________
Vote up helpful replies.
Accept this reply if you think it's the best solution to your question.

Join the September Hub-bub to show off, learn and win
New Here?
Join us and watch the welcome video:
SeptemberNews
Join our online event
SeptemberHubBub
Top Kudoed Authors
Join the September Hub-bub to show off, learn and win