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

Commit e67f265

Browse files
authored
Preparation for v3.3.0 relase (#265)
* Removes unneeded 310 sample client * More readme updated * Tweaks schema feature list * Updates keyword count * Removes asterisk
1 parent a05acd8 commit e67f265

File tree

164 files changed

+30
-11035
lines changed

Some content is hidden

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

164 files changed

+30
-11035
lines changed

.circleci/parallel.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ elif [ "$JOB_ID" = "testPythonClientSamples" ]; then
2424
(cd samples/client/3_1_0_unit_test/python && make test)
2525
(cd samples/client/openapi_features/nonCompliantUseDiscriminatorIfCompositionFails/python && make test)
2626
(cd samples/client/openapi_features/security/python && make test)
27-
(cd samples/client/3_1_0_json_schema/python && make test)
2827

2928
else
3029
echo "Running job $JOB_ID"

README.md

Lines changed: 30 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This project is a code generator that focuses on supporting all openapi and json
88

99
## Overview
1010
OpenAPI JSON Schema Generator allows auto-generation of API client libraries (SDK generation) given an
11-
[OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification) (3.0.0-[3.1.0*](#preliminary-310-spec-support) are supported).
11+
[OpenAPI Document](https://github.com/OAI/OpenAPI-Specification) (3.0.0-[3.1.0*](#openapi-v310-support) are supported).
1212
This project focuses on making the output 100% compliant with openapi + JSON schema specs.
1313
The goal is to fully support everything defined in openapi + the included JSON schema specs
1414
so developers can use all of those features.
@@ -23,7 +23,7 @@ You can join us here: https://discord.gg/mHB8WEQuYQ
2323

2424
## Reasons To Use the Python Generator
2525

26-
- [3.1.0*](#preliminary-310-spec-support) - 3.0.0 spec support
26+
- v3.0.0 - [v3.1.0*](#openapi-v310-support) OpenAPI Specification support
2727
- Type hints on
2828
- schema payload inputs in SomeSchema.validate ![validate screen capture](docs/schema_validate.gif)
2929
- Note: to make input dictionaries TypedDicts like the Money.validate example, set additionalProperties to false in the schema in your openapi document
@@ -40,7 +40,7 @@ You can join us here: https://discord.gg/mHB8WEQuYQ
4040
- passing mypy tests means that this generator could be ported into compiled languages like java/kotlin/golang
4141
- [Autogenerated thorough testing of json schema keyword features in models and endpoints](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator/tree/master/samples/client/3_0_3_unit_test/python/test) which come from the [json schema test suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite)
4242
- [Tests are passing in CI](https://app.circleci.com/pipelines/github/openapi-json-schema-tools/openapi-json-schema-generator?branch=master)
43-
- [Test endpoints are tagged by the relevant keyword like type/format/allOf 36 keywords and counting](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator/tree/master/samples/client/3_1_0_unit_test/python/docs/apis/tags)
43+
- [Test endpoints are tagged by the relevant keyword like type/format/allOf 39 keywords and counting](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator/tree/master/samples/client/3_1_0_unit_test/python/docs/apis/tags)
4444
- Code re-use built in from the ground up
4545
- components/schemas/headers etc are generated as separate classes and imported when used via $ref
4646
- Openapi spec inline schemas supported at any depth in any location
@@ -59,10 +59,10 @@ And many more!
5959
- [Docs for the python generator](docs/generators/python.md)
6060
- [generated client sample code](samples/client/petstore/python)
6161
- [Openapi v3.0.3 general petstore spec, general features](src/test/resources/3_0/python/petstore_customized.yaml)
62-
- [generated v3.0.3 unit test client sample code](samples/client/3_0_3_unit_test/python)
63-
- [Openapi json schema v3.0.3 unit test spec](src/test/resources/3_0/unit_test_spec/3_0_3_unit_test_spec.yaml)
6462
- [generated v3.1.0 unit test client sample code](samples/client/3_1_0_unit_test/python)
6563
- [Openapi json schema v3.1.0 unit test spec](src/test/resources/3_1/unit_test_spec/3_1_0_unit_test_spec.yaml)
64+
- [generated v3.0.3 unit test client sample code](samples/client/3_0_3_unit_test/python)
65+
- [Openapi json schema v3.0.3 unit test spec](src/test/resources/3_0/unit_test_spec/3_0_3_unit_test_spec.yaml)
6666

6767
### Can I build here?
6868

@@ -94,35 +94,31 @@ Submit a PR if you want to add a new server scaffold, client sdk, or documentati
9494

9595
The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The openapi-json-schema-generator project has the following compatibilities with the OpenAPI Specification:
9696

97-
| OpenAPI JSON Schema Generator Version | OpenAPI Spec compatibility |
98-
|---------------------------------------|--------------------------------------------------|
99-
| 3.1.0+ | 3.0.0 - [3.1.0*](#preliminary-310-spec-support) |
100-
| 3.0.0 | 3.0.0 - 3.0.3 |
101-
| 2.0.3 | 3.0.0 - 3.0.3 |
102-
| 2.0.2 | 3.0.0 - 3.0.3 |
103-
| 2.0.1 | 3.0.0 - 3.0.3 |
104-
| 2.0.0 | 3.0.0 - 3.0.3 |
105-
| 1.0.4 | 3.0.0 - 3.0.3 |
106-
| 1.0.3 | 3.0.0 - 3.0.3 |
107-
| 1.0.2 | 3.0.0 - 3.0.3 |
108-
| 1.0.1 | 3.0.0 - 3.0.3 |
109-
| 1.0.0 | 3.0.0 - 3.0.3 |
110-
111-
#### Preliminary 3.1.0 spec support
112-
Preliminary 3.1.0 spec support includes these new 2020-12 json schema keywords:
113-
1. type (array of types supported in addition to one non-array value)
114-
2. const: only string values are working because of bugs in swagger parser
115-
3. contains
116-
4. dependentRequired
117-
5. dependentSchemas
118-
6. maxContains
119-
7. minContains
120-
8. patternProperties
121-
9. prefixItems
122-
10. propertyNames
123-
11. unevaluatedItems
124-
12. unevaluatedProperties
125-
97+
| OpenAPI JSON Schema Generator Version | OpenAPI Spec compatibility |
98+
|---------------------------------------|----------------------------------------------|
99+
| 3.3.0 | 3.0.0 - [3.1.0*](#openapi-v310-support) |
100+
| 3.1.0 - 3.2.1 | 3.0.0 - [3.1.0](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator/blob/3.1.0/docs/generators/python.md#schema-feature) |
101+
| 1.0.0 - 3.0.0 | 3.0.0 - 3.0.3 |
102+
103+
#### OpenAPI v3.1.0 support
104+
OpenAPI v3.1.0 specification support includes these new/updated 2020-12 json schema keywords:
105+
1. const: only string values are working because of bugs in swagger parser
106+
2. contains
107+
3. dependentRequired
108+
4. dependentSchemas
109+
5. else
110+
6. if
111+
7. maxContains
112+
8. minContains
113+
9. patternProperties
114+
10. prefixItems
115+
11. propertyNames
116+
12. then
117+
13. type (array of types supported in addition to one non-array value)
118+
14. unevaluatedItems
119+
15. unevaluatedProperties
120+
121+
Note: these features can also be seen in the generator documentation [schema features](docs/generators/python.md#schema-feature)
126122

127123
### Build Projects
128124

bin/generate_samples_configs/python_3_1_0_json_schema.yaml

Lines changed: 0 additions & 5 deletions
This file was deleted.

samples/client/3_1_0_json_schema/python/.gitignore

Lines changed: 0 additions & 67 deletions
This file was deleted.

samples/client/3_1_0_json_schema/python/.gitlab-ci.yml

Lines changed: 0 additions & 15 deletions
This file was deleted.

samples/client/3_1_0_json_schema/python/.openapi-generator-ignore

Lines changed: 0 additions & 23 deletions
This file was deleted.

samples/client/3_1_0_json_schema/python/.openapi-generator/FILES

Lines changed: 0 additions & 125 deletions
This file was deleted.

samples/client/3_1_0_json_schema/python/.openapi-generator/VERSION

Lines changed: 0 additions & 1 deletion
This file was deleted.

samples/client/3_1_0_json_schema/python/.travis.yml

Lines changed: 0 additions & 11 deletions
This file was deleted.

samples/client/3_1_0_json_schema/python/Makefile

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)