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

bug: Swagger UI is breaking with certain characters #3599

Closed
1 task done
ran-isenberg opened this issue Jan 6, 2024 · 5 comments · Fixed by #3606
Closed
1 task done

bug: Swagger UI is breaking with certain characters #3599

ran-isenberg opened this issue Jan 6, 2024 · 5 comments · Fixed by #3606
Assignees
@rubenfonseca
Labels
bug Something isn't working event_handlers

Comments

@ran-isenberg
Copy link
Contributor

What were you searching in the docs?

In customizing_api_operations.py, there's an example:
description="Loads a todo item identified by the todo_id",

It might be just silly old me, but i changed the text, forgot one of these: at the end so it was: "bla bla" and the /swagger endpoint would not load at all. OpenAPI file was valid.

Is this related to an existing documentation section?

No response

How can we improve?

Maybe it's best to escape or remove this example?

Got a suggestion in mind?

No response

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@ran-isenberg ran-isenberg added documentation Improvements or additions to documentation triage Pending triage from maintainers labels Jan 6, 2024
@leandrodamascena
Copy link
Contributor

Hey @ran-isenberg! Thanks for opening this issue. I'll send a PR to fix this documentation and the bug when using the backtick character.

@leandrodamascena leandrodamascena removed the triage Pending triage from maintainers label Jan 9, 2024
@leandrodamascena leandrodamascena self-assigned this Jan 9, 2024
@leandrodamascena leandrodamascena moved this from Triage to Backlog in Powertools for AWS Lambda (Python) Jan 9, 2024
@leandrodamascena
Copy link
Contributor

Assinging to @rubenfonseca!

@rubenfonseca rubenfonseca moved this from Backlog to Working on it in Powertools for AWS Lambda (Python) Jan 9, 2024
@rubenfonseca rubenfonseca mentioned this issue Jan 9, 2024
Merged
7 tasks
@rubenfonseca rubenfonseca linked a pull request Jan 9, 2024 that will close this issue
fix(event_handler): escape OpenAPI schema on Swagger UI #3606
Merged
7 tasks
@leandrodamascena leandrodamascena changed the title Docs: Swagger API example bug: Swagger UI is breaking with certain characters Jan 9, 2024
@leandrodamascena leandrodamascena added bug Something isn't working and removed documentation Improvements or additions to documentation labels Jan 9, 2024
@leandrodamascena
Copy link
Contributor

Hi @ran-isenberg! I changed the title of this issue because it is a bug in our codebase and not in the documentation. Now we fix that.

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

github-actions bot commented Jan 9, 2024

⚠️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.

@github-actions github-actions bot added the pending-release Fix or implementation already in dev waiting to be released label Jan 9, 2024
@github-actions GitHub Actions
Copy link
Contributor

This is now released under 2.32.0 version!

@github-actions github-actions bot removed the pending-release Fix or implementation already in dev waiting to be released label Jan 19, 2024
@leandrodamascena leandrodamascena moved this from Coming soon to Shipped in Powertools for AWS Lambda (Python) Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rubenfonseca rubenfonseca

Labels
bug Something isn't working event_handlers
Projects
Powertools for AWS Lambda (Python)
Status: Shipped
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(event_handler): escape OpenAPI schema on Swagger UI aws-powertools/powertools-lambda-python
3 participants
@rubenfonseca @leandrodamascena @ran-isenberg