Skip to content

dbeaver/pro#9128 add badges to rest api doc #2

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
serge-rider merged 1 commit into from
Jun 9, 2026
Merged

dbeaver/pro#9128 add badges to rest api doc #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion openapi-maven-plugin/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<version>0.0.31-dbeaver</version>
<version>0.0.32-dbeaver</version>
<packaging>maven-plugin</packaging>

<name>openapi-maven-plugin Maven Plugin</name>
Expand Down
8 changes: 8 additions & 0 deletions openapi-maven-plugin/src/main/java/io/github/kbuntrock/configuration/ApiConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ public ApiConfiguration mergeWithCommonApiConfiguration(final CommonApiConfigura
merged.pathPrefix = copy.pathPrefix;
merged.fileFormat = copy.fileFormat;
merged.loopbackOperationName = copy.loopbackOperationName;
merged.badges = copy.badges;
merged.badgeColor = copy.badgeColor;
merged.enumListDescriptionEnabled = copy.enumListDescriptionEnabled;
merged.enumNameExtensionEnabled = copy.enumNameExtensionEnabled;
merged.enumNameExtensionValue = copy.enumNameExtensionValue;
Expand Down Expand Up @@ -127,6 +129,12 @@ public ApiConfiguration mergeWithCommonApiConfiguration(final CommonApiConfigura
if(loopbackOperationName != null) {
merged.setLoopbackOperationName(loopbackOperationName);
}
if(badges != null) {
merged.setBadges(badges);
}
if(badgeColor != null) {
merged.setBadgeColor(badgeColor);
}
if(enumListDescriptionEnabled != null) {
merged.setEnumListDescriptionEnabled(enumListDescriptionEnabled);
}
Expand Down
36 changes: 36 additions & 0 deletions ...-maven-plugin/src/main/java/io/github/kbuntrock/configuration/CommonApiConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,18 @@ public class CommonApiConfiguration {
@Parameter
protected Boolean loopbackOperationName;

/**
* If true, expose the operationId as an "x-badges" extension on every operation.
*/
@Parameter
protected Boolean badges;

/**
* Color used for the generated x-badges entry. Defaults "grey"
*/
@Parameter
protected String badgeColor;

/**
* Write in the description the complete list of enum value / description
*/
Expand Down Expand Up @@ -171,6 +183,8 @@ public CommonApiConfiguration(final CommonApiConfiguration commonApiConfiguratio
this.pathPrefix = commonApiConfiguration.pathPrefix;
this.fileFormat = commonApiConfiguration.fileFormat;
this.loopbackOperationName = commonApiConfiguration.loopbackOperationName;
this.badges = commonApiConfiguration.badges;
this.badgeColor = commonApiConfiguration.badgeColor;
this.enumListDescriptionEnabled = commonApiConfiguration.enumListDescriptionEnabled;
this.enumNameExtensionEnabled = commonApiConfiguration.enumNameExtensionEnabled;
this.enumNameExtensionValue = commonApiConfiguration.enumNameExtensionValue;
Expand Down Expand Up @@ -231,6 +245,12 @@ public void initDefaultValues() {
if(loopbackOperationName == null) {
loopbackOperationName = true;
}
if(badges == null) {
badges = false;
}
if(badgeColor == null) {
badgeColor = "grey";
}
if(enumListDescriptionEnabled == null) {
enumListDescriptionEnabled = true;
}
Expand Down Expand Up @@ -346,6 +366,22 @@ public void setLoopbackOperationName(final boolean loopbackOperationName) {
this.loopbackOperationName = loopbackOperationName;
}

public boolean isBadges() {
return badges != null && badges;
}

public void setBadges(final boolean badges) {
this.badges = badges;
}

public String getBadgeColor() {
return badgeColor;
}

public void setBadgeColor(final String badgeColor) {
this.badgeColor = badgeColor;
}

public Boolean getEnumListDescriptionEnabled() {
return enumListDescriptionEnabled;
}
Expand Down
9 changes: 9 additions & 0 deletions openapi-maven-plugin/src/main/java/io/github/kbuntrock/yaml/YamlWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,15 @@ private Map<String, Map<String, Operation>> createPaths(final TagLibrary tagLibr
operation.setOperationId(operation.getOperationId() + nbEncounteredOperationId);
}

if(apiConfiguration.isBadges()) {
Map<String, String> badge = new LinkedHashMap<>();
badge.put("name", operation.getOperationId());
badge.put("color", apiConfiguration.getBadgeColor());
List<Map<String, String>> badgeList = new ArrayList<>();
badgeList.add(badge);
operation.setBadges(badgeList);
}

// -------------------------
// ----- PARAMETERS part----
// -------------------------
Expand Down
11 changes: 11 additions & 0 deletions openapi-maven-plugin/src/main/java/io/github/kbuntrock/yaml/model/Operation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ public class Operation {
@JsonProperty("x-operation-name")
@JsonInclude(JsonInclude.Include.NON_NULL)
private String loopbackOperationName;
@JsonProperty("x-badges")
@JsonInclude(JsonInclude.Include.NON_EMPTY)
private List<Map<String, String>> badges;
@JsonInclude(JsonInclude.Include.NON_NULL)
private String description;
@JsonInclude(JsonInclude.Include.NON_NULL)
Expand Down Expand Up @@ -118,4 +121,12 @@ public String getLoopbackOperationName() {
public void setLoopbackOperationName(final String loopbackOperationName) {
this.loopbackOperationName = loopbackOperationName;
}

public List<Map<String, String>> getBadges() {
return badges;
}

public void setBadges(final List<Map<String, String>> badges) {
this.badges = badges;
}
}
2 changes: 1 addition & 1 deletion ...en-plugin/src/test/resources-its/io/github/kbuntrock/it/BasicIT/nominal_test_case/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<maven-compiler-plugin.version>3.8.0</maven-compiler-plugin.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>
<openapi-plugin-project-version>0.0.31-dbeaver</openapi-plugin-project-version>
<openapi-plugin-project-version>0.0.32-dbeaver</openapi-plugin-project-version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

Expand Down
2 changes: 1 addition & 1 deletion ...gin/src/test/resources-its/io/github/kbuntrock/it/BasicIT/nominal_test_case_jaxrs/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<maven-compiler-plugin.version>3.8.0</maven-compiler-plugin.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>
<openapi-plugin-project-version>0.0.31-dbeaver</openapi-plugin-project-version>
<openapi-plugin-project-version>0.0.32-dbeaver</openapi-plugin-project-version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

Expand Down
2 changes: 1 addition & 1 deletion ...i-maven-plugin/src/test/resources-its/io/github/kbuntrock/it/BasicIT/sealed_class/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<maven-compiler-plugin.version>3.8.0</maven-compiler-plugin.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>
<openapi-plugin-project-version>0.0.31-dbeaver</openapi-plugin-project-version>
<openapi-plugin-project-version>0.0.32-dbeaver</openapi-plugin-project-version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

Expand Down
Loading