A B C D E F G H I J L M N O P R S T V W _

A

AbstractJacksonFieldSnippet - Class in capital.scalable.restdocs.payload

AbstractJacksonFieldSnippet(String, Map<String, Object>) - Constructor for class capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

accept(JsonNode) - Method in interface capital.scalable.restdocs.response.JsonNodeConsumer

addDot(String) - Static method in class capital.scalable.restdocs.util.FormatUtil

apply(JsonNode) - Method in interface capital.scalable.restdocs.response.JsonNodeFilter

ArrayLimitingJsonContentModifier - Class in capital.scalable.restdocs.response

ArrayLimitingJsonContentModifier(ObjectMapper) - Constructor for class capital.scalable.restdocs.response.ArrayLimitingJsonContentModifier

arrayToString(Object[]) - Static method in class capital.scalable.restdocs.util.FormatUtil

ASCIIDOC - Static variable in class capital.scalable.restdocs.util.TemplateFormatting

assertAllDocumented(Collection<FieldDescriptor>, String) - Static method in class capital.scalable.restdocs.util.FieldDescriptorUtil

authorization(String) - Static method in class capital.scalable.restdocs.AutoDocumentation

authorizationDescription(Operation) - Method in class capital.scalable.restdocs.misc.AuthorizationSnippet

AuthorizationSnippet - Class in capital.scalable.restdocs.misc

AuthorizationSnippet(String) - Constructor for class capital.scalable.restdocs.misc.AuthorizationSnippet

AUTO_AUTHORIZATION - Static variable in class capital.scalable.restdocs.SnippetRegistry

AUTO_DESCRIPTION - Static variable in class capital.scalable.restdocs.SnippetRegistry

AUTO_EMBEDDED - Static variable in class capital.scalable.restdocs.SnippetRegistry

AUTO_LINKS - Static variable in class capital.scalable.restdocs.SnippetRegistry

AUTO_METHOD_PATH - Static variable in class capital.scalable.restdocs.SnippetRegistry

AUTO_MODELATTRIBUTE - Static variable in class capital.scalable.restdocs.SnippetRegistry

AUTO_PATH_PARAMETERS - Static variable in class capital.scalable.restdocs.SnippetRegistry

AUTO_REQUEST_FIELDS - Static variable in class capital.scalable.restdocs.SnippetRegistry

AUTO_REQUEST_HEADERS - Static variable in class capital.scalable.restdocs.SnippetRegistry

AUTO_REQUEST_PARAMETERS - Static variable in class capital.scalable.restdocs.SnippetRegistry

AUTO_RESPONSE_FIELDS - Static variable in class capital.scalable.restdocs.SnippetRegistry

AutoDocumentation - Class in capital.scalable.restdocs

B

BINARY_ENUM_TYPES - Static variable in class capital.scalable.restdocs.response.BinaryReplacementContentModifier

BinaryReplacementContentModifier - Class in capital.scalable.restdocs.response

BinaryReplacementContentModifier() - Constructor for class capital.scalable.restdocs.response.BinaryReplacementContentModifier

build() - Method in class capital.scalable.restdocs.section.SectionBuilder

C

capital.scalable.restdocs - package capital.scalable.restdocs

capital.scalable.restdocs.constraints - package capital.scalable.restdocs.constraints

capital.scalable.restdocs.hypermedia - package capital.scalable.restdocs.hypermedia

capital.scalable.restdocs.i18n - package capital.scalable.restdocs.i18n

capital.scalable.restdocs.jackson - package capital.scalable.restdocs.jackson

capital.scalable.restdocs.javadoc - package capital.scalable.restdocs.javadoc

capital.scalable.restdocs.misc - package capital.scalable.restdocs.misc

capital.scalable.restdocs.payload - package capital.scalable.restdocs.payload

capital.scalable.restdocs.request - package capital.scalable.restdocs.request

capital.scalable.restdocs.response - package capital.scalable.restdocs.response

capital.scalable.restdocs.section - package capital.scalable.restdocs.section

capital.scalable.restdocs.snippet - package capital.scalable.restdocs.snippet

capital.scalable.restdocs.util - package capital.scalable.restdocs.util

capital.scalable.restdocs.webflux - package capital.scalable.restdocs.webflux

collectionToString(Collection<?>) - Static method in class capital.scalable.restdocs.util.FormatUtil

ConstraintAndGroupDescriptionResolver - Class in capital.scalable.restdocs.constraints

ConstraintAndGroupDescriptionResolver(ConstraintDescriptionResolver, SnippetTranslationResolver) - Constructor for class capital.scalable.restdocs.constraints.ConstraintAndGroupDescriptionResolver

ConstraintReader - Interface in capital.scalable.restdocs.constraints

ConstraintReaderImpl - Class in capital.scalable.restdocs.constraints

CONSTRAINTS_ATTRIBUTE - Static variable in interface capital.scalable.restdocs.constraints.ConstraintReader

constructPropertyCollector(MapperConfig<?>, AnnotatedClass, JavaType, boolean, String) - Method in class capital.scalable.restdocs.jackson.SardObjectMapper.SardClassIntrospector

convertFromJavadoc(String, TemplateFormatting) - Static method in class capital.scalable.restdocs.javadoc.JavadocUtil

