org.eclipse.microprofile.graphql

Annotation Type InputFieldsOrder

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

To customize the appearance's order of input fields in documentation. No effect on the actual GraphQL schema.

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

  @InputType(name = "StarshipInput", description = "Input type for a starship")
  @InputFieldsOrder({"name", "id", "length"})
 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 Starship {
   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:

an ordered list of GraphQL input fields' names.

Default:

{}