forked from springdoc/springdoc-openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixed a bug that javadoc of record class parameters was not recognized.
Fixes springdoc#2131
- Loading branch information
Showing
9 changed files
with
228 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 16 additions & 0 deletions
16
...c-openapi-javadoc-tests/src/test/java/test/org/springdoc/api/app169/RecordController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| package test.org.springdoc.api.app169; | ||
|
|
||
| import org.springdoc.core.annotations.ParameterObject; | ||
|
|
||
| import org.springframework.web.bind.annotation.GetMapping; | ||
| import org.springframework.web.bind.annotation.RequestMapping; | ||
| import org.springframework.web.bind.annotation.RestController; | ||
|
|
||
| @RestController | ||
| @RequestMapping("record") | ||
| public class RecordController { | ||
| @GetMapping | ||
| public SimpleOuterClass index(@ParameterObject SimpleOuterClass filter) { | ||
| return null; | ||
| } | ||
| } |
10 changes: 10 additions & 0 deletions
10
...c-openapi-javadoc-tests/src/test/java/test/org/springdoc/api/app169/SimpleInnerClass.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| package test.org.springdoc.api.app169; | ||
|
|
||
| /** | ||
| * simple inner class | ||
| * | ||
| * @param name the boolean name | ||
| * @param maxNumber the max number | ||
| */ | ||
| public record SimpleInnerClass(Boolean name, Integer maxNumber) { | ||
| } |
10 changes: 10 additions & 0 deletions
10
...c-openapi-javadoc-tests/src/test/java/test/org/springdoc/api/app169/SimpleOuterClass.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| package test.org.springdoc.api.app169; | ||
|
|
||
| /** | ||
| * simple outer class | ||
| * | ||
| * @param name the name of the outer class | ||
| * @param simpleInnerClass the inner class | ||
| */ | ||
| public record SimpleOuterClass(String name, SimpleInnerClass simpleInnerClass) { | ||
| } |
36 changes: 36 additions & 0 deletions
36
...penapi-javadoc-tests/src/test/java/test/org/springdoc/api/app169/SpringDocApp169Test.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| /* | ||
| * | ||
| * * Copyright 2019-2023 the original author or authors. | ||
| * * | ||
| * * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * * you may not use this file except in compliance with the License. | ||
| * * You may obtain a copy of the License at | ||
| * * | ||
| * * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * * | ||
| * * Unless required by applicable law or agreed to in writing, software | ||
| * * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * * See the License for the specific language governing permissions and | ||
| * * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| package test.org.springdoc.api.app169; | ||
|
|
||
| import test.org.springdoc.api.AbstractSpringDocTest; | ||
|
|
||
| import org.springframework.boot.autoconfigure.SpringBootApplication; | ||
|
|
||
| /** | ||
| * The type Spring doc app 169 test. | ||
| */ | ||
| public class SpringDocApp169Test extends AbstractSpringDocTest { | ||
|
|
||
| /** | ||
| * The type Spring doc test app. | ||
| */ | ||
| @SpringBootApplication | ||
| static class SpringDocTestApp { | ||
| } | ||
| } |
97 changes: 97 additions & 0 deletions
97
...gdoc-openapi-tests/springdoc-openapi-javadoc-tests/src/test/resources/results/app169.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| { | ||
| "openapi": "3.0.1", | ||
| "info": { | ||
| "title": "OpenAPI definition", | ||
| "version": "v0" | ||
| }, | ||
| "servers": [ | ||
| { | ||
| "url": "http://localhost", | ||
| "description": "Generated server url" | ||
| } | ||
| ], | ||
| "paths": { | ||
| "/record": { | ||
| "get": { | ||
| "tags": [ | ||
| "record-controller" | ||
| ], | ||
| "operationId": "index", | ||
| "parameters": [ | ||
| { | ||
| "name": "name", | ||
| "in": "query", | ||
| "description": "the name of the outer class", | ||
| "required": false, | ||
| "schema": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| { | ||
| "name": "simpleInnerClass.name", | ||
| "in": "query", | ||
| "description": "the boolean name", | ||
| "required": false, | ||
| "schema": { | ||
| "type": "boolean" | ||
| } | ||
| }, | ||
| { | ||
| "name": "simpleInnerClass.maxNumber", | ||
| "in": "query", | ||
| "description": "the max number", | ||
| "required": false, | ||
| "schema": { | ||
| "type": "integer", | ||
| "format": "int32" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK", | ||
| "content": { | ||
| "*/*": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/SimpleOuterClass" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "components": { | ||
| "schemas": { | ||
| "SimpleInnerClass": { | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "type": "boolean", | ||
| "description": "the boolean name" | ||
| }, | ||
| "maxNumber": { | ||
| "type": "integer", | ||
| "description": "the max number", | ||
| "format": "int32" | ||
| } | ||
| }, | ||
| "description": "simple inner class" | ||
| }, | ||
| "SimpleOuterClass": { | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "type": "string", | ||
| "description": "the name of the outer class" | ||
| }, | ||
| "simpleInnerClass": { | ||
| "$ref": "#/components/schemas/SimpleInnerClass" | ||
| } | ||
| }, | ||
| "description": "simple outer class" | ||
| } | ||
| } | ||
| } | ||
| } |