Skip to content

Feature: Add rendering support for operation ID diff #881

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

Open
issy wants to merge 7 commits into
base: master
Choose a base branch
from
+58 −1
Open

Feature: Add rendering support for operation ID diff #881

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9cb95f8
Render operation ID changed info
issy Jan 1, 2026
2c682fd
Use safe operation
issy Jan 1, 2026
530687e
Implement operation ID diffing in ConsoleRender
issy Jan 1, 2026
2c54cd9
Implement ascii rendering
issy Jan 1, 2026
66582ff
Implement HTML rendering for Operation ID change
issy Jan 1, 2026
3aa00d3
Fix rendering in HTML
issy Jan 1, 2026
5c1b752
Null check
issy Jan 1, 2026
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
20 changes: 19 additions & 1 deletion core/src/main/java/org/openapitools/openapidiff/core/output/AsciidocRender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,19 @@
import java.util.Optional;
import org.apache.commons.lang3.StringUtils;
import org.openapitools.openapidiff.core.exception.RendererException;
import org.openapitools.openapidiff.core.model.*;
import org.openapitools.openapidiff.core.model.ChangedApiResponse;
import org.openapitools.openapidiff.core.model.ChangedContent;
import org.openapitools.openapidiff.core.model.ChangedMediaType;
import org.openapitools.openapidiff.core.model.ChangedMetadata;
import org.openapitools.openapidiff.core.model.ChangedOpenApi;
import org.openapitools.openapidiff.core.model.ChangedOperation;
import org.openapitools.openapidiff.core.model.ChangedParameter;
import org.openapitools.openapidiff.core.model.ChangedParameters;
import org.openapitools.openapidiff.core.model.ChangedResponse;
import org.openapitools.openapidiff.core.model.ChangedSchema;
import org.openapitools.openapidiff.core.model.DiffContext;
import org.openapitools.openapidiff.core.model.DiffResult;
import org.openapitools.openapidiff.core.model.Endpoint;
import org.openapitools.openapidiff.core.utils.RefPointer;
import org.openapitools.openapidiff.core.utils.RefType;