create(ObjectMapper, SnippetTranslationResolver, ConstraintDescriptionResolver) - Static method in class capital.scalable.restdocs.constraints.ConstraintReaderImpl

createFieldDescriptors(Operation, HandlerMethod) - Method in class capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

createFieldDescriptors(Operation, HandlerMethod) - Method in class capital.scalable.restdocs.snippet.StandardTableSnippet

createModel(Operation) - Method in class capital.scalable.restdocs.misc.AuthorizationSnippet

createModel(Operation) - Method in class capital.scalable.restdocs.misc.DescriptionSnippet

createModel(Operation) - Method in class capital.scalable.restdocs.misc.MethodAndPathSnippet

createModel(Operation) - Method in class capital.scalable.restdocs.section.SectionSnippet

createModel(Operation) - Method in class capital.scalable.restdocs.snippet.StandardTableSnippet

createModelForDescriptor(FieldDescriptor, TemplateFormatting, SnippetTranslationResolver) - Method in class capital.scalable.restdocs.snippet.StandardTableSnippet

createSections(Operation, SnippetTranslationResolver) - Method in class capital.scalable.restdocs.section.SectionSnippet

createWithSystemProperty() - Static method in class capital.scalable.restdocs.javadoc.JavadocReaderImpl

CURL_REQUEST - Static variable in class capital.scalable.restdocs.SnippetRegistry

D

DEFAULT_SNIPPETS - Static variable in class capital.scalable.restdocs.section.SectionBuilder

DEFAULT_VALUE_ATTRIBUTE - Static variable in interface capital.scalable.restdocs.constraints.ConstraintReader

defaultTranslation() - Static method in class capital.scalable.restdocs.i18n.TranslationHandlers

DEPRECATED_ATTRIBUTE - Static variable in interface capital.scalable.restdocs.constraints.ConstraintReader

DeprecatedAttribute - Class in capital.scalable.restdocs.jackson

DeprecatedAttribute(boolean, List<String>) - Constructor for class capital.scalable.restdocs.jackson.DeprecatedAttribute

description() - Static method in class capital.scalable.restdocs.AutoDocumentation

DescriptionSnippet - Class in capital.scalable.restdocs.misc

DescriptionSnippet() - Constructor for class capital.scalable.restdocs.misc.DescriptionSnippet

determineArrayOfType(JavaType) - Static method in class capital.scalable.restdocs.util.TypeUtil

