status-im
/
nim-graphql
mirror of https://github.com/status-im/nim-graphql.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

fixes api documentation

This commit is contained in:
jangko 2021-04-15 11:43:58 +07:00
parent bb7e8dac64
commit d5a45d09a8
No known key found for this signature in database
GPG Key ID: 31702AE10541E6B9
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api.md
View File

@ -31,8 +31,8 @@ If you find anything not listed or not exported in this list, please submit an i
- `createName(ctx: GraphqlRef, name: string): Name`. `respMap` will need a name from the system using this proc.
- `executeRequest(ctx: GraphqlRef, resp: RespStream, opName = ""): ParseResult`. This is your main entrance to the execution engine.
- `validate(ctx: GraphqlRef, root: Node)`. Usually you don't need to call this directly.
- `parseSchema(ctx: GraphqlRef, schema: string): ParseResult`. Parse a scheme from text string.
- `parseSchemaFromFile(ctx: GraphqlRef, fileName: string | openArray[byte]): ParseResult`.
- `parseSchema(ctx: GraphqlRef, schema: string | openArray[byte]): ParseResult`. Parse a scheme from text string.
- `parseSchemaFromFile(ctx: GraphqlRef, fileName: string): ParseResult`.
- `parseQuery(ctx: GraphqlRef, query: string | openArray[byte]): ParseResult `. Parse queries from text string.
- `parseQueryFromFile(ctx: GraphqlRef, fileName: string): ParseResult`.
- `purgeQueries(ctx: GraphqlRef, includeVariables: bool)`. A server will often call this to remove unused queries.