Package com.qdesrame.openapi.diff.output

Class MarkdownRender

java.lang.Object

com.qdesrame.openapi.diff.output.MarkdownRender

All Implemented Interfaces:

Render

public class MarkdownRender
extends Object
implements Render

Field Summary

Fields

Modifier and Type	Field	Description
protected String	BLOCKQUOTE
protected String	CODE
protected ChangedOpenApi	diff
protected String	H3
protected String	H4
protected String	H5
protected String	H6
protected String	HR
protected String	LI
static org.slf4j.Logger	LOGGER
protected String	PRE_CODE
protected String	PRE_LI
protected static RefPointer<io.swagger.v3.oas.models.media.Schema>	refPointer
protected boolean	showChangedMetadata	A paramater which indicates whether or not metadata (summary and metadata) changes should be logged in the changelog file.

Constructor Summary

Constructors

Constructor	Description
MarkdownRender()

Method Summary

Modifier and Type	Method	Description
protected String	blockquote(String beginning)
protected String	blockquote(String beginning, String text)
protected String	bodyContent(ChangedContent changedContent)
protected String	bodyContent(String prefix, ChangedContent changedContent)
protected String	code(String string)
protected String	headers(ChangedHeaders headers)
protected String	indent(int deepness)
protected String	itemContent(int deepness, String mediaType, ChangedMediaType content)
protected String	itemContent(String title, String mediaType)
protected String	itemContent(String title, String mediaType, io.swagger.v3.oas.models.media.MediaType content)
protected String	itemEndpoint(String method, String path, ChangedMetadata summary)
protected String	itemEndpoint(String method, String path, String summary)
protected String	itemHeader(String code, ChangedHeader header)
protected String	itemHeader(String title, String name, io.swagger.v3.oas.models.headers.Header header)
protected String	itemHeader(String title, String mediaType, String description)
protected String	itemParameter(ChangedParameter param)
protected String	itemParameter(String title, io.swagger.v3.oas.models.parameters.Parameter parameter)
protected String	itemParameter(String title, String name, String in, String description)
protected String	itemResponse(String code, ChangedResponse response)
protected String	itemResponse(String title, String code, io.swagger.v3.oas.models.responses.ApiResponse response)
protected String	itemResponse(String title, String code, String description)
protected String	items(int deepness, ChangedSchema schema)
protected String	items(int deepness, io.swagger.v3.oas.models.media.Schema schema, DiffContext context)
protected String	items(int deepness, String title, String type, String description)
protected String	listContent(String prefix, String title, Map<String,io.swagger.v3.oas.models.media.MediaType> mediaTypes)
protected String	listDiff(int deepness, String name, ChangedList<?> listDiff)
protected String	listEndpoints(String title, List<Endpoint> endpoints)
protected String	listEndpoints(List<ChangedOperation> changedOperations)
protected String	listHeader(String title, Map<String,io.swagger.v3.oas.models.headers.Header> headers)
protected <T> String	listItem(int deepness, String name, List<T> list)
protected String	listParameter(String title, List<io.swagger.v3.oas.models.parameters.Parameter> parameters)
protected String	listResponse(String title, Map<String,io.swagger.v3.oas.models.responses.ApiResponse> responses)
protected String	metadata(String metadata)
protected String	metadata(String name, ChangedMetadata changedMetadata)
protected String	metadata(String beginning, String metadata)
protected String	metadata(String beginning, String name, ChangedMetadata changedMetadata)
protected String	metadata(String beginning, String name, String metadata)
protected String	oneOfSchema(int deepness, ChangedOneOfSchema schema, String discriminator)
protected String	parameters(ChangedParameters changedParameters)
protected String	properties(int deepness, String title, Map<String,io.swagger.v3.oas.models.media.Schema> properties, boolean showContent, DiffContext context)
protected String	property(int deepness, String name, ChangedSchema schema)
protected String	property(int deepness, String title, String name, io.swagger.v3.oas.models.media.Schema schema)
protected String	property(int deepness, String title, String name, String type, String description)
String	render(ChangedOpenApi diff)
protected String	required(int deepness, String title, List<String> required)
protected io.swagger.v3.oas.models.media.Schema	resolve(io.swagger.v3.oas.models.media.Schema schema)
protected String	responses(ChangedApiResponse changedApiResponse)
protected String	schema(int deepness, ChangedSchema schema)
protected String	schema(int deepness, io.swagger.v3.oas.models.media.ComposedSchema schema, DiffContext context)
protected String	schema(int deepness, io.swagger.v3.oas.models.media.Schema schema, DiffContext context)
protected String	schema(ChangedSchema schema)
protected String	sectionTitle(String title)
protected String	titleH5(String title)
protected String	type(io.swagger.v3.oas.models.media.Schema schema)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

refPointer

protected static RefPointer<io.swagger.v3.oas.models.media.Schema> refPointer

H3

protected final String H3

See Also:

Constant Field Values

H4

protected final String H4

See Also:

Constant Field Values

H5

protected final String H5

See Also:

Constant Field Values

H6

protected final String H6

See Also:

Constant Field Values

BLOCKQUOTE

protected final String BLOCKQUOTE

See Also:

Constant Field Values

CODE

protected final String CODE

See Also:

Constant Field Values

PRE_CODE

protected final String PRE_CODE

See Also:

