Skip to content

Commit 21e7973

Browse files
committed
#1 Update README.md with all config options
1 parent 7552eba commit 21e7973

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,21 @@ Please refer to:
1010
* Maven plugin: [grapqhl-java-codegen-maven-plugin](https://github.com/kobylynskyi/grapqhl-java-codegen-maven-plugin)
1111

1212

13+
14+
## Supported Options
15+
16+
| Key | Data Type | Default value | Description |
17+
| ----------------------- | ------------------ | ------------- | ----------- |
18+
| graphqlSchemaPaths | List(String) | None | GraphQL schema locations. You can supply multiple paths to GraphQL schemas. |
19+
| packageName | String | Empty | Java package for generated classes. |
20+
| outputDir | String | None | The output target directory into which code will be generated. |
21+
| 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) |
22+
| modelNamePrefix | String | Empty | Sets the prefix for GraphQL model classes (type, input, interface, enum, union). |
23+
| modelNameSuffix | String | Empty | Sets the suffix for GraphQL model classes (type, input, interface, enum, union). |
24+
| apiPackage | String | Empty | Java package for generated api classes (Query, Mutation, Subscription). |
25+
| modelPackage | String | Empty | Java package for generated model classes (type, input, interface, enum, union). |
26+
27+
1328
### Inspired by
1429
[swagger-codegen](https://github.com/swagger-api/swagger-codegen)
1530

src/main/java/com/kobylynskyi/graphql/codegen/model/MappingConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ public class MappingConfig {
1111
/**
1212
* Scalars mapping can be defined here.
1313
* e.g.: DateTime -> String
14-
* e.g.: Price.Float -> java.math.BigDecimal
14+
* e.g.: Price.amount -> java.math.BigDecimal
1515
*/
1616
private Map<String, String> customTypesMapping = new HashMap<>();
1717
private String packageName;

0 commit comments

Comments
 (0)