AndrewWalsh / openapi-devtools

Browser extension that generates API specs for any app or website
https://chrome.google.com/webstore/detail/openapi-devtools/jelghndoknklgabjgaeppjhommkkmdii
MIT License
3.92k stars 72 forks source link

Suggestion for ReadMe: Explanation of What an OpenAI specification Is #1

Closed VikR1000 closed 11 months ago

VikR1000 commented 11 months ago

Suggested improvement to the ReadMe: add a paragraph explaining what an OpenAI specification is. I just read this:

https://swagger.io/specification/

...and I'm not quite sure yet what it is or where it is used.

I've used OpenAI a lot through its UI but not via code yet. :)

michaelskyba commented 11 months ago

OpenAPI != OpenAI

VikR1000 commented 11 months ago

Ohhhh... okay, thanks. At the same time, a paragraph describing OpenAPI and its use cases would be helpful.

AndrewWalsh commented 11 months ago

I think that would be useful @VikR1000. I will expand the README with a short description about that, thank you.

Edit: added a very short explanation to point newcomers in the right direction.