Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sphinxcontrib/openapi/renderers/_httpdomain.py
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ def render_operation(self, endpoint, method, operation):
yield ""

if operation.get("summary"):
yield f" **{operation['summary']}**"
yield f" **{' '.join(operation['summary'].split())}**"
yield ""

if operation.get("description"):
Expand Down
53 changes: 53 additions & 0 deletions tests/renderers/httpdomain/test_render_operation.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,59 @@ def test_render_operation_summary(testrenderer, oas_fragment):
""".rstrip())


def test_render_operation_summary_block_scalar(testrenderer, oas_fragment):
"""Operation's 'summary' is stripped of its trailing newline."""

markup = textify(
testrenderer.render_operation(
"/evidences",
"post",
oas_fragment("""
summary: |
Create an evidence.
responses:
'201':
description: An evidence created.
"""),
)
)
assert markup == textwrap.dedent("""\
.. http:post:: /evidences

**Create an evidence.**

:statuscode 201:
An evidence created.
""".rstrip())


def test_render_operation_summary_multiline(testrenderer, oas_fragment):
"""Operation's 'summary' is rendered as a single line."""

markup = textify(
testrenderer.render_operation(
"/evidences",
"post",
oas_fragment("""
summary: |
Create
an evidence.
responses:
'201':
description: An evidence created.
"""),
)
)
assert markup == textwrap.dedent("""\
.. http:post:: /evidences

**Create an evidence.**

:statuscode 201:
An evidence created.
""".rstrip())


def test_render_operation_description(testrenderer, oas_fragment):
"""Operation's 'description' is rendered."""

Expand Down