Skip to content

Update scalars docs with common issues #772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dariuszkuc merged 2 commits into from
Jun 17, 2020
Merged

Update scalars docs with common issues #772

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4999311
Update scalars.md
smyrick Jun 17, 2020
81a51cd
Update scalars.md
smyrick Jun 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/schema-generator/writing-schemas/scalars.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,15 @@ object UUIDCoercing : Coercing<UUID, String> {
```

Once the scalars are registered you can use them anywhere in the schema as regular objects.

## Common Issues

### Extended Scalars

By default, `graphql-kotlin` only supports the primitive scalar types listed above. If you are looking to use common java types as scalars, you need to include the [graphql-java-extended-scalars](https://github.com/graphql-java/graphql-java-extended-scalars) library and set up the hooks (see above), or write the logic yourself for how to resolve these custom scalars.

The most popular types that require extra configuration are: `LocalDate`, `DateTime`, `Instant`, `ZonedDateTime`, `URL`, `UUID`
Copy link
Contributor Author

@smyrick smyrick Jun 17, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this line for searchability


### `TypeNotSupportedException`

If you see the following message `Cannot convert ** since it is not a valid GraphQL type or outside the supported packages ***`. This means that you need to update the [generator configuration](../customizing-schemas/generator-config.md) to include the package of your type or you did not properly set up the hooks to register the new type.