Package io.kestra.core.docs

Class AbstractClassDocumentation<T>

java.lang.Object

io.kestra.core.docs.AbstractClassDocumentation<T>

Direct Known Subclasses:

ClassInputDocumentation, ClassPluginDocumentation

public abstract class AbstractClassDocumentation<T>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractClassDocumentation.ExampleDoc

Field Summary

Fields

Modifier and Type	Field	Description
protected String	cls
protected Map<String,Object>	defs
protected Boolean	deprecated
protected String	docBody
protected String	docDescription
protected List<AbstractClassDocumentation.ExampleDoc>	docExamples
protected Map<String,Object>	inputs
protected Map<String,Object>	propertiesSchema
protected String	shortName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractClassDocumentation(JsonSchemaGenerator jsonSchemaGenerator, Class<? extends T> cls, Class<T> baseCls)

Method Summary

Modifier and Type	Method	Description
protected static Map<String,Object>	flatten(Map<String,Object> map, List<String> required)
protected static Map<String,Object>	flatten(Map<String,Object> map, List<String> required, String parentName)
protected static String	flattenKey(String current, String parent)
protected static Map<String,Object>	properties(Map<String,Object> props)
protected static List<String>	required(Map<String,Object> props)

Methods inherited from class java.lang.Object

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

Field Details

deprecated

protected Boolean deprecated

cls

protected String cls

shortName

protected String shortName

docDescription

protected String docDescription

docBody

protected String docBody

docExamples

protected List<AbstractClassDocumentation.ExampleDoc> docExamples

defs

protected Map<String,Object> defs

inputs

protected Map<String,Object> inputs

propertiesSchema

protected Map<String,Object> propertiesSchema

Constructor Details

AbstractClassDocumentation

protected AbstractClassDocumentation(JsonSchemaGenerator jsonSchemaGenerator,
 Class<? extends T> cls,
 Class<T> baseCls)

Method Details

flatten

protected static Map<String,Object> flatten(Map<String,Object> map,
 List<String> required)

flatten

protected static Map<String,Object> flatten(Map<String,Object> map,
 List<String> required,
 String parentName)

flattenKey

protected static String flattenKey(String current,
 String parent)

properties

protected static Map<String,Object> properties(Map<String,Object> props)

required

protected static List<String> required(Map<String,Object> props)