Skip to content

feat: Add parameter description to properties #345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

feat: Add parameter description to properties #345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions openapi_python_client/parser/openapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,7 @@ def _add_parameters(
data=param.param_schema,
schemas=schemas,
parent_name=endpoint.name,
description=param.description,
)
if isinstance(prop, ParseError):
return ParseError(detail=f"cannot parse parameter of endpoint {endpoint.name}", data=prop.data), schemas
Expand Down
92 changes: 81 additions & 11 deletions openapi_python_client/parser/properties/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ def inner_properties_with_template(self) -> Iterator[Property]:


def _string_based_property(
name: str, required: bool, data: oai.Schema
name: str, required: bool, data: oai.Schema, description: Optional[str]
) -> Union[StringProperty, DateProperty, DateTimeProperty, FileProperty]:
""" Construct a Property from the type "string" """
string_format = data.schema_format
Expand All @@ -209,20 +209,23 @@ def _string_based_property(
required=required,
default=convert("datetime.datetime", data.default),
nullable=data.nullable,
description=description,
)
elif string_format == "date":
return DateProperty(
name=name,
required=required,
default=convert("datetime.date", data.default),
nullable=data.nullable,
description=description,
)
elif string_format == "binary":
return FileProperty(
name=name,
required=required,
default=None,
nullable=data.nullable,
description=description,
)
else:
return StringProperty(
Expand All @@ -231,6 +234,7 @@ def _string_based_property(
required=required,
pattern=data.pattern,
nullable=data.nullable,
description=description,
)


Expand Down Expand Up @@ -259,7 +263,12 @@ def build_model_property(
for key, value in (data.properties or {}).items():
prop_required = key in required_set
prop, schemas = property_from_data(
name=key, required=prop_required, data=value, schemas=schemas, parent_name=class_name
name=key,
required=prop_required,
data=value,
schemas=schemas,
parent_name=class_name,
description=value.description,
)
if isinstance(prop, PropertyError):
return prop, schemas
Expand Down Expand Up @@ -320,6 +329,7 @@ def build_enum_property(
schemas: Schemas,
enum: List[Union[str, int]],
parent_name: Optional[str],
description: Optional[str],
) -> Tuple[Union[EnumProperty, PropertyError], Schemas]:
"""
Create an EnumProperty from schema data.
Expand Down Expand Up @@ -379,13 +389,20 @@ def build_enum_property(
reference=reference,
values=values,
value_type=value_type,
description=description,
)
schemas = attr.evolve(schemas, enums={**schemas.enums, prop.reference.class_name: prop})
return prop, schemas


def build_union_property(
*, data: oai.Schema, name: str, required: bool, schemas: Schemas, parent_name: str
*,
data: oai.Schema,
name: str,
required: bool,
schemas: Schemas,
parent_name: str,
description: Optional[str],
) -> Tuple[Union[UnionProperty, PropertyError], Schemas]:
sub_properties: List[Property] = []
for sub_prop_data in chain(data.anyOf, data.oneOf):
Expand All @@ -404,28 +421,35 @@ def build_union_property(
default=default,
inner_properties=sub_properties,
nullable=data.nullable,
description=description,
),
schemas,
)


def build_list_property(
*, data: oai.Schema, name: str, required: bool, schemas: Schemas, parent_name: str
*,
data: oai.Schema,
name: str,
required: bool,
schemas: Schemas,
parent_name: str,
description: Optional[str],
) -> Tuple[Union[ListProperty[Any], PropertyError], Schemas]:
if data.items is None:
return PropertyError(data=data, detail="type array must have items defined"), schemas
inner_prop, schemas = property_from_data(
name=f"{name}_item", required=True, data=data.items, schemas=schemas, parent_name=parent_name
)
if isinstance(inner_prop, PropertyError):
return PropertyError(data=inner_prop.data, detail=f"invalid data in items of array {name}"), schemas
return (
ListProperty(
name=name,
required=required,
default=None,
inner_property=inner_prop,
nullable=data.nullable,
description=description,
),
schemas,
)
Expand All @@ -437,6 +461,7 @@ def _property_from_data(
data: Union[oai.Reference, oai.Schema],
schemas: Schemas,
parent_name: str,
description: Optional[str],
) -> Tuple[Union[Property, PropertyError], Schemas]:
""" Generate a Property from the OpenAPI dictionary representation of it """
name = utils.remove_string_escapes(name)
Expand All @@ -451,22 +476,50 @@ def _property_from_data(
return PropertyError(data=data, detail="Could not find reference in parsed models or enums"), schemas
if data.enum:
return build_enum_property(
data=data, name=name, required=required, schemas=schemas, enum=data.enum, parent_name=parent_name
data=data,
name=name,
required=required,
schemas=schemas,
enum=data.enum,
parent_name=parent_name,
description=description,
)
if data.anyOf or data.oneOf:
return build_union_property(data=data, name=name, required=required, schemas=schemas, parent_name=parent_name)
return build_union_property(
data=data,
name=name,
required=required,
schemas=schemas,
parent_name=parent_name,
description=description,
)
if not data.type:
return NoneProperty(name=name, required=required, nullable=False, default=None), schemas
return (
NoneProperty(
name=name,
required=required,
nullable=False,
default=None,
description=description,
),
schemas,
)

if data.type == "string":
return _string_based_property(name=name, required=required, data=data), schemas
return (
_string_based_property(
name=name, required=required, data=data, description=description
),
schemas,
)
elif data.type == "number":
return (
FloatProperty(
name=name,
default=convert("float", data.default),
required=required,
nullable=data.nullable,
description=description,
),
schemas,
)
Expand All @@ -477,6 +530,7 @@ def _property_from_data(
default=convert("int", data.default),
required=required,
nullable=data.nullable,
description=description,
),
schemas,
)
Expand All @@ -487,11 +541,19 @@ def _property_from_data(
required=required,
default=convert("bool", data.default),
nullable=data.nullable,
description=description,
),
schemas,
)
elif data.type == "array":
return build_list_property(data=data, name=name, required=required, schemas=schemas, parent_name=parent_name)
return build_list_property(
data=data,
name=name,
required=required,
schemas=schemas,
parent_name=parent_name,
description=description,
)
elif data.type == "object":
return build_model_property(data=data, name=name, schemas=schemas, required=required, parent_name=parent_name)
return PropertyError(data=data, detail=f"unknown type {data.type}"), schemas
Expand All @@ -504,9 +566,17 @@ def property_from_data(
data: Union[oai.Reference, oai.Schema],
schemas: Schemas,
parent_name: str,
description: Optional[str] = None,
) -> Tuple[Union[Property, PropertyError], Schemas]:
try:
return _property_from_data(name=name, required=required, data=data, schemas=schemas, parent_name=parent_name)
return _property_from_data(
name=name,
required=required,
data=data,
schemas=schemas,
parent_name=parent_name,
description=description,
)
except ValidationError:
return PropertyError(detail="Failed to validate default value", data=data), schemas

Expand Down
1 change: 1 addition & 0 deletions openapi_python_client/parser/properties/property.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ class Property:
nullable: bool
_type_string: ClassVar[str] = ""
default: Optional[str] = attr.ib()
description: Optional[str]
python_name: str = attr.ib(init=False)

template: ClassVar[Optional[str]] = None
Expand Down