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.

Sign up for GitHub

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

Jump to bottom

Docs: New OpenAPI and Swagger UI support in Event Handler REST #3325

Closed
1 task done
heitorlessa opened this issue Nov 13, 2023 · 2 comments
Closed
1 task done

Docs: New OpenAPI and Swagger UI support in Event Handler REST #3325

heitorlessa opened this issue Nov 13, 2023 · 2 comments
Assignees
@rubenfonseca
Labels
documentation Improvements or additions to documentation
Milestone
OpenAPI in Event ...

Comments

@heitorlessa
Copy link
Contributor

What were you searching in the docs?

(future) How to create an /swagger endpoint to visualize my API, and how to generate an OpenAPI Schema out of my code.

Is this related to an existing documentation section?

https://docs.powertools.aws.dev/lambda/python/latest/core/event_handler/api_gateway/

How can we improve?

Create the doc out of implementation

Got a suggestion in mind?

Split out OpenAPI into a separate subsection due to complexity for advanced customers wanting to extend all parts of it.

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@heitorlessa heitorlessa added documentation Improvements or additions to documentation triage Pending triage from maintainers labels Nov 13, 2023
@heitorlessa heitorlessa removed the triage Pending triage from maintainers label Nov 13, 2023
@heitorlessa heitorlessa moved this from Triage to Backlog in Powertools for AWS Lambda (Python) Nov 13, 2023
@heitorlessa heitorlessa added this to the OpenAPI in Event Handler milestone Nov 13, 2023
@rubenfonseca rubenfonseca self-assigned this Nov 23, 2023
@rubenfonseca rubenfonseca moved this from Backlog to Working on it in Powertools for AWS Lambda (Python) Nov 23, 2023
@rubenfonseca
Copy link
Contributor

Closed by #3386

@github-project-automation github-project-automation bot moved this from Working on it to Coming soon in Powertools for AWS Lambda (Python) Nov 23, 2023
@github-actions GitHub Actions
Copy link
Contributor

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

@heitorlessa heitorlessa moved this from Coming soon to Shipped in Powertools for AWS Lambda (Python) Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rubenfonseca rubenfonseca

Labels
documentation Improvements or additions to documentation
Projects
Powertools for AWS Lambda (Python)
Status: Shipped
Milestone
OpenAPI in Event Handler
Development

No branches or pull requests
2 participants
@rubenfonseca @heitorlessa