org.eclipse.microprofile.graphql

Annotation Type Input

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
public @interface Input

Maps the annotated class to a GraphQL input type.

For example, a user might annotate a class as such:

  @Input("StarshipInput")
  @Description("Input type for a starship")
 public class Starship {
     private String id;
     private String name;
     private float length;

     // getters/setters...
 }
 

Schema generation of this would result in a stanza such as:

 "Input type for a starship"
 input StarshipInput {
   id: String
   name: String
   length: Float
 }
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value

Element Detail

value

public abstract String value

Returns:

the name of the GraphQL input type.

Default:

""