[python-experimental] improves documentation

modules/openapi-generator/src/main/resources/python-experimental/api_doc.handlebars

@@ -81,7 +81,7 @@ skip_deserialization | bool | default is False | when True, headers and body wil
 ### body
         {{#each content}}
         {{#with this.schema}}
-{{> api_doc_schema_type_hint }}
+{{> api_doc_schema_type_hint complexTypePrefix="../../models/" }}
         {{/with}}
         {{/each}}
     {{/with}}
@@ -98,7 +98,7 @@ Name | Type | Description  | Notes
 
         {{#each queryParams}}
         {{#with schema}}
-{{> api_doc_schema_type_hint }}
+{{> api_doc_schema_type_hint complexTypePrefix="../../models/" }}
         {{/with}}
         {{/each}}
     {{/if}}
@@ -114,7 +114,7 @@ Name | Type | Description  | Notes
         {{/each}}
         {{#each headerParams}}
         {{#with schema}}
-{{> api_doc_schema_type_hint }}
+{{> api_doc_schema_type_hint complexTypePrefix="../../models/" }}
         {{/with}}
         {{/each}}
     {{/if}}
@@ -130,7 +130,7 @@ Name | Type | Description  | Notes
         {{/each}}
         {{#each pathParams}}
         {{#with schema}}
-{{> api_doc_schema_type_hint }}
+{{> api_doc_schema_type_hint complexTypePrefix="../../models/" }}
         {{/with}}
         {{/each}}
     {{/if}}
@@ -146,7 +146,7 @@ Name | Type | Description  | Notes
         {{/each}}
         {{#each cookieParams}}
         {{#with schema}}
-{{> api_doc_schema_type_hint }}
+{{> api_doc_schema_type_hint complexTypePrefix="../../models/" }}
         {{/with}}
         {{/each}}
     {{/if}}
@@ -161,18 +161,18 @@ Code | Class | Description
 n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
 {{#each responses}}
 {{#if isDefault}}
-default | ApiResponseForDefault | {{message}}
+default | [ApiResponseForDefault](#{{operationId}}.ApiResponseForDefault) | {{message}}
 {{else}}
-{{code}} | ApiResponseFor{{code}} | {{message}}
+{{code}} | [ApiResponseFor{{code}}](#{{operationId}}.ApiResponseFor{{code}}) | {{message}}
 {{/if}}
 {{/each}}
 {{#each responses}}
 {{#if isDefault}}
 
-#### ApiResponseForDefault
+#### {{operationId}}.ApiResponseForDefault
 {{else}}
 
-#### ApiResponseFor{{code}}
+#### {{operationId}}.ApiResponseFor{{code}}
 {{/if}}
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
@@ -181,7 +181,7 @@ body | {{#unless content}}Unset{{else}}typing.Union[{{#each content}}{{#if this.
 headers | {{#unless responseHeaders}}Unset{{else}}ResponseHeadersFor{{code}}{{/unless}} | {{#unless responseHeaders}}headers were not defined{{/unless}} |
 {{#each content}}
 {{#with this.schema}}
-{{> api_doc_schema_type_hint }}
+{{> api_doc_schema_type_hint complexTypePrefix="../../models/" }}
 {{/with}}
 {{/each}}
 {{#if responseHeaders}}
@@ -194,16 +194,13 @@ Name | Type | Description  | Notes
         {{/each}}
         {{#each responseHeaders}}
         {{#with schema}}
-{{> api_doc_schema_type_hint }}
+{{> api_doc_schema_type_hint complexTypePrefix="../../models/" }}
         {{/with}}
         {{/each}}
 
 {{/if}}
 {{/each}}
 
-
-{{#if returnType}}{{#if returnTypeIsPrimitive}}**{{{returnType}}}**{{/if}}{{#unless returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/unless}}{{/if}}{{#unless returnType}}void (empty response body){{/unless}}
-
 ### Authorization
 
 {{#unless authMethods}}No authorization required{{/unless}}{{#each authMethods}}[{{{name}}}](../../../README.md#{{{name}}}){{#unless @last}}, {{/unless}}{{/each}}

modules/openapi-generator/src/main/resources/python-experimental/api_doc_schema_type_hint.handlebars

@@ -1,10 +1,10 @@
 
-#### {{baseName}}
+# {{baseName}}
 {{#if complexType}}
 Type | Description  | Notes
 ------------- | ------------- | -------------
-[**{{dataType}}**]({{complexType}}.md) | {{#if description}}{{description}}{{/if}} | {{#if isReadOnly}}[readonly] {{/if}}
+[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md) | {{#if description}}{{description}}{{/if}} | {{#if isReadOnly}}[readonly] {{/if}}
 
 {{else}}
-{{> schema_doc }}
+{{> schema_doc complexTypePrefix="{{complexTypePrefix}}" }}
 {{/if}}

modules/openapi-generator/src/main/resources/python-experimental/model_templates/format_base.handlebars

@@ -19,9 +19,9 @@ schemas.Int32Base,
 {{#eq getFormat "int64"}}
 schemas.Int64Base,
 {{/eq}}
-{{#eq getFormat "double"}}
+{{#eq getFormat "float"}}
 schemas.Float32Base,
 {{/eq}}
-{{#eq getFormat "float"}}
+{{#eq getFormat "double"}}
 schemas.Float64Base,
 {{/eq}}

modules/openapi-generator/src/main/resources/python-experimental/model_templates/notes_msg.handlebars

@@ -0,0 +1 @@
+{{#unless isArray}}{{#unless complexType}}{{#with allowableValues}}must be one of [{{#each enumVars}}{{{value}}}, {{/each}}] {{/with}}{{#if defaultValue}}{{#unless hasRequired}}if omitted the server will use the default value of {{{defaultValue}}}{{/unless}}{{/if}}{{#eq getFormat "uuid"}}value must be a uuid{{/eq}}{{#eq getFormat "date"}}value must conform to RFC-3339 full-date YYYY-MM-DD{{/eq}}{{#eq getFormat "date-time"}}value must conform to RFC-3339 date-time{{/eq}}{{#eq getFormat "number"}}value must be numeric and storable in decimal.Decimal{{/eq}}{{#eq getFormat "int32"}}value must be a 32 bit integer{{/eq}}{{#eq getFormat "int64"}}value must be a 64 bit integer{{/eq}}{{#eq getFormat "double"}}value must be a 64 bit float{{/eq}}{{#eq getFormat "float"}}value must be a 32 bit float{{/eq}}{{/unless}}{{/unless}}

modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_accessed_types.handlebars

@@ -0,0 +1 @@
+{{#if isAnyType}}frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO{{/if}}{{#if isArray}}tuple, {{/if}}{{#if isMap}}frozendict.frozendict, {{/if}}{{#if isNull}}NoneClass, {{/if}}{{#if isString }}{{#neq format "binary"}}str, {{/neq}}{{#eq format "binary"}}bytes, FileIO, {{/eq}}{{/if}}{{#or isInteger isNumber}}decimal.Decimal, {{/or}}{{#if isBoolean}}BoolClass, {{/if}}

modules/openapi-generator/src/main/resources/python-experimental/model_templates/schema_python_types.handlebars

@@ -1 +1 @@
-{{#if isAnyType}}dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, {{/if}}{{#if isArray}}tuple, {{/if}}{{#if isMap}}dict, frozendict.frozendict, {{/if}}{{#if isNull}}None, {{/if}}{{#if isString }}{{#neq format "binary"}}str, {{/neq}}{{#eq format "date"}}date, {{/eq}}{{#eq format "date-time"}}datetime, {{/eq}}{{#eq format "uuid"}}uuid.UUID, {{/eq}}{{#eq format "binary"}}bytes, io.FileIO, io.BufferedReader, {{/eq}}{{/if}}{{#if isInteger}}decimal.Decimal, int, {{/if}}{{#if isNumber}}decimal.Decimal, int, float, {{/if}}{{#if isBoolean}}bool, {{/if}}
+{{#if isAnyType}}dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, {{/if}}{{#if isArray}}list, tuple, {{/if}}{{#if isMap}}dict, frozendict.frozendict, {{/if}}{{#if isNull}}None, {{/if}}{{#if isString }}{{#neq format "binary"}}str, {{/neq}}{{#eq format "date"}}date, {{/eq}}{{#eq format "date-time"}}datetime, {{/eq}}{{#eq format "uuid"}}uuid.UUID, {{/eq}}{{#eq format "binary"}}bytes, io.FileIO, io.BufferedReader, {{/eq}}{{/if}}{{#if isInteger}}decimal.Decimal, int, {{/if}}{{#if isNumber}}decimal.Decimal, int, float, {{/if}}{{#if isBoolean}}bool, {{/if}}

modules/openapi-generator/src/main/resources/python-experimental/schema_doc.handlebars

@@ -3,43 +3,134 @@
 {{&description}}
 
 {{/if}}
-{{#or vars additionalProperties}}
-#### Properties
-Name | Type | Description | Notes
+## Model Type Info
+Input Type | Accessed Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+{{> model_templates/schema_python_types }} | {{> model_templates/schema_accessed_types }} | {{#if description}}{{description}}{{/if}} | {{> model_templates/notes_msg }}
+{{#or vars additionalProperties}}
+
+### Dictionary Keys
+Key | Input Type | Accessed Type | Description | Notes
+------------ | ------------- | ------------- | ------------- | -------------
     {{#each getRequiredVarsMap}}
-**{{@key}}** | {{#with this}}{{#unless complexType}}**{{dataType}}**{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexType}}.md){{/if}} | {{#if description}}{{description}}{{/if}} | {{#if isReadOnly}}[readonly] {{/if}}{{#if defaultValue}} if omitted the server will use the default value of {{{defaultValue}}}{{/if}}{{/with}}
+**{{#with this}}{{#unless complexType}}{{#or isArray isMap composedSchemas}}[{{/or}}{{/unless}}{{/with}}{{{@key}}}{{#with this}}{{#unless complexType}}{{#or isArray isMap composedSchemas}}](#{{baseName}}){{/or}}{{/unless}}{{/with}}** | {{#with this}}{{#unless complexType}}{{> model_templates/schema_python_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#unless complexType}}{{> model_templates/schema_accessed_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#if description}}{{description}}{{/if}} | {{> model_templates/notes_msg }}{{/with}}
     {{/each}}
     {{#each vars}}
     {{#unless required}}
-**{{baseName}}** | {{#unless complexType}}**{{dataType}}**{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexType}}.md){{/if}} | {{#if description}}{{description}}{{/if}} | {{#unless required}}[optional] {{/unless}}{{#if isReadOnly}}[readonly] {{/if}}{{#if defaultValue}} if omitted the server will use the default value of {{{defaultValue}}}{{/if}}
+**{{#unless complexType}}{{#or isArray isMap composedSchemas}}[{{/or}}{{/unless}}{{baseName}}{{#unless complexType}}{{#or isArray isMap composedSchemas}}](#{{baseName}}){{/or}}{{/unless}}** | {{#unless complexType}}{{> model_templates/schema_python_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#unless complexType}}{{> model_templates/schema_accessed_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#if description}}{{description}}{{/if}} | [optional] {{> model_templates/notes_msg }}
     {{/unless}}
     {{/each}}
     {{#with additionalProperties}}
     {{#unless getIsBooleanSchemaFalse}}
     {{#if getIsBooleanSchemaTrue}}
-**any string name** | {{> model_templates/schema_python_types }} | any string name can be used but the value must be the correct type | [optional]
+**any_string_name** | {{> model_templates/schema_python_types }} | {{> model_templates/schema_accessed_types }} | any string name can be used but the value must be the correct type{{#if description}} {{description}}{{/if}} | [optional]
     {{else}}
-**any string name** | {{#unless complexType}}**{{dataType}}**{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexType}}.md){{/if}} | {{#if description}}{{description}}{{/if}}any string name can be used but the value must be the correct type | {{#unless required}}[optional] {{/unless}}{{#if isReadOnly}}[readonly] {{/if}}{{#if defaultValue}} if omitted the server will use the default value of {{{defaultValue}}}{{/if}}
+**{{#unless complexType}}{{#or isArray isMap composedSchemas}}[{{/or}}{{/unless}}any_string_name{{#unless complexType}}{{#or isArray isMap composedSchemas}}](#any_string_name){{/or}}{{/unless}}** | {{#unless complexType}}{{> model_templates/schema_python_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#unless complexType}}{{> model_templates/schema_accessed_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | any string name can be used but the value must be the correct type{{#if description}} {{description}}{{/if}} | [optional] {{> model_templates/notes_msg }}
     {{/if}}
     {{/unless}}
     {{else}}
-**any string name** | dict, frozendict, str, date, datetime, int, float, bool, Decimal, None, list, tuple, bytes | any string name can be used but the value must be the correct type | [optional]
+**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
     {{/with}}
-{{else}}
-Type | Description | Notes
-------------- | ------------- | -------------
-    {{#if isAnyType}}
-typing.Union[{{> model_templates/schema_python_types }}] | |
-    {{else}}
-        {{#if hasMultipleTypes}}
-typing.Union[{{> model_templates/schema_python_types }}] | | {{#with allowableValues}}{{#if defaultValue}}, {{/if}} must be one of [{{#each enumVars}}{{{value}}}, {{/each}}]{{/with}}
-        {{else}}
-            {{#if isArray}}
-{{#unless arrayModelType}}**{{dataType}}**{{/unless}}{{#if arrayModelType}}[**{{dataType}}**]({{arrayModelType}}.md){{/if}} | {{#if description}}{{description}}{{/if}} | {{#if defaultValue}}{{#if hasRequired}} if omitted the server will use the default value of {{/if}}{{#unless hasRequired}}defaults to {{/unless}}{{{defaultValue}}}{{/if}}
-            {{else}}
-{{#unless arrayModelType}}**{{dataType}}**{{/unless}} | {{#if description}}{{description}}{{/if}} | {{#if defaultValue}}{{#if hasRequired}} if omitted the server will use the default value of {{/if}}{{#unless hasRequired}}defaults to {{/unless}}{{{defaultValue}}}{{/if}}{{#with allowableValues}}{{#if defaultValue}}, {{/if}} must be one of [{{#each enumVars}}{{{value}}}, {{/each}}]{{/with}}
-            {{/if}}
-        {{/if}}
-    {{/if}}
 {{/or}}
+{{#each vars}}
+{{#unless complexType}}
+{{#or isArray isMap composedSchemas}}
+
+# {{baseName}}
+{{> schema_doc }}
+{{/or}}
+{{/unless}}
+{{/each}}
+{{#with additionalProperties}}
+{{#unless getIsBooleanSchemaFalse}}
+{{#unless getIsBooleanSchemaTrue}}
+{{#unless complexType}}
+{{#or isArray isMap composedSchemas}}
+
+# any_string_name
+{{> schema_doc }}
+{{/or}}
+{{/unless}}
+{{/unless}}
+{{/unless}}
+{{/with}}
+{{#if items}}
+
+### Tuple Items
+Class Name | Input Type | Accessed Type | Description | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+{{#with items}}
+{{#unless complexType}}{{#or isArray isMap composedSchemas}}[{{/or}}{{baseName}}{{#or isArray isMap composedSchemas}}](#{{baseName}}){{/or}}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#unless complexType}}{{> model_templates/schema_python_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#unless complexType}}{{> model_templates/schema_accessed_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#if description}}{{description}}{{/if}} | {{> model_templates/notes_msg }}
+{{#unless complexType}}
+{{#or isArray isMap composedSchemas}}
+
+# {{baseName}}
+{{> schema_doc }}
+{{/or}}
+{{/unless}}
+{{/with}}
+{{/if}}
+{{#if composedSchemas}}
+{{#with composedSchemas}}
+
+### Composed Schemas (allOf/anyOf/oneOf/not)
+{{#if allOf}}
+#### allOf
+Class Name | Input Type | Accessed Type | Description | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+{{#each allOf}}
+{{#if complexType}}[{{dataType}}]({{complexTypePrefix}}{{complexType}}.md){{else}}[{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}](#{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}){{/if}} | {{#unless complexType}}{{> model_templates/schema_python_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#unless complexType}}{{> model_templates/schema_accessed_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#if description}}{{description}}{{/if}} | {{> model_templates/notes_msg }}
+{{/each}}
+{{#each allOf}}
+{{#unless complexType}}
+
+# {{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}
+{{> schema_doc }}
+{{/unless}}
+{{/each}}
+{{/if}}
+{{#if anyOf}}
+#### anyOf
+Class Name | Input Type | Accessed Type | Description | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+{{#each anyOf}}
+{{#if complexType}}[{{dataType}}]({{complexTypePrefix}}{{complexType}}.md){{else}}[{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}](#{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}){{/if}} | {{#unless complexType}}{{> model_templates/schema_python_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#unless complexType}}{{> model_templates/schema_accessed_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#if description}}{{description}}{{/if}} | {{> model_templates/notes_msg }}
+{{/each}}
+{{#each anyOf}}
+{{#unless complexType}}
+
+# {{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}
+{{> schema_doc }}
+{{/unless}}
+{{/each}}
+{{/if}}
+{{#if oneOf}}
+#### oneOf
+Class Name | Input Type | Accessed Type | Description | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+{{#each oneOf}}
+{{#if complexType}}[{{dataType}}]({{complexTypePrefix}}{{complexType}}.md){{else}}[{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}](#{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}){{/if}} | {{#unless complexType}}{{> model_templates/schema_python_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#unless complexType}}{{> model_templates/schema_accessed_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#if description}}{{description}}{{/if}} | {{> model_templates/notes_msg }}
+{{/each}}
+{{#each oneOf}}
+{{#unless complexType}}
+
+# {{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}
+{{> schema_doc }}
+{{/unless}}
+{{/each}}
+{{/if}}
+{{#if not}}
+#### not
+Class Name | Input Type | Accessed Type | Description | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+{{#with not}}
+{{#if complexType}}[{{dataType}}]({{complexTypePrefix}}{{complexType}}.md){{else}}[{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}](#{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}){{/if}} | {{#unless complexType}}{{> model_templates/schema_python_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#unless complexType}}{{> model_templates/schema_accessed_types }}{{/unless}}{{#if complexType}}[**{{dataType}}**]({{complexTypePrefix}}{{complexType}}.md){{/if}} | {{#if description}}{{description}}{{/if}} | {{> model_templates/notes_msg }}
+{{#unless complexType}}
+
+# {{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}
+{{> schema_doc }}
+{{/unless}}
+{{/with}}
+{{/if}}
+{{/with}}
+{{/if}}

modules/openapi-generator/src/test/resources/3_0/python-experimental/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml

@@ -2897,6 +2897,9 @@ components:
         - op
         - path
       properties:
+        from:
+          description: A JSON Pointer path.
+          type: string
         path:
           description: A JSON Pointer path.
           type: string