Skip to content

Commit f7cd91b

Browse files
v1nvnv1nvn
committed
feat: added model and api doc generation
1 parent 73cae06 commit f7cd91b

File tree

63 files changed

+1042
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+1042
-4
lines changed

‎end_to_end_tests/golden-record/my_test_api_client/docs/1.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# 1
2+
3+
4+
Method | HTTP Request | Description
5+
------------- | ------------- | -------------
6+
[**get_tag_with_number**](#get_tag_with_number) | GET /tag_with_number |
7+
8+
9+
# **get_tag_with_number**
10+
11+
12+
13+
### Response Type
14+
Any
15+

‎end_to_end_tests/golden-record/my_test_api_client/docs/AFormData.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# AFormData
2+
3+
4+
## Properties
5+
Name | Type | Description
6+
------------ | ------------- | -------------
7+
an_required_field | str | None
8+
an_optional_field | Union[Unset, str] | None
9+
a_simple_dict | Union[Unset, Dict[str, Any]] | None
10+

‎end_to_end_tests/golden-record/my_test_api_client/docs/AModel.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# AModelA Model for testing all the ways custom objects can be used
2+
3+
4+
5+
6+
## Properties
7+
Name | Type | Description
8+
------------ | ------------- | -------------
9+
an_enum_value | AnEnum | For testing Enums in all the ways they can be used
10+
an_allof_enum_with_overridden_default | AnAllOfEnum | None
11+
a_camel_date_time | Union[datetime.date, datetime.datetime] | None
12+
a_date | datetime.date | None
13+
required_not_nullable | str | None
14+
one_of_models | Union['FreeFormModel', 'ModelWithUnionProperty', Any] | None
15+
model | ModelWithUnionProperty |
16+
any_value | Union[Unset, Any] | None
17+
an_optional_allof_enum | Union[Unset, AnAllOfEnum] | None
18+
nested_list_of_enums | Union[Unset, List[List[DifferentEnum]]] | None
19+
a_nullable_date | Optional[datetime.date] | None
20+
a_not_required_date | Union[Unset, datetime.date] | None
21+
attr_1_leading_digit | Union[Unset, str] | None
22+
attr_leading_underscore | Union[Unset, str] | None
23+
required_nullable | Optional[str] | None
24+
not_required_nullable | Union[Unset, None, str] | None
25+
not_required_not_nullable | Union[Unset, str] | None
26+
nullable_one_of_models | Union['FreeFormModel', 'ModelWithUnionProperty', None] | None
27+
not_required_one_of_models | Union['FreeFormModel', 'ModelWithUnionProperty', Unset] | None
28+
not_required_nullable_one_of_models | Union['FreeFormModel', 'ModelWithUnionProperty', None, Unset, str] | None
29+
nullable_model | Optional[ModelWithUnionProperty] |
30+
not_required_model | Union[Unset, ModelWithUnionProperty] |
31+
not_required_nullable_model | Union[Unset, None, ModelWithUnionProperty] |
32+

‎end_to_end_tests/golden-record/my_test_api_client/docs/AModelWithPropertiesReferenceThatAreNotObject.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# AModelWithPropertiesReferenceThatAreNotObject
2+
3+
4+
## Properties
5+
Name | Type | Description
6+
------------ | ------------- | -------------
7+
enum_properties_ref | List[AnEnum] | None
8+
str_properties_ref | List[str] | None
9+
date_properties_ref | List[datetime.date] | None
10+
datetime_properties_ref | List[datetime.datetime] | None
11+
int32_properties_ref | List[int] | None
12+
int64_properties_ref | List[int] | None
13+
float_properties_ref | List[float] | None
14+
double_properties_ref | List[float] | None
15+
file_properties_ref | List[File] | None
16+
bytestream_properties_ref | List[str] | None
17+
enum_properties | List[AnEnum] | None
18+
str_properties | List[str] | None
19+
date_properties | List[datetime.date] | None
20+
datetime_properties | List[datetime.datetime] | None
21+
int32_properties | List[int] | None
22+
int64_properties | List[int] | None
23+
float_properties | List[float] | None
24+
double_properties | List[float] | None
25+
file_properties | List[File] | None
26+
bytestream_properties | List[str] | None
27+
enum_property_ref | AnEnum | For testing Enums in all the ways they can be used
28+
str_property_ref | str | None
29+
date_property_ref | datetime.date | None
30+
datetime_property_ref | datetime.datetime | None
31+
int32_property_ref | int | None
32+
int64_property_ref | int | None
33+
float_property_ref | float | None
34+
double_property_ref | float | None
35+
file_property_ref | File | None
36+
bytestream_property_ref | str | None
37+

‎end_to_end_tests/golden-record/my_test_api_client/docs/AllOfHasPropertiesButNoType.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# AllOfHasPropertiesButNoType
2+
3+
4+
## Properties
5+
Name | Type | Description
6+
------------ | ------------- | -------------
7+
a_sub_property | Union[Unset, str] | None
8+
type | Union[Unset, str] | None
9+
type_enum | Union[Unset, AllOfHasPropertiesButNoTypeTypeEnum] | None
10+

‎end_to_end_tests/golden-record/my_test_api_client/docs/AllOfSubModel.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# AllOfSubModel
2+
3+
4+
## Properties
5+
Name | Type | Description
6+
------------ | ------------- | -------------
7+
a_sub_property | Union[Unset, str] | None
8+
type | Union[Unset, str] | None
9+
type_enum | Union[Unset, AllOfSubModelTypeEnum] | None
10+

‎end_to_end_tests/golden-record/my_test_api_client/docs/AnArrayWithACircularRefInItemsObjectAItem.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# AnArrayWithACircularRefInItemsObjectAItem
2+
3+
4+
## Properties
5+
Name | Type | Description
6+
------------ | ------------- | -------------
7+
circular | Union[Unset, List['AnArrayWithACircularRefInItemsObjectBItem']] | None
8+

‎end_to_end_tests/golden-record/my_test_api_client/docs/AnArrayWithACircularRefInItemsObjectAdditionalPropertiesAItem.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# AnArrayWithACircularRefInItemsObjectAdditionalPropertiesAItem
2+
3+
4+

‎end_to_end_tests/golden-record/my_test_api_client/docs/AnArrayWithACircularRefInItemsObjectAdditionalPropertiesBItem.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# AnArrayWithACircularRefInItemsObjectAdditionalPropertiesBItem
2+
3+
4+

‎end_to_end_tests/golden-record/my_test_api_client/docs/AnArrayWithACircularRefInItemsObjectBItem.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# AnArrayWithACircularRefInItemsObjectBItem
2+
3+
4+
## Properties
5+
Name | Type | Description
6+
------------ | ------------- | -------------
7+
circular | Union[Unset, List['AnArrayWithACircularRefInItemsObjectAItem']] | None
8+

0 commit comments

Comments
 (0)