Package org.openapitools.codegen.utils

Class ExamplesUtils

java.lang.Object

org.openapitools.codegen.utils.ExamplesUtils

public class ExamplesUtils
extends Object

Constructor Summary

Constructors

Constructor	Description
ExamplesUtils()

Method Summary

Modifier and Type	Method	Description
static Map<String,io.swagger.v3.oas.models.examples.Example>	getExamplesFromResponse(io.swagger.v3.oas.models.OpenAPI openAPI, io.swagger.v3.oas.models.responses.ApiResponse response)	Return examples of API response.
static List<Map<String,Object>>	unaliasExamples(io.swagger.v3.oas.models.OpenAPI openapi, Map<String,io.swagger.v3.oas.models.examples.Example> apiRespExamples)	Return actual examples objects of API response with values and processed from references (unaliased)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExamplesUtils

public ExamplesUtils()

Method Detail

getExamplesFromResponse

public static Map<String,io.swagger.v3.oas.models.examples.Example> getExamplesFromResponse(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                                                  io.swagger.v3.oas.models.responses.ApiResponse response)

Return examples of API response.

Parameters:

openAPI - OpenAPI spec.

response - ApiResponse of the operation

Returns:

examples of API response

unaliasExamples

public static List<Map<String,Object>> unaliasExamples(io.swagger.v3.oas.models.OpenAPI openapi,
                                                             Map<String,io.swagger.v3.oas.models.examples.Example> apiRespExamples)

Return actual examples objects of API response with values and processed from references (unaliased)

Parameters:

openapi - OpenAPI spec.

apiRespExamples - examples of API response

Returns:

unaliased examples of API response