OpenAPITools / OpenAPITools/openapi-generator

[BUG] [Python-fastapi] Missing return statement when endpoint has no description

Open
#16,762 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

The return statement is missing when the endpoint definition does not have a description.

openapi-generator version

v7.0.1 and snapshot version.

OpenAPI declaration file content or url

Here is an example of the OpenAPI declaration file content:

https://gist.github.com/reyescabello/6cd965708fd0b03e8eadb9f3c0c0a899

Generation Details

Generated with jar:

java -jar openapi-generator-cli.jar generate -i openapi.yml -g python-fastapi -o openapi_server

Steps to reproduce

If the definition of the endpoint in the yaml has the description of the endpoint, the code generated is:

paths:
  /v1/product:
    get:
      tags:
      - product
      summary: Find all products
      description: The user must have any permission in the application.
      operationId: findAllProducts
      parameters: []
      responses:
async def find_all_products(
) -> List[Product]:
    """The user must have any permission in the application."""
    return BaseProductApi.subclasses[0]().find_all_product()

However, if the description is not added, the generated code does not include the return statement:

paths:
  /v1/product:
    get:
      tags:
      - product
      summary: Find all products
      operationId: findAllProducts
      parameters: []
      responses:
async def find_all_products(
) -> List[Product]:
    ...

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the documented openapi-generator-cli command with the linked OpenAPI example and the python-fastapi generator. Compare output for operations with and without descriptions; done means an endpoint without a description still includes its return statement rather than only an ellipsis.

Written by the indexing model from the issue text.

Assessment

Tech stack
fastapi, python
Domain
api, backend, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.