Skip to content

When using @Operation, treat deprecated false as NULL (reduce openap.json noise) #575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rbygrave merged 2 commits into from
Mar 10, 2025
Merged

When using @Operation, treat deprecated false as NULL (reduce openap.json noise) #575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ee30ce
When using @Operation, treat deprecated false as NULL (reduce openapi…
rbygrave Mar 10, 2025
fbc08ed
Merge branch 'master' into feature/openapi-deprecated
rbygrave Mar 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion http-generator-core/src/main/java/io/avaje/http/generator/core/MethodReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,9 +273,12 @@ private List<OpenAPIResponsePrism> buildApiResponses() {
public void readOperation(Operation operation, Javadoc javadoc) {
OperationPrism.getOptionalOn(element).ifPresent(an -> {
operation.setOperationId(emptyToNull(an.operationId()));
operation.setDeprecated(an.deprecated());
operation.setSummary(emptyToNull(an.summary()));
operation.setDescription(emptyToNull(an.description()));
if (Boolean.TRUE.equals(an.deprecated())) {
// leave deprecated false as NULL to reduce openapi noise
operation.setDeprecated(true);
}
});
if (operation.getDescription() == null) {
operation.setDescription(javadoc.getDescription());
Expand Down
1 change: 1 addition & 0 deletions tests/test-javalin/src/main/java/org/example/myapp/web/HelloController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ HelloDto hello(int id, LocalDate date, String otherParam) {
* @return The Hellos that we found.
*/
@Roles(AppRoles.ADMIN)
@Operation(operationId = "findByName")
@Get("/findbyname/{name}")
List<HelloDto> findByName(String name, @QueryParam("my-param") @Default("one") String myParam) {
return new ArrayList<>();
Expand Down
1 change: 1 addition & 0 deletions tests/test-javalin/src/main/resources/public/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,7 @@
],
"summary" : "Find Hellos by name",
"description" : "",
"operationId" : "findByName",
"parameters" : [
{
"name" : "name",
Expand Down