Constant Field Values

PRE_LI

protected final String PRE_LI

See Also:

Constant Field Values

LI

protected final String LI

See Also:

Constant Field Values

HR

protected final String HR

See Also:

Constant Field Values

diff

protected ChangedOpenApi diff

showChangedMetadata

protected boolean showChangedMetadata

A paramater which indicates whether or not metadata (summary and metadata) changes should be logged in the changelog file.

Constructor Detail

MarkdownRender

public MarkdownRender()

Method Detail

render

public String render(ChangedOpenApi diff)

Specified by:

render in interface Render

sectionTitle

protected String sectionTitle(String title)

listEndpoints

protected String listEndpoints(String title,
                               List<Endpoint> endpoints)

itemEndpoint

protected String itemEndpoint(String method,
                              String path,
                              String summary)

itemEndpoint

protected String itemEndpoint(String method,
                              String path,
                              ChangedMetadata summary)

titleH5

protected String titleH5(String title)

listEndpoints

protected String listEndpoints(List<ChangedOperation> changedOperations)

responses

protected String responses(ChangedApiResponse changedApiResponse)

listResponse

protected String listResponse(String title,
                              Map<String,io.swagger.v3.oas.models.responses.ApiResponse> responses)

itemResponse

protected String itemResponse(String title,
                              String code,
                              io.swagger.v3.oas.models.responses.ApiResponse response)

itemResponse

protected String itemResponse(String code,
                              ChangedResponse response)

itemResponse

protected String itemResponse(String title,
                              String code,
                              String description)

headers

protected String headers(ChangedHeaders headers)

listHeader

protected String listHeader(String title,
                            Map<String,io.swagger.v3.oas.models.headers.Header> headers)

itemHeader

protected String itemHeader(String title,
                            String name,
                            io.swagger.v3.oas.models.headers.Header header)

itemHeader

protected String itemHeader(String code,
                            ChangedHeader header)

itemHeader

protected String itemHeader(String title,
                            String mediaType,
                            String description)

bodyContent

protected String bodyContent(String prefix,
                             ChangedContent changedContent)

bodyContent

protected String bodyContent(ChangedContent changedContent)

listContent

protected String listContent(String prefix,
                             String title,
                             Map<String,io.swagger.v3.oas.models.media.MediaType> mediaTypes)

itemContent

protected String itemContent(String title,
                             String mediaType)

itemContent

protected String itemContent(String title,
                             String mediaType,
                             io.swagger.v3.oas.models.media.MediaType content)

itemContent

protected String itemContent(int deepness,
                             String mediaType,
                             ChangedMediaType content)

schema

protected String schema(ChangedSchema schema)

oneOfSchema

protected String oneOfSchema(int deepness,
                             ChangedOneOfSchema schema,
                             String discriminator)

required

protected String required(int deepness,
                          String title,
                          List<String> required)

schema

protected String schema(int deepness,
                        ChangedSchema schema)

schema

protected String schema(int deepness,
                        io.swagger.v3.oas.models.media.ComposedSchema schema,
                        DiffContext context)

schema

protected String schema(int deepness,
                        io.swagger.v3.oas.models.media.Schema schema,
                        DiffContext context)

items

protected String items(int deepness,
                       ChangedSchema schema)

items

protected String items(int deepness,
                       io.swagger.v3.oas.models.media.Schema schema,
                       DiffContext context)

items

protected String items(int deepness,
                       String title,
                       String type,
                       String description)

properties

protected String properties(int deepness,
                            String title,
                            Map<String,io.swagger.v3.oas.models.media.Schema> properties,
                            boolean showContent,
                            DiffContext context)

property

protected String property(int deepness,
                          String name,
                          ChangedSchema schema)

property

protected String property(int deepness,
                          String title,
                          String name,
                          io.swagger.v3.oas.models.media.Schema schema)

property

protected String property(int deepness,
                          String title,
                          String name,
                          String type,
                          String description)

listDiff

protected String listDiff(int deepness,
                          String name,
                          ChangedList<?> listDiff)

listItem

protected <T> String listItem(int deepness,
                              String name,
                              List<T> list)

parameters

protected String parameters(ChangedParameters changedParameters)

listParameter

protected String listParameter(String title,
                               List<io.swagger.v3.oas.models.parameters.Parameter> parameters)

itemParameter

protected String itemParameter(String title,
                               io.swagger.v3.oas.models.parameters.Parameter parameter)

itemParameter

protected String itemParameter(String title,
                               String name,
                               String in,
                               String description)

itemParameter

protected String itemParameter(ChangedParameter param)

code

protected String code(String string)

metadata

protected String metadata(String name,
                          ChangedMetadata changedMetadata)

metadata

protected String metadata(String beginning,
                          String name,
                          ChangedMetadata changedMetadata)

metadata

protected String metadata(String metadata)

metadata

protected String metadata(String beginning,
                          String name,
                          String metadata)

metadata

protected String metadata(String beginning,
                          String metadata)

blockquote

protected String blockquote(String beginning)

blockquote

protected String blockquote(String beginning,
                            String text)

type

protected String type(io.swagger.v3.oas.models.media.Schema schema)

indent

protected String indent(int deepness)

resolve

protected io.swagger.v3.oas.models.media.Schema resolve(io.swagger.v3.oas.models.media.Schema schema)