Skip to content

Commit 74750be

Browse files
natslee-elenbaas
authored andcommitted
Use parameter.description for properties if the parameter's schema does not have description
1 parent a4038b8 commit 74750be

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

openapi_python_client/parser/openapi.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,12 @@ def add_parameters(
379379

380380
unique_parameters.add(unique_param)
381381

382+
# In OpenAPI specification both of a parameter, and its schema, may optionally have a description.
383+
# openapi-python-client only uses the schema description for the parameter, so if
384+
# the schema does not have a description we will supply the parameter's description instead.
385+
if param.param_schema.description is None:
386+
param.param_schema.description = param.description
387+
382388
prop, new_schemas = property_from_data(
383389
name=param.name,
384390
required=param.required,

openapi_python_client/parser/properties/schemas.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,7 @@ def parameter_from_data(
166166
style=data.style,
167167
param_schema=data.param_schema,
168168
param_in=data.param_in,
169+
description=data.description,
169170
)
170171
parameters = attr.evolve(parameters, classes_by_name={**parameters.classes_by_name, name: new_param})
171172
return new_param, parameters

0 commit comments

Comments
 (0)