networknt / networknt/openapi-parser

OpenAPI 3.1: support multi-type

Open
#66 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
13
Forks
9
PR merge metrics
No merged PRs in 30d

Description

OpenAPI 3.1 drops the nullable property and uses a type array instead.

Unfortunately openapi-parser is not prepared for that (yet).

If you make change petstore.yaml to openapi 3.1.0 and allow be nullable:

        tag:
          type: [string, 'null']

It'll fail with this error message:

java.lang.NullPointerException: Cannot invoke "java.lang.CharSequence.length()" because "this.text" is null

	at java.base/java.util.regex.Matcher.getTextLength(Matcher.java:1808)
	at java.base/java.util.regex.Matcher.reset(Matcher.java:461)
	at java.base/java.util.regex.Matcher.<init>(Matcher.java:256)
	at java.base/java.util.regex.Pattern.matcher(Pattern.java:1180)
	at com.networknt.oas.validator.ValidatorBase.checkPattern(ValidatorBase.java:77)
	at com.networknt.oas.validator.ValidatorBase.validateStringField(ValidatorBase.java:67)
	at com.networknt.oas.validator.ValidatorBase.validateStringField(ValidatorBase.java:57)
	at com.networknt.oas.validator.impl.SchemaValidator.runObjectValidations(SchemaValidator.java:48)
	at com.networknt.oas.validator.ObjectValidatorBase.runValidations(ObjectValidatorBase.java:18)
	at com.networknt.oas.validator.ValidatorBase.validate(ValidatorBase.java:43)
	at com.networknt.oas.validator.MapValidator.runValidations(MapValidator.java:31)
	at com.networknt.oas.validator.ValidatorBase.validate(ValidatorBase.java:43)
	at com.networknt.oas.validator.ValidatorBase.validateMap(ValidatorBase.java:263)
	at com.networknt.oas.validator.ValidatorBase.validateMapField(ValidatorBase.java:257)
	at com.networknt.oas.validator.impl.SchemaValidator.runObjectValidations(SchemaValidator.java:56)
	at com.networknt.oas.validator.ObjectValidatorBase.runValidations(ObjectValidatorBase.java:18)
	at com.networknt.oas.validator.ValidatorBase.validate(ValidatorBase.java:43)
	at com.networknt.oas.validator.MapValidator.runValidations(MapValidator.java:31)
	at com.networknt.oas.validator.ValidatorBase.validate(ValidatorBase.java:43)
	at com.networknt.oas.validator.ValidatorBase.validateMap(ValidatorBase.java:263)
	at com.networknt.oas.validator.ValidatorBase.validateMapField(ValidatorBase.java:257)
	at com.networknt.oas.validator.impl.OpenApi3Validator.runObjectValidations(OpenApi3Validator.java:28)
	at com.networknt.oas.validator.ObjectValidatorBase.runValidations(ObjectValidatorBase.java:18)
	at com.networknt.oas.validator.ValidatorBase.validate(ValidatorBase.java:43)
	at com.networknt.oas.model.impl.OpenApi3Impl.validate(OpenApi3Impl.java:44)
	at com.networknt.oas.OpenApiParser.parse(OpenApiParser.java:96)
	at com.networknt.oas.OpenApiParser.parse(OpenApiParser.java:85)
	at com.networknt.oas.OpenApiParser.parse(OpenApiParser.java:35)
	at com.networknt.oas.OpenApiParser.parse(OpenApiParser.java:28)
	at com.networknt.openapi.OpenApiHelper.<init>(OpenApiHelper.java:58)
	at com.networknt.openapi.EndpointTest.testYaml(EndpointTest.java:55)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/test/resources/models/petstore.yaml and reproduce the failure through EndpointTest.testYaml. Trace the validation path from OpenApiParser.parse through SchemaValidator and ValidatorBase.checkPattern, especially the reported null text. Done means the OpenAPI 3.1 document with type [string, 'null'] parses and validates without the NullPointerException.

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
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.