Skip to content

Commit 8bd6777

Browse files
winridwinrid
committed
doc generation fixes, update samples
1 parent 0585c24 commit 8bd6777

140 files changed

Lines changed: 2231 additions & 115 deletions

File tree

Some content is hidden

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

‎modules/openapi-generator/src/main/resources/rust/api_doc.mustache‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Method | HTTP request | Description
2525
Name | Type | Description | Required | Notes
2626
------------- | ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
2727
{{#allParams}}
28-
**{{{paramName}}}** | {{^required}}Option<{{/required}}{{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{#isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{{dataType}}}**]({{{baseType}}}.md){{/isPrimitiveType}}{{^required}}>{{/required}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}} | {{{description}}} | {{#required}}[required]{{/required}} |{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
28+
**{{{paramName}}}** | {{^required}}Option<{{/required}}{{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{#isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isModel}}{{#baseType}}[**{{{dataType}}}**]({{#lambda.pascalcase}}{{{baseType}}}{{/lambda.pascalcase}}.md){{/baseType}}{{^baseType}}[**{{{dataType}}}**]({{{dataType}}}.md){{/baseType}}{{/isModel}}{{^isModel}}{{#isEnumRef}}{{#baseType}}[**{{{dataType}}}**]({{#lambda.pascalcase}}{{{baseType}}}{{/lambda.pascalcase}}.md){{/baseType}}{{^baseType}}[**{{{dataType}}}**]({{{dataType}}}.md){{/baseType}}{{/isEnumRef}}{{^isEnumRef}}{{#isEnum}}{{#baseType}}[**{{{dataType}}}**]({{#lambda.pascalcase}}{{{baseType}}}{{/lambda.pascalcase}}.md){{/baseType}}{{^baseType}}[**{{{dataType}}}**]({{{dataType}}}.md){{/baseType}}{{/isEnum}}{{^isEnum}}**{{{dataType}}}**{{/isEnum}}{{/isEnumRef}}{{/isModel}}{{/isPrimitiveType}}{{^required}}>{{/required}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}} | {{{description}}} | {{#required}}[required]{{/required}} |{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
2929
{{/allParams}}
3030

3131
### Return type

‎modules/openapi-generator/src/main/resources/rust/model_doc.mustache‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
Name | Type | Description | Notes
2424
------------ | ------------- | ------------- | -------------
25-
{{#vars}}**{{{name}}}** | {{^required}}Option<{{/required}}{{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{#isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{{dataType}}}**]({{#lambda.pascalcase}}{{{complexType}}}{{/lambda.pascalcase}}.md){{/isPrimitiveType}}{{^required}}>{{/required}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}} | {{{description}}} | {{^required}}[optional]{{/required}}{{#isReadOnly}}[readonly]{{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
25+
{{#vars}}**{{{name}}}** | {{^required}}Option<{{/required}}{{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{#isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isModel}}[**{{{dataType}}}**]({{#lambda.pascalcase}}{{{complexType}}}{{/lambda.pascalcase}}.md){{/isModel}}{{^isModel}}{{#isEnumRef}}[**{{{dataType}}}**]({{#lambda.pascalcase}}{{{complexType}}}{{/lambda.pascalcase}}.md){{/isEnumRef}}{{^isEnumRef}}{{#isEnum}}[**{{{dataType}}}**]({{#lambda.pascalcase}}{{{complexType}}}{{/lambda.pascalcase}}.md){{/isEnum}}{{^isEnum}}**{{{dataType}}}**{{/isEnum}}{{/isEnumRef}}{{/isModel}}{{/isPrimitiveType}}{{^required}}>{{/required}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}} | {{{description}}} | {{^required}}[optional]{{/required}}{{#isReadOnly}}[readonly]{{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
2626
{{/vars}}
2727
{{/x-mapped-models}}
2828
{{/vendorExtensions}}
@@ -35,7 +35,7 @@ Name | Type | Description | Notes
3535

3636
Name | Type | Description | Notes
3737
------------ | ------------- | ------------- | -------------
38-
{{#vars}}**{{{name}}}** | {{^required}}Option<{{/required}}{{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{#isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{{dataType}}}**]({{#lambda.pascalcase}}{{{complexType}}}{{/lambda.pascalcase}}.md){{/isPrimitiveType}}{{^required}}>{{/required}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}} | {{{description}}} | {{^required}}[optional]{{/required}}{{#isReadOnly}}[readonly]{{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
38+
{{#vars}}**{{{name}}}** | {{^required}}Option<{{/required}}{{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{#isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isModel}}[**{{{dataType}}}**]({{#lambda.pascalcase}}{{{complexType}}}{{/lambda.pascalcase}}.md){{/isModel}}{{^isModel}}{{#isEnumRef}}[**{{{dataType}}}**]({{#lambda.pascalcase}}{{{complexType}}}{{/lambda.pascalcase}}.md){{/isEnumRef}}{{^isEnumRef}}{{#isEnum}}[**{{{dataType}}}**]({{#lambda.pascalcase}}{{{complexType}}}{{/lambda.pascalcase}}.md){{/isEnum}}{{^isEnum}}**{{{dataType}}}**{{/isEnum}}{{/isEnumRef}}{{/isModel}}{{/isPrimitiveType}}{{^required}}>{{/required}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}} | {{{description}}} | {{^required}}[optional]{{/required}}{{#isReadOnly}}[readonly]{{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
3939
{{/vars}}
4040
{{/oneOf.isEmpty}}
4141
{{^oneOf.isEmpty}}

‎samples/client/others/rust/reqwest-regression-16119/docs/Parent.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**child** | Option<[**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md)> | | [optional]
7+
**child** | Option<**std::collections::HashMap<String, serde_json::Value>**> | | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

‎samples/client/others/rust/reqwest/api-with-ref-param/docs/DefaultApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Method | HTTP request | Description
1818

1919
Name | Type | Description | Required | Notes
2020
------------- | ------------- | ------------- | ------------- | -------------
21-
**color** | [**Color**](.md) | | [required] |
21+
**color** | [**Color**](Color.md) | | [required] |
2222

2323
### Return type
2424

‎samples/client/others/rust/reqwest/emptyObject/docs/EmptyObject.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**empty_object** | Option<[**serde_json::Value**](.md)> | | [optional]
7+
**empty_object** | Option<**serde_json::Value**> | | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

‎samples/client/others/rust/reqwest/enum-query-params/docs/AggregateResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**count** | Option<**i64**> | | [optional]
8-
**data** | Option<[**Vec<std::collections::HashMap<String, serde_json::Value>>**](std::collections::HashMap.md)> | | [optional]
8+
**data** | Option<**Vec<std::collections::HashMap<String, serde_json::Value>>**> | | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

‎samples/client/others/rust/reqwest/enum-query-params/docs/DefaultApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ Test endpoint with enum query parameters referenced via $ref
2121

2222
Name | Type | Description | Required | Notes
2323
------------- | ------------- | ------------- | ------------- | -------------
24-
**status** | [**Status**](.md) | Status filter | [required] |
25-
**time_bucket** | Option<[**TimeBucket**](.md)> | Time aggregation bucket | |
26-
**sort_direction** | Option<[**SortDirection**](.md)> | Sort direction | |
24+
**status** | [**Status**](Status.md) | Status filter | [required] |
25+
**time_bucket** | Option<[**TimeBucket**](TimeBucket.md)> | Time aggregation bucket | |
26+
**sort_direction** | Option<[**SortDirection**](SortDirection.md)> | Sort direction | |
2727

2828
### Return type
2929

@@ -52,7 +52,7 @@ Get items with filters
5252
Name | Type | Description | Required | Notes
5353
------------- | ------------- | ------------- | ------------- | -------------
5454
**category** | Option<**String**> | Item category (inline enum) | |
55-
**priority** | Option<[**Priority**](.md)> | Priority level (enum via ref) | |
55+
**priority** | Option<[**Priority**](Priority.md)> | Priority level (enum via ref) | |
5656

5757
### Return type
5858

‎samples/client/others/rust/reqwest/multipart-async/docs/DefaultApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Name | Type | Description | Required | Notes
2424
------------- | ------------- | ------------- | ------------- | -------------
2525
**primary_file** | **std::path::PathBuf** | Primary file (required) | [required] |
2626
**title** | Option<**String**> | Upload title | |
27-
**tags** | Option<[**Vec<String>**](String.md)> | Tags for the upload | |
27+
**tags** | Option<**Vec<String>**> | Tags for the upload | |
2828
**thumbnail** | Option<**std::path::PathBuf**> | Optional thumbnail file | |
2929

3030
### Return type

‎samples/client/petstore/rust/reqwest-trait/petstore/.openapi-generator/FILES‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ docs/Baz.md
1010
docs/Category.md
1111
docs/EnumArrayTesting.md
1212
docs/FakeApi.md
13+
docs/ModelWithInlineEnum.md
14+
docs/ModelWithInlineEnumMetadata.md
1315
docs/NullableArray.md
1416
docs/NumericEnumTesting.md
1517
docs/OptionalTesting.md
@@ -50,6 +52,8 @@ src/models/enum_array_testing.rs
5052
src/models/mod.rs
5153
src/models/model_ref.rs
5254
src/models/model_return.rs
55+
src/models/model_with_inline_enum.rs
56+
src/models/model_with_inline_enum_metadata.rs
5357
src/models/nullable_array.rs
5458
src/models/numeric_enum_testing.rs
5559
src/models/optional_testing.rs

‎samples/client/petstore/rust/reqwest-trait/petstore/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ Class | Method | HTTP request | Description
4343
*StoreApi* | [**place_order**](docs/StoreApi.md#place_order) | **POST** /store/order | Place an order for a pet
4444
*TestingApi* | [**tests_all_of_with_one_model_get**](docs/TestingApi.md#tests_all_of_with_one_model_get) | **GET** /tests/allOfWithOneModel | Test for allOf with a single option. (One of the issues in #20500)
4545
*TestingApi* | [**tests_file_response_get**](docs/TestingApi.md#tests_file_response_get) | **GET** /tests/fileResponse | Returns an image file
46+
*TestingApi* | [**tests_inline_enum_boxing_get**](docs/TestingApi.md#tests_inline_enum_boxing_get) | **GET** /tests/inlineEnumBoxing | Get model with inline enums
47+
*TestingApi* | [**tests_inline_enum_boxing_post**](docs/TestingApi.md#tests_inline_enum_boxing_post) | **POST** /tests/inlineEnumBoxing | Test for inline enum fields not being boxed in model constructors
4648
*TestingApi* | [**tests_type_testing_get**](docs/TestingApi.md#tests_type_testing_get) | **GET** /tests/typeTesting | Route to test the TypeTesting schema
4749
*UserApi* | [**create_user**](docs/UserApi.md#create_user) | **POST** /user | Create user
4850
*UserApi* | [**create_users_with_array_input**](docs/UserApi.md#create_users_with_array_input) | **POST** /user/createWithArray | Creates list of users with given input array
@@ -63,6 +65,8 @@ Class | Method | HTTP request | Description
6365
- [Baz](docs/Baz.md)
6466
- [Category](docs/Category.md)
6567
- [EnumArrayTesting](docs/EnumArrayTesting.md)
68+
- [ModelWithInlineEnum](docs/ModelWithInlineEnum.md)
69+
- [ModelWithInlineEnumMetadata](docs/ModelWithInlineEnumMetadata.md)
6670
- [NullableArray](docs/NullableArray.md)
6771
- [NumericEnumTesting](docs/NumericEnumTesting.md)
6872
- [OptionalTesting](docs/OptionalTesting.md)

0 commit comments

Comments
 (0)