Skip to content

Commit 7199357

Browse files
committed
Update README.md with new mapping config
1 parent 45a9a04 commit 7199357

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,19 @@ Please refer to:
1212

1313
## Supported Options
1414

15-
| Key | Data Type | Default value | Description |
16-
| ----------------------- | ------------------ | ------------- | ----------- |
17-
| graphqlSchemaPaths | List(String) | None | GraphQL schema locations. You can supply multiple paths to GraphQL schemas. |
18-
| packageName | String | Empty | Java package for generated classes. |
19-
| outputDir | String | None | The output target directory into which code will be generated. |
20-
| customTypesMapping | Map(String,String) | Empty | Can be used to supply custom mappings for scalars. <br/> Supports:<br/> * Map of (GraphqlObjectName.fieldName) to (JavaType) <br/> * Map of (GraphqlType) to (JavaType) |
21-
| modelNamePrefix | String | Empty | Sets the prefix for GraphQL model classes (type, input, interface, enum, union). |
22-
| modelNameSuffix | String | Empty | Sets the suffix for GraphQL model classes (type, input, interface, enum, union). |
23-
| apiPackage | String | Empty | Java package for generated api classes (Query, Mutation, Subscription). |
24-
| modelPackage | String | Empty | Java package for generated model classes (type, input, interface, enum, union). |
15+
| Key | Data Type | Default value | Description |
16+
| ------------------------- | ------------------ | ------------------------------------- | ----------- |
17+
| graphqlSchemaPaths | List(String) | None | GraphQL schema locations. You can supply multiple paths to GraphQL schemas. |
18+
| packageName | String | Empty | Java package for generated classes. |
19+
| outputDir | String | None | The output target directory into which code will be generated. |
20+
| apiPackage | String | Empty | Java package for generated api classes (Query, Mutation, Subscription). |
21+
| modelPackage | String | Empty | Java package for generated model classes (type, input, interface, enum, union). |
22+
| generateApis | Boolean | True | Java package for generated model classes (type, input, interface, enum, union). |
23+
| customTypesMapping | Map(String,String) | Empty | Can be used to supply custom mappings for scalars. <br/> Supports:<br/> * Map of (GraphqlObjectName.fieldName) to (JavaType) <br/> * Map of (GraphqlType) to (JavaType) |
24+
| customAnnotationsMapping | Map(String,String) | Empty | Can be used to supply custom annotations (serializers) for scalars. <br/> Supports:<br/> * Map of (GraphqlObjectName.fieldName) to (JavaType) <br/> * Map of (GraphqlType) to (JavaType) |
25+
| modelValidationAnnotation | String | @javax.validation.constraints.NotNull | Annotation for mandatory (NonNull) fields. Can be null/empty. |
26+
| modelNamePrefix | String | Empty | Sets the prefix for GraphQL model classes (type, input, interface, enum, union). |
27+
| modelNameSuffix | String | Empty | Sets the suffix for GraphQL model classes (type, input, interface, enum, union). |
2528

2629

2730
### Inspired by

0 commit comments

Comments
 (0)