Skip to content

fix for issue 834 #835

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
merged 2 commits into from
Sep 25, 2025
Merged

fix for issue 834 #835

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ceec140
changed different line separators in AsciiDocRender.java to make it c…
wexom Sep 23, 2025
7b3b845
changed \n in AsciiRender to System.lineSeparator() in all places and…
wexom Sep 24, 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
28 changes: 14 additions & 14 deletions 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 @@ -32,18 +32,18 @@ public void render(ChangedOpenApi diff, OutputStreamWriter outputStreamWriter) {
bigTitle(
diff.getNewSpecOpenApi().getInfo().getTitle(),
diff.getNewSpecOpenApi().getInfo().getVersion()));
safelyAppend(outputStreamWriter, System.lineSeparator());
safelyAppend(outputStreamWriter, System.lineSeparator());
safelyAppend(outputStreamWriter, "\n");
safelyAppend(outputStreamWriter, "\n");
safelyAppend(outputStreamWriter, "NOTE: No differences. Specifications are equivalents");
} else {
safelyAppend(
outputStreamWriter,
bigTitle(
diff.getNewSpecOpenApi().getInfo().getTitle(),
diff.getNewSpecOpenApi().getInfo().getVersion()));
safelyAppend(outputStreamWriter, System.lineSeparator());
safelyAppend(outputStreamWriter, "\n");
safelyAppend(outputStreamWriter, ":reproducible:\n:sectlinks:\n:toc:\n");
safelyAppend(outputStreamWriter, System.lineSeparator());
safelyAppend(outputStreamWriter, "\n");

List<Endpoint> newEndpoints = diff.getNewEndpoints();
listEndpoints(newEndpoints, "What's New", outputStreamWriter);
Expand All @@ -57,13 +57,13 @@ public void render(ChangedOpenApi diff, OutputStreamWriter outputStreamWriter) {
List<ChangedOperation> changedOperations = diff.getChangedOperations();
ol_changed(changedOperations, outputStreamWriter);

safelyAppend(outputStreamWriter, System.lineSeparator());
safelyAppend(outputStreamWriter, "\n");
safelyAppend(
outputStreamWriter,
diff.isCompatible()
? "NOTE: API changes are backward compatible"
: "WARNING: API changes broke backward compatibility");
safelyAppend(outputStreamWriter, System.lineSeparator());
safelyAppend(outputStreamWriter, "\n");
}
try {
outputStreamWriter.close();
Expand All @@ -78,7 +78,7 @@ private void ol_changed(
return;
}
safelyAppend(outputStreamWriter, title("What's Changed", 2));
safelyAppend(outputStreamWriter, System.lineSeparator());
safelyAppend(outputStreamWriter, "\n");
for (ChangedOperation operation : operations) {
String pathUrl = operation.getPathUrl();
String method = operation.getHttpMethod().toString();
Expand All @@ -89,18 +89,18 @@ private void ol_changed(
if (result(operation.getParameters()).isDifferent()) {
safelyAppend(outputStreamWriter, "* Parameter:\n");
safelyAppend(outputStreamWriter, ul_param(operation.getParameters()));
safelyAppend(outputStreamWriter, System.lineSeparator());
safelyAppend(outputStreamWriter, "\n");
}
if (operation.resultRequestBody().isDifferent()) {
safelyAppend(outputStreamWriter, "* Request:\n");
safelyAppend(
outputStreamWriter, ul_content(operation.getRequestBody().getContent(), true, 2));
safelyAppend(outputStreamWriter, System.lineSeparator());
safelyAppend(outputStreamWriter, "\n");
}
if (operation.resultApiResponses().isDifferent()) {
safelyAppend(outputStreamWriter, "* Return Type:\n");
safelyAppend(outputStreamWriter, ul_response(operation.getApiResponses()));
safelyAppend(outputStreamWriter, System.lineSeparator());
safelyAppend(outputStreamWriter, "\n");
}
}
}
Expand Down Expand Up @@ -226,7 +226,7 @@ protected String property(String name, String title, Schema<?> schema) {
}

protected String property(String name, String title, String type) {
return String.format("*** %s: %s (%s)%n\n", title, name, type);
return String.format("*** %s: %s (%s)\n\n", title, name, type);
}

protected Schema<?> resolve(Schema<?> schema) {
Expand Down Expand Up @@ -264,7 +264,7 @@ private String ul_param(ChangedParameters changedParameters) {
}

private String itemParam(String title, Parameter param) {
return title + param.getName() + " in " + param.getIn() + System.lineSeparator();
return title + param.getName() + " in " + param.getIn() + "\n";
}

private String li_changedParam(ChangedParameter changeParam) {
Expand All @@ -287,11 +287,11 @@ private String listEndpoints(
itemEndpoint(
endpoint.getMethod().toString(), endpoint.getPathUrl(), endpoint.getSummary()));
}
return sb.append(System.lineSeparator()).toString();
return sb.append("\n").toString();
}

private String itemEndpoint(String method, String path, String desc) {
return String.format("=== %s%s%n", StringUtils.rightPad(method, 6), path);
return String.format("=== %s%s\n", StringUtils.rightPad(method, 6), path);
}

public String bigTitle(String title, String version) {
Expand Down