Skip to content

fix(#766): include API identifiers and compatibility result in Markdown output #854

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 1 commit into from
Nov 3, 2025
Merged

fix(#766): include API identifiers and compatibility result in Markdown output #854

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
29 changes: 29 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 @@ -51,17 +51,46 @@ public class MarkdownRender implements Render {
public void render(ChangedOpenApi diff, OutputStreamWriter outputStreamWriter) {
this.diff = diff;
this.handledSchemas.clear();

apiTitle(
diff.getNewSpecOpenApi().getInfo().getTitle(),
diff.getNewSpecOpenApi().getInfo().getVersion(),
outputStreamWriter);
listEndpoints("What's New", diff.getNewEndpoints(), outputStreamWriter);
listEndpoints("What's Deleted", diff.getMissingEndpoints(), outputStreamWriter);
listEndpoints("What's Deprecated", diff.getDeprecatedEndpoints(), outputStreamWriter);
listEndpoints(diff.getChangedOperations(), outputStreamWriter);
changeSummary("Result", diff, outputStreamWriter);
try {
outputStreamWriter.close();
} catch (IOException e) {
throw new RendererException(e);
}
}

protected String bigTitle(String title) {
return H3 + title + '\n' + HR + '\n';
}

protected void apiTitle(String title, String version, OutputStreamWriter outputStreamWriter) {
safelyAppend(outputStreamWriter, bigTitle(title + " (v " + version + ")"));
}

protected void changeSummary(
String title, ChangedOpenApi diff, OutputStreamWriter outputStreamWriter) {
safelyAppend(outputStreamWriter, sectionTitle(title));

if (diff.isUnchanged()) {
safelyAppend(outputStreamWriter, "No differences. Specifications are equivalent");
} else if (diff.isCompatible()) {
safelyAppend(outputStreamWriter, "API changes are backward compatible");
} else {
safelyAppend(outputStreamWriter, "API changes broke backward compatibility");
}

safelyAppend(outputStreamWriter, "\n\n");
}

protected String sectionTitle(String title) {
return H4 + title + '\n' + HR + '\n';
}
Expand Down