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

Commit 39a9de8

Browse files
committed
Updates docs
1 parent fee246a commit 39a9de8

File tree

4 files changed

+10
-6
lines changed

4 files changed

+10
-6
lines changed

bin/utils/export_docs_generators.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
SCRIPT="$0"
44
echo "# START SCRIPT: ${SCRIPT}"
55

6-
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
6+
executable="./modules/openapi-json-schema-generator-cli/target/openapi-json-schema-generator-cli.jar"
77

88
if [[ "true" == "${SKIP_EXPORT_DOCS}" ]]; then
99
echo "Skipping doc exports. Note that docs generated by Windows may break paths as they have not yet been normalized to OS-specific paths."

bin/utils/export_generator.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ else
1212
exit 1;
1313
fi
1414

15-
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
15+
executable="./modules/openapi-json-schema-generator-cli/target/openapi-json-schema-generator-cli.jar"
16+
1617

1718
java -jar ${executable} config-help -g "${NAME}" --full-details --named-header --format markdown --markdown-header -o "docs/generators/${NAME}.md"

docs/generators/python.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
2222
|generateSourceCodeOnly|Specifies that only a library source code is to be generated.| |false|
2323
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
2424
|library|library template (sub-template) to use: urllib3| |urllib3|
25+
|nonCompliantUseDiscriminatorIfCompositionFails|When true, If the payload fails to validate against composed schemas (allOf/anyOf/oneOf/not) and a discriminator is present, then ignore the compostion validation errors and attempt to use the discriminator to validate the payload. Note: setting this to true makes the generated client not comply with json schema because it ignores compotion validation errors . Please consider making your schemas more restrictive rather than setting this to true. You can do that by: - defining the propertyName as an enum with only one value in the schemas that are in your discriminator map- setting additionalProperties: false in your schemas| |false|
2526
|packageName|python package name (convention: snake_case).| |openapi_client|
2627
|packageUrl|python package URL.| |null|
2728
|packageVersion|python package version.| |1.0.0|

modules/openapi-json-schema-generator/src/main/java/org/openapitools/codegen/CodegenConstants.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -407,10 +407,12 @@ public static enum ENUM_PROPERTY_NAMING_TYPE {camelCase, PascalCase, snake_case,
407407
public static final String NON_COMPLIANT_USE_DISCR_IF_COMPOSITION_FAILS = "nonCompliantUseDiscriminatorIfCompositionFails";
408408

409409
public static final String NON_COMPLIANT_USE_DISCR_IF_COMPOSITION_FAILS_DESC =
410-
"When true, If the payload fails to validate against composed schemas (allOf/anyOf/oneOf/not) and a discriminator is present, " +
411-
"then ignore the compostion validation errors and attempt to use the discriminator to validate the payload. " +
412-
"Note: setting this to true makes the generated client not comply with json schema because it ignores compotion validation errors . " +
413-
"Please consider making your schemas more restrictive rather than setting this to true. You can do that by: " +
410+
"When true, If the payload fails to validate against composed schemas (allOf/anyOf/oneOf/not) and a " +
411+
"discriminator is present, then ignore the compostion validation errors and attempt to use the " +
412+
"discriminator to validate the payload. " +
413+
"Note: setting this to true makes the generated client not comply with json schema because it ignores " +
414+
"composition validation errors. Please consider making your schemas more restrictive rather than " +
415+
"setting this to true. You can do that by: " +
414416
"- defining the propertyName as an enum with only one value in the schemas that are in your discriminator map" +
415417
"- setting additionalProperties: false in your schemas";
416418

0 commit comments

Comments
 (0)