v3 convert nested schemas into sequential schemas #177

spacether · 2023-05-29T22:31:29Z

v3 convert nested schemas into sequential schemas

converted Schema_ classes into dataclasses to allow for delayed evaluation of all_of/any_of/one_of/not/additional_properties/items/properties via default_factory
added a singleton metaclass to schemas so there is only one instance of each Schema_
Note: another solution here is classproperty decorated methods which would not required the dataclass and but that takes up more space (lines)
Added enum generic types
Server variables input changed to an instance of a DictSchema class
- variables are properties that can be enums
- classproperty enum type hints must be defined on a class that is not nested per vscode

PR checklist

Read the contribution guidelines.
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
Run the following to build the project and update samples:
```
./mvnw clean package 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
```
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/python*.
For Windows users, please run the script in Git BASH.

…r in getSchemas

…nged to validate_pattern

…les in properties

…ssible

…calls to getKey

* Writes nested schemas earlier and uses them later * Refactors order CodegenSchema properties are set in to match the order in getSchemas * Adjusts ref input to setSchemaLocationInfo * Tweak improves schema template * Adds properties classes * Replaces properties with field * Uses Schema_() * Uses dataclass properties * Adds missing type info * Updates all_of * Adds any_of, all_of tuples * Fixes types definition * Fixed test_any_type_schema tests * Fixes dataclass type setting issues * Fixes simple schema format type * Adds and uses PatternInfo for pattern schema info, validate_regex changed to validate_pattern * Fixes not constraint tests * Adds tuple_to_instance * Writes out allOf/anyOf/oneOf types * Updates classproperty decorator * Adds enum return types * Fixes type errors in schemas.py * Adds schema singleton metaclass * Replaces CodegenServer variables with object schema containing variables in properties * Generates server variables as an object schema to keep all schemas at the root depth * Fixes new signatures in servers schemas * Simplifies Server variables definition * Uses schema default for server variables * Adds required vars in server definition * Fixes classproperty and SchemaBase classes * Fixes broken configuration tests * Fixes server docs * Adds isInlineDefinition * Adds allOf/anyOf/oneOf/properties jsonPathPiece * Uses jsonPathPiece in properties/allOf/anyOf/oneOf * Fixes properties typeddict name * Templates updated to write allOf/anyOf/oneOf/properties earlier if possible * generates properties/allOf/anyOf/oneOf before class if possible * Adds and uses schemas.INPUT_TYPES_ALL_INCL_SCHEMA * Adds another usage of schemas.INPUT_TYPES_ALL_INCL_SCHEMA * Changes SchemaBase to SingletonMeta * Only calculates allSchemas once * Reduces iteration through allSchemas from 2x to 1x * Removes some getKey invocations * Consolidates more getKey usages * Deletes getKey with one input * Adds comment * Updates the definition of required properties, reduces the number of calls to getKey * Updates getKey to use sourceJsonPath * Adds class name generation that includes numbered suffixes when needed * Uses pre order traversal for naming schema classes * Fixes oneOf/anyOf/allOf type aliases * Adds and uses schemas.INPUT_BASE_TYPES * Adds string representation of CodegenKey * Fixes java tests * Samples regenerated * Samples regenerated

spacether force-pushed the v3_removes_nested_schemas branch 2 times, most recently from effb5f6 to 0c98150 Compare May 31, 2023 13:52

spacether force-pushed the 3_0_0 branch from e6bf84a to 1c253c2 Compare May 31, 2023 14:53

Writes nested schemas earlier and uses them later

72ab53e

spacether force-pushed the v3_removes_nested_schemas branch from 0c98150 to 72ab53e Compare May 31, 2023 14:53

spacether added 2 commits May 31, 2023 08:26

Refactors order CodegenSchema properties are set in to match the orde…

139003f

…r in getSchemas

Adjusts ref input to setSchemaLocationInfo

8ffdd97

spacether mentioned this pull request May 31, 2023

[REQ] Better support for openapi document inline/nested schemas OpenAPITools/openapi-generator#15699

Closed

spacether changed the title ~~v3 removes nested schemas~~ v3 convert nested schemas into sequential schemas May 31, 2023

spacether added 21 commits May 31, 2023 17:06

Tweak improves schema template

3bb45f5

Adds properties classes

b75c129

Replaces properties with field

e499a61

Uses Schema_()

94c8da6

Uses dataclass properties

be573a1

Adds missing type info

1b23f54

Updates all_of

24b21e6

Adds any_of, all_of tuples

6b11b44

Fixes types definition

9a4bde5

Fixed test_any_type_schema tests

8156a7a

Fixes dataclass type setting issues

7a620c8

Fixes simple schema format type

fcf53e3

Adds and uses PatternInfo for pattern schema info, validate_regex cha…

fb5fd3d

…nged to validate_pattern

Fixes not constraint tests

14cf8b9

Adds tuple_to_instance

23a8a1d

Writes out allOf/anyOf/oneOf types

6a1c104

Updates classproperty decorator

54a176d

Adds enum return types

c162dec

Fixes type errors in schemas.py

d7803e1

Adds schema singleton metaclass

27f2475

Replaces CodegenServer variables with object schema containing variab…

0a1064d

…les in properties

spacether added 25 commits June 4, 2023 21:19

Adds isInlineDefinition

1a09813

Adds allOf/anyOf/oneOf/properties jsonPathPiece

5cc5c50

Uses jsonPathPiece in properties/allOf/anyOf/oneOf

eadd977

Fixes properties typeddict name

5dc4acf

Templates updated to write allOf/anyOf/oneOf/properties earlier if po…

826ec84

…ssible

generates properties/allOf/anyOf/oneOf before class if possible

895304f

Adds and uses schemas.INPUT_TYPES_ALL_INCL_SCHEMA

b1b9389

Adds another usage of schemas.INPUT_TYPES_ALL_INCL_SCHEMA

bf3c818

Changes SchemaBase to SingletonMeta

81095c1

Only calculates allSchemas once

86a1b46

Reduces iteration through allSchemas from 2x to 1x

81d20bf

Removes some getKey invocations

73aace1

Consolidates more getKey usages

21a5ae0

Deletes getKey with one input

5098218

Adds comment

18d9a29

Updates the definition of required properties, reduces the number of …

a87d6b6

…calls to getKey

Updates getKey to use sourceJsonPath

ec8c6eb

Adds class name generation that includes numbered suffixes when needed

ab1bca2

Uses pre order traversal for naming schema classes

e09212c

Fixes oneOf/anyOf/allOf type aliases

f715b21

Adds and uses schemas.INPUT_BASE_TYPES

df41b59

Adds string representation of CodegenKey

bb9b6d1

Fixes java tests

810c737

Samples regenerated

b8287d6

Samples regenerated

db29328

spacether merged commit 802b5cc into 3_0_0 Jun 6, 2023

spacether deleted the v3_removes_nested_schemas branch June 6, 2023 17:49

spacether mentioned this pull request Jul 25, 2023

[REQ] Support for OpenAPI Spec 3.1 OpenAPITools/openapi-generator#9083

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

v3 convert nested schemas into sequential schemas #177

v3 convert nested schemas into sequential schemas #177

spacether commented May 29, 2023 •

edited

Loading

v3 convert nested schemas into sequential schemas #177

v3 convert nested schemas into sequential schemas #177

Conversation

spacether commented May 29, 2023 • edited Loading

PR checklist

spacether commented May 29, 2023 •

edited

Loading