alexjomin / openapi-parser

Simple and still naive openapi documentation generator from comments of your Go code.
18 stars 8 forks source link

Rename action to operation and add some missing fields #38

Closed Sikwan closed 3 years ago

Sikwan commented 3 years ago

As specified in the following ticket: https://github.com/alexjomin/openapi-parser/issues/4, operationId are currently not supported.

This PR aims at filling that gap, allowing the generated OpenAPI spec to be used to generate better SDKs (as it stands, the name of the methods are quite hard to digest).

I also added deprecated and externalDocs, but did not add Callback as I could not think of a good way to do it just yet. The spec itself seems to support different formats for the callbacks.

It is worth mentioning that with this implementation, deprecated will only appear if true.

denouche commented 3 years ago

Hello! Thank you for your PR! I merged another PR before and I tried the "resolve conflict" feature from Github but with no success... (sorry for that) Please could your resolve the conflict on your branch so I can merge it? Thanks !

Sikwan commented 3 years ago

Sure thing! It's done ;)

Sikwan commented 3 years ago

Hey @denouche, following up on this. Do you need me to do something else before merging?

Thanks a lot

denouche commented 3 years ago

I don't need anything else than free time to read my github notifications :smile: thanks !