determineTemplateFormatting(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

determineTemplateFormatting(TemplateFormat) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

determineTypeName(Class<?>) - Static method in class capital.scalable.restdocs.util.TypeUtil

documentationType(Type) - Method in class capital.scalable.restdocs.hypermedia.EmbeddedSnippet

documentationType(Type) - Method in class capital.scalable.restdocs.hypermedia.LinksSnippet

documentAuthorization(MockHttpServletRequest, String) - Static method in class capital.scalable.restdocs.misc.AuthorizationSnippet

DynamicResourceBundleConstraintDescriptionResolver - Class in capital.scalable.restdocs.constraints

Same as ResourceBundleConstraintDescriptionResolver but with ability to evaluate constraint's message attribute before falling back to property files.

DynamicResourceBundleConstraintDescriptionResolver() - Constructor for class capital.scalable.restdocs.constraints.DynamicResourceBundleConstraintDescriptionResolver

DynamicResourceBundleConstraintDescriptionResolver(ResourceBundle) - Constructor for class capital.scalable.restdocs.constraints.DynamicResourceBundleConstraintDescriptionResolver

E

embedded() - Static method in class capital.scalable.restdocs.AutoDocumentation

EmbeddedSnippet - Class in capital.scalable.restdocs.hypermedia

EmbeddedSnippet() - Constructor for class capital.scalable.restdocs.hypermedia.EmbeddedSnippet

EmbeddedSnippet(Type, boolean) - Constructor for class capital.scalable.restdocs.hypermedia.EmbeddedSnippet

enrichModel(Map<String, Object>, HandlerMethod, FieldDescriptors, SnippetTranslationResolver) - Method in class capital.scalable.restdocs.payload.JacksonModelAttributeSnippet

enrichModel(Map<String, Object>, HandlerMethod, FieldDescriptors, SnippetTranslationResolver) - Method in class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

enrichModel(Map<String, Object>, HandlerMethod, FieldDescriptors, SnippetTranslationResolver) - Method in class capital.scalable.restdocs.request.RequestParametersSnippet

enrichModel(Map<String, Object>, HandlerMethod, FieldDescriptors, SnippetTranslationResolver) - Method in class capital.scalable.restdocs.snippet.StandardTableSnippet

F

failOnUndocumentedFields(boolean) - Method in class capital.scalable.restdocs.hypermedia.EmbeddedSnippet

failOnUndocumentedFields(boolean) - Method in class capital.scalable.restdocs.hypermedia.LinksSnippet

failOnUndocumentedFields(boolean) - Method in class capital.scalable.restdocs.payload.JacksonRequestFieldSnippet

failOnUndocumentedFields(boolean) - Method in class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

failOnUndocumentedParams(boolean) - Method in class capital.scalable.restdocs.request.PathParametersSnippet

failOnUndocumentedParams(boolean) - Method in class capital.scalable.restdocs.request.RequestHeaderSnippet

failOnUndocumentedParams(boolean) - Method in class capital.scalable.restdocs.request.RequestParametersSnippet

FieldDescriptors - Class in capital.scalable.restdocs.jackson

FieldDescriptors() - Constructor for class capital.scalable.restdocs.jackson.FieldDescriptors

FieldDescriptorUtil - Class in capital.scalable.restdocs.util

FieldDocumentationGenerator - Class in capital.scalable.restdocs.jackson

FieldDocumentationGenerator(ObjectWriter, DeserializationConfig, JavadocReader, ConstraintReader, TypeMapping, SnippetTranslationResolver, JsonProperty.Access) - Constructor for class capital.scalable.restdocs.jackson.FieldDocumentationGenerator

FieldUtil - Class in capital.scalable.restdocs.util

findField(Class<?>, String) - Static method in class capital.scalable.restdocs.util.TypeUtil

findMethod(Class<?>, String) - Static method in class capital.scalable.restdocs.util.TypeUtil

findTypeFromTypeVariable(TypeVariable, Class<?>) - Static method in class capital.scalable.restdocs.util.TypeUtil

firstGenericType(MethodParameter) - Static method in class capital.scalable.restdocs.util.TypeUtil

firstGenericType(Type, Class<?>) - Static method in class capital.scalable.restdocs.util.TypeUtil

fixLineSeparator(String) - Static method in class capital.scalable.restdocs.util.FormatUtil

FormatUtil - Class in capital.scalable.restdocs.util

fromGetter(String) - Static method in class capital.scalable.restdocs.util.FieldUtil

Creates a field name from getter

G

generateDocumentation(Type, TypeFactory) - Method in class capital.scalable.restdocs.jackson.FieldDocumentationGenerator

getAnnotation(MethodParameter) - Method in class capital.scalable.restdocs.request.PathParametersSnippet

getAnnotation(MethodParameter) - Method in class capital.scalable.restdocs.request.RequestHeaderSnippet

getAnnotation(MethodParameter) - Method in class capital.scalable.restdocs.request.RequestParametersSnippet

getAuthorization(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

getBold() - Method in class capital.scalable.restdocs.util.TemplateFormatting

getClassicSnippet(String) - Static method in class capital.scalable.restdocs.SnippetRegistry

getCode() - Method in class capital.scalable.restdocs.util.TemplateFormatting

getConstraintMessages(Class<?>, String) - Method in interface capital.scalable.restdocs.constraints.ConstraintReader

getConstraintMessages(MethodParameter) - Method in interface capital.scalable.restdocs.constraints.ConstraintReader

getConstraintMessages(Class<?>, String) - Method in class capital.scalable.restdocs.constraints.ConstraintReaderImpl

getConstraintMessages(MethodParameter) - Method in class capital.scalable.restdocs.constraints.ConstraintReaderImpl

getConstraintReader(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

getDefaultResolver() - Static method in class capital.scalable.restdocs.i18n.SnippetTranslationManager

getDefaultSnippets(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

getDefaultValue(PathVariable) - Method in class capital.scalable.restdocs.request.PathParametersSnippet

getDefaultValue(RequestHeader) - Method in class capital.scalable.restdocs.request.RequestHeaderSnippet

getDefaultValue(RequestParam) - Method in class capital.scalable.restdocs.request.RequestParametersSnippet

getDocumentationContext(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

getFileName() - Method in class capital.scalable.restdocs.misc.AuthorizationSnippet

getFileName() - Method in class capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

getFileName() - Method in interface capital.scalable.restdocs.section.SectionSupport

File name (= section name).

getGroups(Constraint) - Method in class capital.scalable.restdocs.constraints.ConstraintAndGroupDescriptionResolver

getGroups(Constraint) - Method in interface capital.scalable.restdocs.constraints.GroupDescriptionResolver

getHandlerMethod(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

getHeaderKey(Operation) - Method in class capital.scalable.restdocs.hypermedia.EmbeddedSnippet

getHeaderKey(Operation) - Method in class capital.scalable.restdocs.hypermedia.LinksSnippet

getHeaderKey(Operation) - Method in class capital.scalable.restdocs.misc.AuthorizationSnippet

getHeaderKey(Operation) - Method in class capital.scalable.restdocs.payload.JacksonModelAttributeSnippet

getHeaderKey(Operation) - Method in class capital.scalable.restdocs.payload.JacksonRequestFieldSnippet

getHeaderKey(Operation) - Method in class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

getHeaderKey(Operation) - Method in class capital.scalable.restdocs.request.PathParametersSnippet

getHeaderKey(Operation) - Method in class capital.scalable.restdocs.request.RequestHeaderSnippet

getHeaderKey(Operation) - Method in class capital.scalable.restdocs.request.RequestParametersSnippet

getHeaderKey(Operation) - Method in interface capital.scalable.restdocs.section.SectionSupport

Section header key corresponding to entry in translation file.

getItalics() - Method in class capital.scalable.restdocs.util.TemplateFormatting

getJavadocReader(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

getLineBreak() - Method in class capital.scalable.restdocs.util.TemplateFormatting

getNoContentMessageKey() - Method in class capital.scalable.restdocs.jackson.FieldDescriptors

getObjectMapper(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

getOptionalMessages(Class<?>, String) - Method in interface capital.scalable.restdocs.constraints.ConstraintReader

getOptionalMessages(Class<?>, String) - Method in class capital.scalable.restdocs.constraints.ConstraintReaderImpl

getOrder() - Method in class capital.scalable.restdocs.webflux.WebTestClientInitializer

getPath(PathVariable) - Method in class capital.scalable.restdocs.request.PathParametersSnippet

getPath(RequestHeader) - Method in class capital.scalable.restdocs.request.RequestHeaderSnippet

getPath(RequestParam) - Method in class capital.scalable.restdocs.request.RequestParametersSnippet

getRequestMethod(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

getRequestPattern(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

getSkipAcessor() - Method in class capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

getSkipAcessor() - Method in class capital.scalable.restdocs.payload.JacksonModelAttributeSnippet

getSkipAcessor() - Method in class capital.scalable.restdocs.payload.JacksonRequestFieldSnippet

getSkipAcessor() - Method in class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

getSubtypes(Class<?>) - Method in class capital.scalable.restdocs.jackson.TypeMapping

getTemplateFormat(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

getTranslationKeys() - Method in class capital.scalable.restdocs.hypermedia.EmbeddedSnippet

getTranslationKeys() - Method in class capital.scalable.restdocs.hypermedia.LinksSnippet

getTranslationKeys() - Method in class capital.scalable.restdocs.payload.JacksonModelAttributeSnippet

getTranslationKeys() - Method in class capital.scalable.restdocs.payload.JacksonRequestFieldSnippet

getTranslationKeys() - Method in class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

getTranslationKeys() - Method in class capital.scalable.restdocs.request.PathParametersSnippet

getTranslationKeys() - Method in class capital.scalable.restdocs.request.RequestHeaderSnippet

getTranslationKeys() - Method in class capital.scalable.restdocs.request.RequestParametersSnippet

getTranslationKeys() - Method in class capital.scalable.restdocs.snippet.StandardTableSnippet

getTranslationResolver(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

getType(HandlerMethod) - Method in class capital.scalable.restdocs.hypermedia.EmbeddedSnippet

getType(HandlerMethod) - Method in class capital.scalable.restdocs.hypermedia.LinksSnippet

getType(HandlerMethod) - Method in class capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

getType(HandlerMethod) - Method in class capital.scalable.restdocs.payload.JacksonModelAttributeSnippet

getType(HandlerMethod) - Method in class capital.scalable.restdocs.payload.JacksonRequestFieldSnippet

getType(HandlerMethod) - Method in class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

getTypeMapping(Operation) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

getTypeSpecifier(Class<?>) - Method in interface capital.scalable.restdocs.constraints.ConstraintReader

getTypeSpecifier(Class<?>) - Method in class capital.scalable.restdocs.constraints.ConstraintReaderImpl

getValues() - Method in class capital.scalable.restdocs.jackson.DeprecatedAttribute

GroupDescriptionResolver - Interface in capital.scalable.restdocs.constraints

H

handle(ServerWebExchange, Object) - Method in class capital.scalable.restdocs.webflux.WebTestClientInitializer

HandlerMethodUtil - Class in capital.scalable.restdocs.util

hasContent(Operation) - Method in class capital.scalable.restdocs.misc.AuthorizationSnippet

hasContent(Operation) - Method in class capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

hasContent(Operation) - Method in interface capital.scalable.restdocs.section.SectionSupport

Flag if section will render non-empty content.

HTTP_REQUEST - Static variable in class capital.scalable.restdocs.SnippetRegistry

HTTP_RESPONSE - Static variable in class capital.scalable.restdocs.SnippetRegistry

HTTPIE_REQUEST - Static variable in class capital.scalable.restdocs.SnippetRegistry

I

initRequestPattern(MockHttpServletRequest) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

isCollection(Class<?>) - Method in class capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

isDeprecated() - Method in class capital.scalable.restdocs.jackson.DeprecatedAttribute

isGetter(String) - Static method in class capital.scalable.restdocs.util.FieldUtil

Determines if method is getter

isMergeable() - Method in class capital.scalable.restdocs.payload.JacksonModelAttributeSnippet

isMergeable() - Method in class capital.scalable.restdocs.payload.JacksonRequestFieldSnippet

isMergeable() - Method in class capital.scalable.restdocs.request.RequestParametersSnippet

isMergeable() - Method in interface capital.scalable.restdocs.section.SectionSupport

Flag if section is mergeable with other sections with the same header

isPageRequest(HandlerMethod) - Static method in class capital.scalable.restdocs.util.HandlerMethodUtil

isPrimitive(Class<?>, String) - Static method in class capital.scalable.restdocs.util.TypeUtil

isRequestMethodGet(HandlerMethod) - Method in class capital.scalable.restdocs.payload.JacksonModelAttributeSnippet

isRequired(MethodParameter, PathVariable) - Method in class capital.scalable.restdocs.request.PathParametersSnippet

isRequired(MethodParameter, RequestHeader) - Method in class capital.scalable.restdocs.request.RequestHeaderSnippet

isRequired(MethodParameter, RequestParam) - Method in class capital.scalable.restdocs.request.RequestParametersSnippet

J

JacksonFieldProcessingException - Exception in capital.scalable.restdocs.payload

JacksonFieldProcessingException(String, Throwable) - Constructor for exception capital.scalable.restdocs.payload.JacksonFieldProcessingException

JacksonModelAttributeSnippet - Class in capital.scalable.restdocs.payload

JacksonModelAttributeSnippet() - Constructor for class capital.scalable.restdocs.payload.JacksonModelAttributeSnippet

JacksonModelAttributeSnippet(Collection<HandlerMethodArgumentResolver>, boolean) - Constructor for class capital.scalable.restdocs.payload.JacksonModelAttributeSnippet

JacksonRequestFieldSnippet - Class in capital.scalable.restdocs.payload

JacksonRequestFieldSnippet() - Constructor for class capital.scalable.restdocs.payload.JacksonRequestFieldSnippet

JacksonRequestFieldSnippet(Type, boolean) - Constructor for class capital.scalable.restdocs.payload.JacksonRequestFieldSnippet

JacksonResponseFieldSnippet - Class in capital.scalable.restdocs.payload

JacksonResponseFieldSnippet() - Constructor for class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

JacksonResponseFieldSnippet(Type, boolean) - Constructor for class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

JacksonResultHandlers - Class in capital.scalable.restdocs.jackson

JacksonResultHandlers() - Constructor for class capital.scalable.restdocs.jackson.JacksonResultHandlers

JavadocReader - Interface in capital.scalable.restdocs.javadoc

JavadocReaderImpl - Class in capital.scalable.restdocs.javadoc

JavadocUtil - Class in capital.scalable.restdocs.javadoc

join(String, Object...) - Static method in class capital.scalable.restdocs.util.FormatUtil

JsonContentModifier - Class in capital.scalable.restdocs.response

JsonContentModifier(ObjectMapper) - Constructor for class capital.scalable.restdocs.response.JsonContentModifier

JsonModifyingException - Exception in capital.scalable.restdocs.response

JsonModifyingException(String, Throwable) - Constructor for exception capital.scalable.restdocs.response.JsonModifyingException

JsonNodeConsumer - Interface in capital.scalable.restdocs.response

JsonNodeFilter - Interface in capital.scalable.restdocs.response

L

limitJsonArrayLength(ObjectMapper) - Static method in class capital.scalable.restdocs.response.ResponseModifyingPreprocessors

For JSON content, cuts the length of all JSON arrays in the response to 3 elements.

link() - Method in class capital.scalable.restdocs.util.TemplateFormatting

links() - Static method in class capital.scalable.restdocs.AutoDocumentation

LINKS - Static variable in class capital.scalable.restdocs.SnippetRegistry

LinksSnippet - Class in capital.scalable.restdocs.hypermedia

LinksSnippet() - Constructor for class capital.scalable.restdocs.hypermedia.LinksSnippet

LinksSnippet(Type, boolean) - Constructor for class capital.scalable.restdocs.hypermedia.LinksSnippet

M

mapSubtypes(Class<?>, Class<?>...) - Method in class capital.scalable.restdocs.jackson.TypeMapping

MARKDOWN - Static variable in class capital.scalable.restdocs.util.TemplateFormatting

methodAndPath() - Static method in class capital.scalable.restdocs.AutoDocumentation

MethodAndPathSnippet - Class in capital.scalable.restdocs.misc

MethodAndPathSnippet() - Constructor for class capital.scalable.restdocs.misc.MethodAndPathSnippet

MethodParameterConstraintResolver - Interface in capital.scalable.restdocs.constraints

MethodParameterValidatorConstraintResolver - Class in capital.scalable.restdocs.constraints

MethodParameterValidatorConstraintResolver() - Constructor for class capital.scalable.restdocs.constraints.MethodParameterValidatorConstraintResolver

modelAttribute(Collection<HandlerMethodArgumentResolver>) - Static method in class capital.scalable.restdocs.AutoDocumentation

modifyContent(byte[], MediaType) - Method in class capital.scalable.restdocs.response.BinaryReplacementContentModifier

modifyContent(byte[], MediaType) - Method in class capital.scalable.restdocs.response.JsonContentModifier

modifyContent(byte[]) - Method in class capital.scalable.restdocs.response.JsonContentModifier

Uses UTF-8.

modifyJson(JsonNode) - Method in class capital.scalable.restdocs.response.ArrayLimitingJsonContentModifier

modifyJson(JsonNode) - Method in class capital.scalable.restdocs.response.JsonContentModifier

MultipartContentOperationPreprocessor - Class in capital.scalable.restdocs.response

MultipartContentOperationPreprocessor() - Constructor for class capital.scalable.restdocs.response.MultipartContentOperationPreprocessor

N

NoOpMethodParameterConstraintResolver - Class in capital.scalable.restdocs.constraints

NoOpMethodParameterConstraintResolver() - Constructor for class capital.scalable.restdocs.constraints.NoOpMethodParameterConstraintResolver

O

OperationAttributeHelper - Class in capital.scalable.restdocs

OperationAttributeHelper() - Constructor for class capital.scalable.restdocs.OperationAttributeHelper

OPTIONAL_ATTRIBUTE - Static variable in interface capital.scalable.restdocs.constraints.ConstraintReader

P

PATH_PARAMETERS - Static variable in class capital.scalable.restdocs.SnippetRegistry

pathParameters() - Static method in class capital.scalable.restdocs.AutoDocumentation

PathParametersSnippet - Class in capital.scalable.restdocs.request

PathParametersSnippet() - Constructor for class capital.scalable.restdocs.request.PathParametersSnippet

PathParametersSnippet(boolean) - Constructor for class capital.scalable.restdocs.request.PathParametersSnippet

placeholderResolverFactory - Variable in class capital.scalable.restdocs.section.SectionSnippet

prepareJackson(ObjectMapper) - Static method in class capital.scalable.restdocs.jackson.JacksonResultHandlers

prepareJackson(ObjectMapper, SnippetTranslationResolver) - Static method in class capital.scalable.restdocs.jackson.JacksonResultHandlers

prepareJackson(ObjectMapper, TypeMapping) - Static method in class capital.scalable.restdocs.jackson.JacksonResultHandlers

prepareJackson(ObjectMapper, ConstraintDescriptionResolver) - Static method in class capital.scalable.restdocs.jackson.JacksonResultHandlers

prepareJackson(ObjectMapper, TypeMapping, SnippetTranslationResolver) - Static method in class capital.scalable.restdocs.jackson.JacksonResultHandlers

prepareJackson(ObjectMapper, SnippetTranslationResolver, ConstraintDescriptionResolver) - Static method in class capital.scalable.restdocs.jackson.JacksonResultHandlers

prepareJackson(ObjectMapper, TypeMapping, ConstraintDescriptionResolver) - Static method in class capital.scalable.restdocs.jackson.JacksonResultHandlers

prepareJackson(ObjectMapper, TypeMapping, SnippetTranslationResolver, ConstraintDescriptionResolver) - Static method in class capital.scalable.restdocs.jackson.JacksonResultHandlers

prepareSnippets(ApplicationContext) - Static method in class capital.scalable.restdocs.webflux.WebTestClientInitializer

Prepare Snippets for use with the WebTestClient.

prepareSnippets(ApplicationContext, TypeMapping) - Static method in class capital.scalable.restdocs.webflux.WebTestClientInitializer

Prepare Snippets for use with the WebTestClient.

preprocess(OperationRequest) - Method in class capital.scalable.restdocs.response.MultipartContentOperationPreprocessor

propertyPlaceholderHelper - Variable in class capital.scalable.restdocs.section.SectionSnippet

putIfAbsent(String, FieldDescriptor) - Method in class capital.scalable.restdocs.jackson.FieldDescriptors

R

REACTOR_FLUX_CLASS - Static variable in class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

REACTOR_MONO_CLASS - Static variable in class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

replaceBinaryContent() - Static method in class capital.scalable.restdocs.response.ResponseModifyingPreprocessors

For binary content, replaces value with "<binary>".

replacementText() - Method in class capital.scalable.restdocs.response.BinaryReplacementContentModifier

replaceMultipartBinaryContent() - Static method in class capital.scalable.restdocs.response.ResponseModifyingPreprocessors

For binary content of multipart/form-data requests, replaces value with "<binary>".

REQUEST_BODY_SNIPPET - Static variable in class capital.scalable.restdocs.SnippetRegistry

REQUEST_FIELDS - Static variable in class capital.scalable.restdocs.SnippetRegistry

REQUEST_HEADERS - Static variable in class capital.scalable.restdocs.SnippetRegistry

REQUEST_PARAMETERS - Static variable in class capital.scalable.restdocs.SnippetRegistry

REQUEST_PART_FIELDS - Static variable in class capital.scalable.restdocs.SnippetRegistry

REQUEST_PARTS - Static variable in class capital.scalable.restdocs.SnippetRegistry

REQUEST_PATTERN - Static variable in class capital.scalable.restdocs.OperationAttributeHelper

requestBodyAsType(Type) - Method in class capital.scalable.restdocs.payload.JacksonRequestFieldSnippet

requestFields() - Static method in class capital.scalable.restdocs.AutoDocumentation

requestHeaders() - Static method in class capital.scalable.restdocs.AutoDocumentation

RequestHeaderSnippet - Class in capital.scalable.restdocs.request

RequestHeaderSnippet() - Constructor for class capital.scalable.restdocs.request.RequestHeaderSnippet

RequestHeaderSnippet(boolean) - Constructor for class capital.scalable.restdocs.request.RequestHeaderSnippet

requestParameters() - Static method in class capital.scalable.restdocs.AutoDocumentation

RequestParametersSnippet - Class in capital.scalable.restdocs.request

RequestParametersSnippet() - Constructor for class capital.scalable.restdocs.request.RequestParametersSnippet

RequestParametersSnippet(boolean) - Constructor for class capital.scalable.restdocs.request.RequestParametersSnippet

resolveAllTypes(JavaType, TypeFactory, TypeMapping) - Static method in class capital.scalable.restdocs.util.TypeUtil

resolveAnnotation(Class<?>, String, Class<T>) - Static method in class capital.scalable.restdocs.util.TypeUtil

resolveComment(HandlerMethod, JavadocReader) - Method in class capital.scalable.restdocs.misc.DescriptionSnippet

resolveDeprecated(HandlerMethod, JavadocReader, SnippetTranslationResolver) - Method in class capital.scalable.restdocs.misc.DescriptionSnippet

resolveDescription(Constraint) - Method in class capital.scalable.restdocs.constraints.ConstraintAndGroupDescriptionResolver

resolveDescription(Constraint) - Method in class capital.scalable.restdocs.constraints.DynamicResourceBundleConstraintDescriptionResolver

First resolves based on overridden message on constraint itself, then falls back to resource bundle resolution

resolveFieldComment(Class<?>, String) - Method in interface capital.scalable.restdocs.javadoc.JavadocReader

resolveFieldComment(Class<?>, String) - Method in class capital.scalable.restdocs.javadoc.JavadocReaderImpl

resolveFieldTag(Class<?>, String, String) - Method in interface capital.scalable.restdocs.javadoc.JavadocReader

resolveFieldTag(Class<?>, String, String) - Method in class capital.scalable.restdocs.javadoc.JavadocReaderImpl

resolveForParameter(MethodParameter) - Method in interface capital.scalable.restdocs.constraints.MethodParameterConstraintResolver

resolveForParameter(MethodParameter) - Method in class capital.scalable.restdocs.constraints.MethodParameterValidatorConstraintResolver

resolveForParameter(MethodParameter) - Method in class capital.scalable.restdocs.constraints.NoOpMethodParameterConstraintResolver

resolveForProperty(String, Class<?>) - Method in class capital.scalable.restdocs.constraints.NoOpMethodParameterConstraintResolver

resolveGroupDescription(Class, String) - Method in class capital.scalable.restdocs.constraints.ConstraintAndGroupDescriptionResolver

resolveGroupDescription(Class<?>, String) - Method in interface capital.scalable.restdocs.constraints.GroupDescriptionResolver

resolveMethodComment(Class<?>, String) - Method in interface capital.scalable.restdocs.javadoc.JavadocReader

resolveMethodComment(Class<?>, String) - Method in class capital.scalable.restdocs.javadoc.JavadocReaderImpl

resolveMethodParameterComment(Class<?>, String, String) - Method in interface capital.scalable.restdocs.javadoc.JavadocReader

resolveMethodParameterComment(Class<?>, String, String) - Method in class capital.scalable.restdocs.javadoc.JavadocReaderImpl

resolveMethodTag(Class<?>, String, String) - Method in interface capital.scalable.restdocs.javadoc.JavadocReader

resolveMethodTag(Class<?>, String, String) - Method in class capital.scalable.restdocs.javadoc.JavadocReaderImpl

resolveTitle(HandlerMethod, JavadocReader, SnippetTranslationResolver) - Method in class capital.scalable.restdocs.section.SectionSnippet

ResourceBundleSnippetTranslationResolver - Class in capital.scalable.restdocs.i18n

Inspired by ResourceBundleConstraintDescriptionResolver

ResourceBundleSnippetTranslationResolver() - Constructor for class capital.scalable.restdocs.i18n.ResourceBundleSnippetTranslationResolver

RESPONSE_BODY - Static variable in class capital.scalable.restdocs.SnippetRegistry

RESPONSE_FIELDS - Static variable in class capital.scalable.restdocs.SnippetRegistry

RESPONSE_HEADERS - Static variable in class capital.scalable.restdocs.SnippetRegistry

responseBodyAsType(Type) - Method in class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

responseFields() - Static method in class capital.scalable.restdocs.AutoDocumentation

ResponseModifyingPreprocessors - Class in capital.scalable.restdocs.response

ResponseModifyingPreprocessors() - Constructor for class capital.scalable.restdocs.response.ResponseModifyingPreprocessors

S

SardClassIntrospector() - Constructor for class capital.scalable.restdocs.jackson.SardObjectMapper.SardClassIntrospector

SardObjectMapper - Class in capital.scalable.restdocs.jackson

Overrides class inspector so that we keep properties othewise filtered out via JsonProperty.access() in POJOPropertiesCollector._removeUnwantedAccessor(java.util.Map).

SardObjectMapper(ObjectMapper) - Constructor for class capital.scalable.restdocs.jackson.SardObjectMapper

SardObjectMapper.SardClassIntrospector - Class in capital.scalable.restdocs.jackson

SardObjectMapper.SardPOJOPropertiesCollector - Class in capital.scalable.restdocs.jackson

SardPOJOPropertiesCollector(MapperConfig<?>, boolean, JavaType, AnnotatedClass, String) - Constructor for class capital.scalable.restdocs.jackson.SardObjectMapper.SardPOJOPropertiesCollector

section() - Static method in class capital.scalable.restdocs.AutoDocumentation

SECTION - Static variable in class capital.scalable.restdocs.section.SectionSnippet

sectionBuilder() - Static method in class capital.scalable.restdocs.AutoDocumentation

SectionBuilder - Class in capital.scalable.restdocs.section

Builder for configuring a section snippet.

SectionBuilder() - Constructor for class capital.scalable.restdocs.section.SectionBuilder

sectionNames - Variable in class capital.scalable.restdocs.section.SectionSnippet

SectionSnippet - Class in capital.scalable.restdocs.section

SectionSnippet(Collection<String>, boolean) - Constructor for class capital.scalable.restdocs.section.SectionSnippet

SectionSupport - Interface in capital.scalable.restdocs.section

setAuthorization(MockHttpServletRequest, String) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

setConstraintReader(MockHttpServletRequest, ConstraintReader) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

setHandlerMethod(MockHttpServletRequest, HandlerMethod) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

setJavadocReader(MockHttpServletRequest, JavadocReader) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

setObjectMapper(MockHttpServletRequest, ObjectMapper) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

setTranslationResolver(MockHttpServletRequest, SnippetTranslationResolver) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

setTypeMapping(MockHttpServletRequest, TypeMapping) - Static method in class capital.scalable.restdocs.OperationAttributeHelper

shortenContent(ObjectMapper) - Static method in class capital.scalable.restdocs.response.ResponseModifyingPreprocessors

Only modifies the content of a response.

shouldFailOnUndocumentedFields() - Method in class capital.scalable.restdocs.hypermedia.EmbeddedSnippet

shouldFailOnUndocumentedFields() - Method in class capital.scalable.restdocs.hypermedia.LinksSnippet

shouldFailOnUndocumentedFields() - Method in class capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

shouldFailOnUndocumentedFields() - Method in class capital.scalable.restdocs.payload.JacksonModelAttributeSnippet

shouldFailOnUndocumentedFields() - Method in class capital.scalable.restdocs.payload.JacksonRequestFieldSnippet

shouldFailOnUndocumentedFields() - Method in class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

shouldFailOnUndocumentedParams() - Method in class capital.scalable.restdocs.request.PathParametersSnippet

shouldFailOnUndocumentedParams() - Method in class capital.scalable.restdocs.request.RequestHeaderSnippet

shouldFailOnUndocumentedParams() - Method in class capital.scalable.restdocs.request.RequestParametersSnippet

skipEmpty(boolean) - Method in class capital.scalable.restdocs.section.SectionBuilder

If snippet would not generate any output (e.g.

skipEmpty - Variable in class capital.scalable.restdocs.section.SectionSnippet

snippetNames(List<String>) - Method in class capital.scalable.restdocs.section.SectionBuilder

List of snippet names to use in the specified order.

snippetNames(String...) - Method in class capital.scalable.restdocs.section.SectionBuilder

Array of snippet names to use in the specified order.

SnippetRegistry - Class in capital.scalable.restdocs

SnippetTranslationManager - Class in capital.scalable.restdocs.i18n

SnippetTranslationManager() - Constructor for class capital.scalable.restdocs.i18n.SnippetTranslationManager

SnippetTranslationResolver - Interface in capital.scalable.restdocs.i18n

SPRING_DATA_PAGEABLE_CLASS - Static variable in class capital.scalable.restdocs.util.HandlerMethodUtil

SPRING_HATEOAS_CLASSES - Static variable in class capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

StandardTableSnippet - Class in capital.scalable.restdocs.snippet

StandardTableSnippet(String, Map<String, Object>) - Constructor for class capital.scalable.restdocs.snippet.StandardTableSnippet

supports(Object) - Method in class capital.scalable.restdocs.webflux.WebTestClientInitializer

T

TemplateFormatting - Class in capital.scalable.restdocs.util

translate(String, Object...) - Method in class capital.scalable.restdocs.i18n.ResourceBundleSnippetTranslationResolver

translate(String, Object...) - Method in interface capital.scalable.restdocs.i18n.SnippetTranslationResolver

translation(SnippetTranslationResolver) - Static method in class capital.scalable.restdocs.i18n.TranslationHandlers

TranslationHandlers - Class in capital.scalable.restdocs.i18n

TranslationHandlers() - Constructor for class capital.scalable.restdocs.i18n.TranslationHandlers

TYPE_ATTRIBUTE - Static variable in interface capital.scalable.restdocs.constraints.ConstraintReader

TypeMapping - Class in capital.scalable.restdocs.jackson

TypeMapping() - Constructor for class capital.scalable.restdocs.jackson.TypeMapping

TypeUtil - Class in capital.scalable.restdocs.util

V

values() - Method in class capital.scalable.restdocs.jackson.FieldDescriptors

W

walk(JsonNode, JsonNodeFilter, JsonNodeConsumer) - Method in class capital.scalable.restdocs.response.JsonContentModifier

WebTestClientInitializer - Class in capital.scalable.restdocs.webflux

Watches the WebTestClient and applies some attributes on each operation.

WebTestClientInitializer() - Constructor for class capital.scalable.restdocs.webflux.WebTestClientInitializer

_

_removeUnwantedAccessor(Map<String, POJOPropertyBuilder>) - Method in class capital.scalable.restdocs.jackson.SardObjectMapper.SardPOJOPropertiesCollector

A B C D E F G H I J L M N O P R S T V W _