Schema adjusters DO NOT WORK on REST methods themselves and their path/header/query/cookie parameters.
Instead, use OperationAdjuster and
ParameterAdjuster.
Also, be aware that schema adjusters may also be applied on schema references. In such cases, the schema reference
is wrapped into a Schema object with allOf property containing the original
reference. This effectively allows you to extend the referenced schema but you cannot inspect it in the process.
Base trait for annotations which may adjust Schema derived for various symbols in REST API traits. Schema adjusters may be applied on:
- Types for which RestStructure is macro materialized and RestSchema derived from it. This includes all types with companion extending RestDataCompanion.
- Fields of case classes for which RestStructure is macro materialized.
- Body parameters of REST methods.
Schema adjusters DO NOT WORK on REST methods themselves and their path/header/query/cookie parameters. Instead, use OperationAdjuster and ParameterAdjuster.
Also, be aware that schema adjusters may also be applied on schema references. In such cases, the schema reference is wrapped into a Schema object with
allOf
property containing the original reference. This effectively allows you to extend the referenced schema but you cannot inspect it in the process.