Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Commit b039dd3

Browse files
authored
Merge pull request #15 from OpenAPITools/wing328-patch-readme
Revise readme
2 parents 1623589 + 89c7164 commit b039dd3

File tree

1 file changed

+2
-26
lines changed

1 file changed

+2
-26
lines changed

README.md

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -26,32 +26,8 @@ OpenAPI JSON Schema Generator allows auto-generation of API client libraries (SD
2626

2727

2828
## Why this repo exists
29-
From 2019 to now, 2022, I (@spacether) focused on improving the python client code generator in openapi-generator and added:
30-
- code to always check schema constraints defined in specs
31-
- multiple request and response body content type handling
32-
- parameter style handling
33-
- type hints everywhere
34-
35-
In openapi v3.0.0 and onward, schemas are in components, and schemas define request bodies, response bodies, and parameter values.
36-
The contributions that I made allow the user to bring any spec to the generator, and the schema constraints and
37-
validations will always be checked. In other generators when payload types != object/array constraints are
38-
sometimes omitted and not checked.
39-
The python generator checks schema constraints when:
40-
- instantiation models
41-
- sending data to the server
42-
- receiving data from the server
43-
- and I verified that by [creating a v3.0.3 unit test spec that contains most json schema tests](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/unit_test_spec/3_0_3_unit_test_spec.yaml) that has [auto generated positive and negative model and enpoint tests](https://github.com/OpenAPITools/openapi-generator/tree/master/samples/openapi3/client/3_0_3_unit_test/python/test) which are [passing](https://app.circleci.com/pipelines/github/OpenAPITools/openapi-generator/19756/workflows/55132a87-a1b7-46f2-975c-509730833eab/jobs/50107)
44-
45-
Recently though, @wing328 decided that because the python generator is focused on checking all json schema constraints,
46-
which differs from how the other generators work, that the python generator should not be in the openapi-generator repo.
47-
So he is requiring that I move the python generator into a separate repo.
48-
My preference is to keep it in openapi-generator. I think that devs should be
49-
allowed to build generators there that fully conform to openapi + json schema constraints.
50-
If you have thoughts on this, please let the openapi-generator community know at:
51-
- In the [openapi-generator general Slack channel](https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g)
52-
- As comments in [The PR making python-experimental the primary python generator, and mentioning the new project](https://github.com/OpenAPITools/openapi-generator/pull/13501)
53-
54-
If this is the only way to continue my work then I will develop and distribute code in this repo.
29+
30+
This repo is based on v6.2.0 of OpenAPI Generator. This project focuses on making the output 100% compliant with JSON schema as part of the OpenAPI 3.1 specification with a focus on complex cases (top-down approach). The goal is to fully support everything defined in JSON schema so that developers can leverage JSON schema as well as OpenAPI specification in their API design. Building here allows for more rapid progress supporting new features in OpenAPI 3.X without having to support many older generators which don't use the new features.
5531

5632
## Table of contents
5733

0 commit comments

Comments
 (0)