Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Infer API details without requiring documentation objects. #229

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

pierreh
Copy link

@pierreh pierreh commented Sep 9, 2024

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.

@JaredCE
Copy link
Owner

JaredCE commented Sep 13, 2024

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
Copy link
Author

pierreh commented Sep 13, 2024

Hi @JaredCE thanks for the update! 👍

@JaredCE
Copy link
Owner

JaredCE commented Sep 25, 2024

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants