I couldn’t any documentation about the --custom-scalars-config switch except in the command line reference. I was looking for the format of what should go in that file.
for now, I’ve added the custom scalars we use (all form graphql-scalars) in the api.graphql file. Is this the right thing to do?
Documentation is currently being flushed out for this but the custom scalars config file is a JSON file mapping the custom scalar to a JSON schema value. For example the following file would map the scalar CustomScalar
to a string
:
{
"CustomScalar": { "type": "string", "description": "a custom scalar" }
}
Any provided description
in the config will override a description provided in the schema.