You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We have many projects with existing API definitions in serverless.yml. I want to generate openapi.json files without needing to document all these projects. In this PR API paths and parameters are inferred as well as using the function description.
It can also determine if path parameters are required.
Hey @pierreh Thanks so much for this PR. Just want to say i'm not ignoring it, just been really busy with work and life recently. I will try to look today or over the weekend and get this released or give some feedback.
@pierreh So i think my only concern about this is... well it's quite a large change,, though it is one i'd like to make. The problem is I don't want people generating documentation for things they don't want to.
I'd say for me to be happy to merge:
http[Api] events need to have a documentation: true property so that people can control which endpoints they wish for documentation to be generated for. I'm not sure how happy you'll be with this ask, but i think users might want a bit more control.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We have many projects with existing API definitions in serverless.yml. I want to generate openapi.json files without needing to document all these projects. In this PR API paths and parameters are inferred as well as using the function description.
It can also determine if path parameters are required.