Skip to content

Commit 0392a1f

Browse files
committed
fix(output): add metadata description in request body section
1 parent 95ed847 commit 0392a1f

File tree

1 file changed

+12
-32
lines changed

1 file changed

+12
-32
lines changed

src/main/java/com/qdesrame/openapi/diff/output/MarkdownRender.java

+12-32
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,7 @@ protected String sectionTitle(String title) {
6363
protected String listEndpoints(String title, List<Endpoint> endpoints) {
6464
if (null == endpoints || endpoints.size() == 0) return "";
6565
StringBuilder sb = new StringBuilder(sectionTitle(title));
66-
endpoints
67-
.stream()
66+
endpoints.stream()
6867
.map(e -> itemEndpoint(e.getMethod().toString(), e.getPathUrl(), e.getSummary()))
6968
.forEach(sb::append);
7069
return sb.toString();
@@ -85,8 +84,7 @@ protected String titleH5(String title) {
8584
protected String listEndpoints(List<ChangedOperation> changedOperations) {
8685
if (null == changedOperations || changedOperations.size() == 0) return "";
8786
StringBuilder sb = new StringBuilder(sectionTitle("What's Changed"));
88-
changedOperations
89-
.stream()
87+
changedOperations.stream()
9088
.map(
9189
operation -> {
9290
StringBuilder details =
@@ -104,6 +102,7 @@ protected String listEndpoints(List<ChangedOperation> changedOperations) {
104102
if (operation.resultRequestBody().isDifferent()) {
105103
details
106104
.append(titleH5("Request:"))
105+
.append(metadata("Description", operation.getRequestBody().getDescription()))
107106
.append(bodyContent(operation.getRequestBody().getContent()));
108107
}
109108
if (operation.resultApiResponses().isDifferent()) {
@@ -121,20 +120,15 @@ protected String responses(ChangedApiResponse changedApiResponse) {
121120
StringBuilder sb = new StringBuilder("\n");
122121
sb.append(listResponse("New response", changedApiResponse.getIncreased()));
123122
sb.append(listResponse("Deleted response", changedApiResponse.getMissing()));
124-
changedApiResponse
125-
.getChanged()
126-
.entrySet()
127-
.stream()
123+
changedApiResponse.getChanged().entrySet().stream()
128124
.map(e -> this.itemResponse(e.getKey(), e.getValue()))
129125
.forEach(sb::append);
130126
return sb.toString();
131127
}
132128

133129
protected String listResponse(String title, Map<String, ApiResponse> responses) {
134130
StringBuilder sb = new StringBuilder();
135-
responses
136-
.entrySet()
137-
.stream()
131+
responses.entrySet().stream()
138132
.map(e -> this.itemResponse(title, e.getKey(), e.getValue()))
139133
.forEach(sb::append);
140134
return sb.toString();
@@ -176,10 +170,7 @@ protected String headers(ChangedHeaders headers) {
176170
if (headers != null) {
177171
sb.append(listHeader("New header", headers.getIncreased()));
178172
sb.append(listHeader("Deleted header", headers.getMissing()));
179-
headers
180-
.getChanged()
181-
.entrySet()
182-
.stream()
173+
headers.getChanged().entrySet().stream()
183174
.map(e -> this.itemHeader(e.getKey(), e.getValue()))
184175
.forEach(sb::append);
185176
}
@@ -188,9 +179,7 @@ protected String headers(ChangedHeaders headers) {
188179

189180
protected String listHeader(String title, Map<String, Header> headers) {
190181
StringBuilder sb = new StringBuilder();
191-
headers
192-
.entrySet()
193-
.stream()
182+
headers.entrySet().stream()
194183
.map(e -> this.itemHeader(title, e.getKey(), e.getValue()))
195184
.forEach(sb::append);
196185
return sb.toString();
@@ -224,10 +213,7 @@ protected String bodyContent(String prefix, ChangedContent changedContent) {
224213
} else {
225214
deepness = 0;
226215
}
227-
changedContent
228-
.getChanged()
229-
.entrySet()
230-
.stream()
216+
changedContent.getChanged().entrySet().stream()
231217
.map(e -> this.itemContent(deepness, e.getKey(), e.getValue()))
232218
.forEach(e -> sb.append(prefix).append(e));
233219
return sb.toString();
@@ -239,9 +225,7 @@ protected String bodyContent(ChangedContent changedContent) {
239225

240226
protected String listContent(String prefix, String title, Map<String, MediaType> mediaTypes) {
241227
StringBuilder sb = new StringBuilder();
242-
mediaTypes
243-
.entrySet()
244-
.stream()
228+
mediaTypes.entrySet().stream()
245229
.map(e -> this.itemContent(title, e.getKey(), e.getValue()))
246230
.forEach(e -> sb.append(prefix).append(e));
247231
return sb.toString();
@@ -339,18 +323,14 @@ protected String schema(int deepness, ComposedSchema schema, DiffContext context
339323
StringBuilder sb = new StringBuilder();
340324
if (schema.getAllOf() != null && schema.getAllOf() != null) {
341325
LOGGER.debug("All of schema");
342-
schema
343-
.getAllOf()
344-
.stream()
326+
schema.getAllOf().stream()
345327
.map(this::resolve)
346328
.forEach(composedChild -> sb.append(schema(deepness, composedChild, context)));
347329
}
348330
if (schema.getOneOf() != null && schema.getOneOf() != null) {
349331
LOGGER.debug("One of schema");
350332
sb.append(format("%sOne of:\n\n", indent(deepness)));
351-
schema
352-
.getOneOf()
353-
.stream()
333+
schema.getOneOf().stream()
354334
.map(this::resolve)
355335
.forEach(composedChild -> sb.append(schema(deepness + 1, composedChild, context)));
356336
}
@@ -502,7 +482,7 @@ protected String metadata(String beginning, String name, ChangedMetadata changed
502482
if (changedMetadata == null) {
503483
return "";
504484
}
505-
if (isUnchanged(changedMetadata) && showChangedMetadata) {
485+
if (!isUnchanged(changedMetadata) && showChangedMetadata) {
506486
return format(
507487
"Changed %s:\n%s\nto:\n%s\n\n",
508488
name,

0 commit comments

Comments
 (0)