Description
Following the doc, the resolve option should resolve refs (for parameters usage) from other external/relative sources/files and not replace ref usage by the inline version of the parameter. However, currently, the parameter ref is replaced by an inline version, while the component is still populated to POJO components.
Affected Version
e.g. 2.1.31
Earliest version the bug appears in (if known):
Seems to never have worked as expected.
Steps to Reproduce
- Create the following yml files:
1. test.yml
openapi: 3.0.3
info:
title: Test
description: Test
version: 0.0.1
paths:
/test:
parameters:
- $ref: './test-components.yml#/components/parameters/TestIdQueryParameter'
get:
summary: Get all tests
description: List tests
responses:
'200':
description: OK
2. test-components.yml
openapi: 3.0.3
info:
title: Portfolio Management API
description: API to manage games portfolio
version: 0.0.1
components:
schemas:
TestId:
description: Test id
type: string
example: 1234
parameters:
TestIdQueryParameter:
name: testId
in: query
description: Test id
required: false
schema:
$ref: './test-components.yml#/components/schemas/TestId'
- Use the following code to parse these files
package org.example;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.parser.OpenAPIV3Parser;
import io.swagger.v3.parser.core.models.ParseOptions;
public class Main {
public static void main(String[] args) {
ParseOptions options = new ParseOptions();
options.setResolve(true);
OpenAPI specs = new OpenAPIV3Parser().read("test.yml", null, options);
System.out.println(specs);
}
}
- Check the parsed
OpenAPI object
Expected Behavior
The parameters of the endpoint in the resulting OpenAPI object should look like this:
parameters: [
...
$ref = "#/components/parameters/TestIdQueryParameter,
...
]
Actual Behavior
The parameters of the endpoint in the resulting OpenAPI object looks like this:
parameters: [
...
$ref = null,
...
]
Logs / Stack Traces
Environment
- Java version: OpenJDK21
- Build tool: Gradle
- OS: MacOS 15.6
Additional Context
Checklist
Description
Following the doc, the
resolveoption should resolve refs (for parameters usage) from other external/relative sources/files and not replace ref usage by the inline version of the parameter. However, currently, the parameter ref is replaced by an inline version, while the component is still populated to POJO components.Affected Version
e.g. 2.1.31
Earliest version the bug appears in (if known):
Seems to never have worked as expected.
Steps to Reproduce
1. test.yml2. test-components.ymlOpenAPIobjectExpected Behavior
The parameters of the endpoint in the resulting
OpenAPIobject should look like this:Actual Behavior
The parameters of the endpoint in the resulting
OpenAPIobject looks like this:Logs / Stack Traces
Environment
Additional Context
Checklist