Custom Directives

[t1]

I would like to be able to add Custom Directives to the generated schema. It would be convenient to add an @Directive annotation to my own annotation, i.e.:

@Directive(on = { FIELD, ARGUMENT })
public @interface Example {
    String value();
}

@Type
class SomeType {
    @Example("out")
    String field(@Example("in") int arg) { return null; }
}

...generates a schema:

type SomeType {
    field(arg: Int @example(value: "in")): String @example(value: "out")
}

[t1]

Some possible use-cases for Custom Directives:

1. BeanValidation: firstName: String @size(max: 100) - this is already being checked in the server (at least in WildFly)
2. Request Throttling: location: String @complexity(score: 30) - this could also be checked in the backend; see Support of a complexity evaluation mechanism to detect expensive operations #340
3. RBAC: location: String @visibleFor(role: "HeroLocator") - this could also be checked in the backend some day

These directives would add a benefit for the client as "structured documentation".

[phillip-kruger]

We already do 3 in the backend as well - what we can do is to make these available in the schema as directives, that would be cool...

[t1]

yeah, of course... I just forgot the @RolesAllowed annotation which already works, of course.

[KSmigielski]

Hi, I would like to help with this issue

[t1]

@KSmigielski : that would be great! If you need help, just ask!

[kito99]

KSmigielski still interested three years later?