♻ Strip empty whitespace from description extracted from docstrings

[and-semakin]

What I want to achieve is to receive a clearer description field in auto-generated OpenAPI docs. For example, for this endpoint:

@app.get("/example")
async def example():
    """Example endpoint to test auto-generated OpenAPI docs.

    Well, it's just a dumb endpoint without any logic inside.

    \f

    :return: empty dict
    """
    return {}

I would like to get not these docs:

  /example:
    get:
      description: 'Example endpoint to test auto-generated OpenAPI docs.


        Well, it''s just a dumb endpoint without any logic inside.


        '
      operationId: example_example_get
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
      summary: Example

But these (without trailing spacing characters):

  /example:
    get:
      description: 'Example endpoint to test auto-generated OpenAPI docs.


        Well, it''s just a dumb endpoint without any logic inside.'
      operationId: example_example_get
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
      summary: Example

I know that it doesn't make any difference in Swagger UI but anyway, why storing redundant characters? 😅

[codecov]

Codecov Report

Merging #2821 (f46b045) into master (f8f5281) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master     #2821   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          533       533           
  Lines        13755     13755           
=========================================
  Hits         13755     13755           

Impacted Files	Coverage Δ
...ration_advanced_configurations/test_tutorial004.py	100.00% <ø> (ø)
fastapi/routing.py	100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[github-actions]

📝 Docs preview for commit 8b9f8ea at: https://602bf5579f36d459122ced3d--fastapi.netlify.app

[tiangolo]

Yep, this looks fine. Thanks for your contribution! 🍰