Skip to content
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

Jump to bottom

Update README.md #5

Closed
wants to merge 1 commit into from
Closed

Update README.md #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Create a JSON file called `snowflaqe.json` with the following shape:
}
```
Where
- `<schema>` can be either the URL to the GraphQL backend or a relative path to another JSON file containing the output of the [standard Introspection](https://github.com/Zaid-Ajaj/Snowflaqe/blob/master/src/Introspection.gql) query which you can execute against the backend yourself (this allows for offline verification and type-checking)
- `<schema>` can be either the URL to the GraphQL backend; a relative path to another JSON file containing the output of the [standard Introspection](https://github.com/Zaid-Ajaj/Snowflaqe/blob/master/src/Introspection.gql) query, which you can execute against the backend yourself (this allows for offline verification and type-checking); or a file with a `.gql` or `.graphql` extension containing a schema.
- `<queries>` is an absolute or relative path to a directory that contains `*.gql` files that contain individual GraphQL queries that `snowflaqe` will run the verification against.
- `<project>` is the name of the project will be generated.
- `<output>` is an absolute or relative path to a directory where the project will be generated
Expand Down Expand Up @@ -81,4 +81,4 @@ type CustomErrorType = {

There are a couple of features of the GraphQL specs which `snowflaqe` doesn't (yet) know how to work with:
- [ ] GraphQL Union Types
- [ ] Subscriptions (non-goal of the tool, maybe in the future)
- [ ] Subscriptions (non-goal of the tool, maybe in the future)