Expand Down Expand Up @@ -92,6 +104,12 @@ private void ol_changed(

safelyAppend(outputStreamWriter, itemEndpoint(method, pathUrl, desc));
safelyAppend(outputStreamWriter, System.lineSeparator());
if (result(operation.getOperationId()).isDifferent()) {
safelyAppend(outputStreamWriter, "* Operation ID:");
safelyAppend(outputStreamWriter, System.lineSeparator());
safelyAppend(outputStreamWriter, String.format("** Changed %s to %s", operation.getOperationId().getLeft(), operation.getOperationId().getRight()));
safelyAppend(outputStreamWriter, System.lineSeparator());
}
if (result(operation.getParameters()).isDifferent()) {
safelyAppend(outputStreamWriter, "* Parameter:");
safelyAppend(outputStreamWriter, System.lineSeparator());
Expand Down
11 changes: 11 additions & 0 deletions core/src/main/java/org/openapitools/openapidiff/core/output/ConsoleRender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import org.apache.commons.lang3.StringUtils;
import org.openapitools.openapidiff.core.exception.RendererException;
import org.openapitools.openapidiff.core.model.*;
import org.openapitools.openapidiff.core.model.schema.ChangedOperationId;
import org.openapitools.openapidiff.core.utils.RefPointer;
import org.openapitools.openapidiff.core.utils.RefType;

Expand Down Expand Up @@ -79,6 +80,12 @@ private void ol_changed(

safelyAppend(outputStreamWriter, itemEndpoint(method, pathUrl, desc));

if (result(operation.getOperationId()).isDifferent()) {
safelyAppend(outputStreamWriter, StringUtils.repeat(' ', 2));
safelyAppend(outputStreamWriter, "Operation ID:");
safelyAppend(outputStreamWriter, System.lineSeparator());
safelyAppend(outputStreamWriter, ul_operation_id(operation.getOperationId()));
}
if (result(operation.getParameters()).isDifferent()) {
safelyAppend(outputStreamWriter, StringUtils.repeat(' ', 2));
safelyAppend(outputStreamWriter, "Parameter:");
Expand Down Expand Up @@ -301,6 +308,10 @@ private String itemEndpoint(String method, String path, String desc) {
return String.format("- %s %s%n", StringUtils.rightPad(method, 6), path);
}

private String ul_operation_id(ChangedOperationId operationId) {
return String.format(" - Changed %s to %s\n", operationId.getLeft(), operationId.getRight());
}

public String renderBody(String ol_new, String ol_miss, String ol_deprec, String ol_changed) {
return ol_new + ol_miss + ol_deprec + ol_changed;
}
Expand Down
19 changes: 19 additions & 0 deletions core/src/main/java/org/openapitools/openapidiff/core/output/HtmlRender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import static j2html.TagCreator.meta;
import static j2html.TagCreator.ol;
import static j2html.TagCreator.p;
import static j2html.TagCreator.pre;
import static j2html.TagCreator.span;
import static j2html.TagCreator.title;
import static j2html.TagCreator.ul;
Expand All @@ -33,6 +34,7 @@
import j2html.tags.specialized.HtmlTag;
import j2html.tags.specialized.LiTag;
import j2html.tags.specialized.OlTag;
import j2html.tags.specialized.SpanTag;
import j2html.tags.specialized.UlTag;
import java.io.IOException;
import java.io.OutputStreamWriter;
Expand All @@ -56,6 +58,7 @@
import org.openapitools.openapidiff.core.model.DiffContext;
import org.openapitools.openapidiff.core.model.DiffResult;
import org.openapitools.openapidiff.core.model.Endpoint;
import org.openapitools.openapidiff.core.model.schema.ChangedOperationId;
import org.openapitools.openapidiff.core.utils.RefPointer;
import org.openapitools.openapidiff.core.utils.RefType;

Expand Down Expand Up @@ -202,6 +205,11 @@ private OlTag ol_changed(List<ChangedOperation> changedOperations) {
.orElse("");

UlTag ul_detail = ul().withClass("detail");
if (result(changedOperation.getOperationId()).isDifferent()) {
ul_detail.with(
li().with(h3("Operation ID")).with(ul_operation_id(changedOperation.getOperationId()))
);
}
if (result(changedOperation.getParameters()).isDifferent()) {
ul_detail.with(
li().with(h3("Parameters")).with(ul_param(changedOperation.getParameters())));
Expand Down Expand Up @@ -561,4 +569,15 @@ private LiTag li_changedParam(ChangedParameter changeParam) {
}
return li;
}

private UlTag ul_operation_id(ChangedOperationId changedOperationId) {
return ul().withClass("change").with(
li().withText(
"Changed " +
Optional.ofNullable(changedOperationId.getLeft()).orElse("") +
" to " +
Optional.ofNullable(changedOperationId.getRight()).orElse("")
)
);
}
}
9 changes: 9 additions & 0 deletions core/src/main/java/org/openapitools/openapidiff/core/output/MarkdownRender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import org.openapitools.openapidiff.core.exception.RendererException;
import org.openapitools.openapidiff.core.model.*;
import org.openapitools.openapidiff.core.model.schema.ChangedOneOfSchema;
import org.openapitools.openapidiff.core.model.schema.ChangedOperationId;
import org.openapitools.openapidiff.core.utils.RefPointer;
import org.openapitools.openapidiff.core.utils.RefType;
import org.slf4j.Logger;
Expand Down Expand Up @@ -132,6 +133,10 @@ protected void listEndpoints(
operation.getHttpMethod().toString(),
operation.getPathUrl(),
operation.getSummary()));
if (result(operation.getOperationId()).isDifferent()) {
safelyAppend(outputStreamWriter, titleH5("Operation ID:"));
safelyAppend(outputStreamWriter, operationId(operation.getOperationId()));
}
if (result(operation.getParameters()).isDifferent()) {
safelyAppend(outputStreamWriter, titleH5("Parameters:"));
safelyAppend(outputStreamWriter, parameters(operation.getParameters()));
Expand Down Expand Up @@ -541,6 +546,10 @@ protected String metadata(String beginning, String name, ChangedMetadata changed
}
}

protected String operationId(ChangedOperationId operationId) {
return String.format("\nChanged: %s to %s\n\n", code(operationId.getLeft()), code(operationId.getRight()));
}

protected String metadata(String metadata) {
return metadata("", metadata);
}
Expand Down