From 1e8405a6d6de8d7a5a1323ba11e48fb4fb852b80 Mon Sep 17 00:00:00 2001 From: Eugen Wissner Date: Thu, 11 Feb 2021 12:02:08 +0100 Subject: [PATCH] Document AST.Document.escape --- CHANGELOG.md | 3 +++ src/Language/GraphQL/AST/Document.hs | 10 ++++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 37ac5fe..6f400c4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ The format is based on and this project adheres to [Haskell Package Versioning Policy](https://pvp.haskell.org/). +## [Unreleased] + ## [0.11.1.0] - 2021-02-07 ### Added - `Validate.Rules`: @@ -413,6 +415,7 @@ and this project adheres to ### Added - Data types for the GraphQL language. +[Unreleased]: https://www.caraus.tech/projects/pub-graphql/repository/23/diff?rev=master&rev_to=v0.11.1.0 [0.11.1.0]: https://www.caraus.tech/projects/pub-graphql/repository/23/diff?rev=v0.11.1.0&rev_to=v0.11.0.0 [0.11.0.0]: https://www.caraus.tech/projects/pub-graphql/repository/23/diff?rev=v0.11.0.0&rev_to=v0.10.0.0 [0.10.0.0]: https://www.caraus.tech/projects/pub-graphql/repository/23/diff?rev=v0.10.0.0&rev_to=v0.9.0.0 diff --git a/src/Language/GraphQL/AST/Document.hs b/src/Language/GraphQL/AST/Document.hs index a78b007..41b417c 100644 --- a/src/Language/GraphQL/AST/Document.hs +++ b/src/Language/GraphQL/AST/Document.hs @@ -226,6 +226,12 @@ type TypeCondition = Name -- ** Input Values +-- | Escapes a single character according to the GraphQL escaping rules for +-- double-quoted string values. +-- +-- Characters, that should be escaped, are written as escaped characters with a +-- backslash or Unicode with an \"\\u\". Other characters are returned as +-- strings. escape :: Char -> String escape char' | char' == '\\' = "\\\\" @@ -318,13 +324,13 @@ instance Functor ObjectField where -- Each operation can include a list of variables: -- -- @ --- query (protagonist: String = "Zarathustra") { +-- query (protagonist: String = \"Zarathustra\") { -- getAuthor(protagonist: $protagonist) -- } -- @ -- -- This query defines an optional variable @protagonist@ of type @String@, --- its default value is "Zarathustra". If no default value is defined and no +-- its default value is \"Zarathustra\". If no default value is defined and no -- value is provided, a variable can still be @null@ if its type is nullable. -- -- Variables are usually passed along with the query, but not in the query