com.atlassian.confluence.plugins.restapi.enrich.documentation

Class RequestEntityEnricher

java.lang.Object

com.atlassian.confluence.plugins.restapi.enrich.documentation.RequestEntityEnricher

All Implemented Interfaces:

EntityEnricher, RestObjectEnricher

public class RequestEntityEnricher
extends Object
implements EntityEnricher

Removes _links and _expandable fields from request objects.

Constructor Summary

Constructors

Constructor and Description
RequestEntityEnricher()

Method Summary

Modifier and Type	Method and Description
void	enrich(RestEntity entity, SchemaType schemaType)
Map<String,Type>	getEnrichedPropertyTypes(Type type) Get the types of the properties that may possibly be provided by this enricher.
boolean	isRecursive() Get whether the enricher applies to the root object only, or recursively to all objects in the tree.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestEntityEnricher

public RequestEntityEnricher()

Method Detail

isRecursive

public boolean isRecursive()

Description copied from interface: RestObjectEnricher

Get whether the enricher applies to the root object only, or recursively to all objects in the tree.

Specified by:

isRecursive in interface RestObjectEnricher

getEnrichedPropertyTypes

@Nonnull
public Map<String,Type> getEnrichedPropertyTypes(@Nonnull
                                                          Type type)

Description copied from interface: RestObjectEnricher

Get the types of the properties that may possibly be provided by this enricher. This is used to populate the graph-ql schema.

Specified by:

getEnrichedPropertyTypes in interface RestObjectEnricher

Parameters:

type - The type of the object being enriched

Returns:

A map of property names to property types

enrich

public void enrich(@Nonnull
                   RestEntity entity,
                   SchemaType schemaType)

Specified by:

enrich in interface EntityEnricher