Forum Discussion
Is it possible you're using Swagger 2.0? The example you shared is for OpenAPI 3, but the rest of the content of the definition you shared suggests it's Swagger 2.0.
wow, that does make sense. How do I update to latest swagger.
And also can you tell me one more thing. Can we add like a text box in our description. I am trying to show an example of a json file content and want it to stand out. So is there a way to add a text box as such which stands out like a schema conent.
Thanks.
- RonRatovsky6 years agoStaff
You can use https://converter.swagger.io to convert from 2.0 to 3.0. We're hoping to have that integrated into the editor soon.
As for description fields - they support markdown, so they can be styled however you wish.
- cricketics6 years agoContributor
Thanks for the link.
Here is my situation. I was provided our API json file by one of my teammates and it says swagger 2.0 on top. So that person probably used swagger 2.0. Now i am using that file to open in an online editor. So what do you suggest me to do going forward since I need to make changes based on 3.0 as you can see.
Do I need to download anything from swagger website for 3.0 on my machine? Like I told you, I don't have access to everything, I only have this json file provided to me by my teammate and i am trying to create documentation out of it using online editor.
- RonRatovsky6 years agoStaff
You don't have to convert 2.0 to 3.0.
You can continue using 2.0, just be aware that some 3.0 features don't exist in 2.0.
When reading the documentation, note that you can switch to the 2.0 documentation - https://swagger.io/docs/specification/2-0/basic-structure/.
I only suggested the conversion to 3.0 because it looked like a mix of both, but as long as you stick with the 2.0 structure, it'll work out great.
Related Content
Recent Discussions
- 11 days ago
- 17 days ago