swagger-api / swagger-api/swagger-parser
swagger-parser-v2-converter removes properties from 'required' that are not explicitly listed
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 867
- Forks
- 560
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 7
Description
In OpenAPI v2 and v3, it is possible to declare, through 'additionalProperties: {}' or 'additionalProperties: true', that other properties can occur in an object than those explicitly listed in the schema. It can then make sense to specify that a property is required, even though it is not explicitly listed.
(Another way, maybe, to have properties that are not explicitly listed is to use the 'patternProperties' or 'x-patternProperties' regexes.)
The swagger-parser-v2-converter removes properties from 'required' that are not explicitly listed. It should not do that.
- Store this file as v2.json.
- Store this file as ConvertOpenAPIV2ToV3.java.
Compile it with a classpath that contains
slf4j-api-1.5.8.jar
slf4j-jdk14-1.5.8.jar
jackson-core-2.9.9.jar
jackson-dataformat-yaml-2.9.9.jar
jackson-databind-2.9.9.jar
jackson-annotations-2.9.9.jar
commons-io-1.4.jar
commons-lang3-3.1.jar
swagger-models-2.0.8.jar
swagger-parser-v3-2.0.12.jar
swagger-core-2.0.8.jar
swagger-parser-core-2.0.12.jar
swagger-parser-v2-converter-2.0.12.jar
swagger-parser-1.0.44.jar
swagger-core-1.5.22.jar
swagger-models-1.5.22.jar
snakeyaml.jar
-
Run it with two arguments, namely the absolute file name from step 1 and the absolute file name of the destination file.
-
The output I got is:
As you can see, the 'required' list of 'complexBoVerySpecial'
- in v2: contains "myDeepArray"
- in v3: does not contain "myDeepArray".
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the supplied ConvertOpenAPIV2ToV3.java and v2.json, then inspect the swagger-parser-v2-converter conversion path used by the reproducer. Run the conversion with the listed dependencies and compare the required list for complexBoVerySpecial; done means myDeepArray remains required in the v3 output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100