Skip to content

bug: Swagger UI is breaking with certain characters #3599

Closed
@ran-isenberg

Description

@ran-isenberg

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.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Status

Shipped

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions