search

sckott / apipkgen

Generate an R package from API specs
http://sckott.github.io/apipkgen/
Other
20 stars 2 forks source link

Roxygenize with OpenAPI description and summary fields #17

Closed eaurele closed 5 years ago

eaurele commented 5 years ago

The OpenAPI specification describes a description and a summary fields that could be used to generate an Roxygen documentation: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#path-item-object , both at the function level and the function parameter level

sckott commented 5 years ago

thanks for this - agree, makes sense to use those fields to help generate the manual files. will work onit soon

sckott commented 5 years ago

@eaurele reinstall and try again, generates docs now for each fxn, try with bcgov eg. havne't tested with any others yet

eaurele commented 5 years ago

Thank you so much! I opened a PR to handle a few additional quirks of my use case (for reference: https://data.castoredc.com/api/swagger)

18