From 16504a51e6428e82f2117e650efbfc1f7ed1e54e Mon Sep 17 00:00:00 2001 From: Vincent Date: Sat, 16 Jul 2022 19:45:55 +1200 Subject: [PATCH] Doc&Fix: Fixed type, updated FAQ and versions --- Documentation/README.md | 2 +- Documentation/features/configuration.md | 2 +- Documentation/guides/advanced/faq.md | 8 ++++---- Documentation/guides/getting-started/setup.md | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/README.md b/Documentation/README.md index 7a84896..5b912f1 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -26,7 +26,7 @@ You can add Pioneer into any existing Vapor application with any GraphQL schema Add this line to add Pioneer as one of your dependencies. ```swift -.package(url: "https://github.com/d-exclaimation/pioneer", from: "0.8.6") +.package(url: "https://github.com/d-exclaimation/pioneer", from: "0.9.0") ``` Go to the `main.swift` or any Swift file where you apply your Vapor routing like your `routes.swift` file. diff --git a/Documentation/features/configuration.md b/Documentation/features/configuration.md index a48b380..279e557 100644 --- a/Documentation/features/configuration.md +++ b/Documentation/features/configuration.md @@ -6,7 +6,7 @@ order: 50 # Configuration !!!success Custom Configuration options -From `0.8.6`, Pioneer brought in a structure that will allow easier configuration, which would only require you to pass in the config object into [Pioneer](/references/pioneer) initializer. +From `0.9.0`, Pioneer brought in a structure that will allow easier configuration, which would only require you to pass in the config object into [Pioneer](/references/pioneer) initializer. !!! This configuration structure would allow user of the library to create multiple configuration for Pioneer on different environment or situation. diff --git a/Documentation/guides/advanced/faq.md b/Documentation/guides/advanced/faq.md index 009b08c..56d3714 100644 --- a/Documentation/guides/advanced/faq.md +++ b/Documentation/guides/advanced/faq.md @@ -107,7 +107,7 @@ No, there is no custom error from Pioneer (as of now), just use what works best Mostly. -- If the error(s) were thrown during context building, Pioneer will use the reason to build a GraphQL formatted error and set the response status code accordingly. +- If the error(s) were thrown during context building, Pioneer will use the reason to build a GraphQL formatted error, and set the response status and headers code accordingly. ==- Example ```swift Throwing Abort @@ -136,7 +136,7 @@ Mostly. === -- If the error(s) were thrown in the resolver functions, Pioneer will only throw back a GraphQL formatted error with the description of the error thrown but will not set the response status (unless it was set manually into the response object during the resolving function). +- If the error(s) were thrown in the resolver functions, Pioneer will only throw back a GraphQL formatted error with the description of the error thrown but will not set the response status nor headers (unless it was set manually into the response object during the resolving function). ==- Example @@ -183,9 +183,9 @@ Not directly support [RxSwift](https://github.com/ReactiveX/RxSwift). However si However, Pioneer is not compatible with [GraphQLRxSwift](https://github.com/GraphQLSwift/GraphQLRxSwift), and all [RxSwift](https://github.com/ReactiveX/RxSwift)'s observable must be converted into an `AsyncSequence`. -#### Does Pioneer support [ConcurrentEventSTream](https://github.com/GraphQLSwift/GraphQL/blob/master/Sources/GraphQL/Subscription/EventStream.swift)? +#### Does Pioneer support [ConcurrentEventStream](https://github.com/GraphQLSwift/GraphQL/blob/master/Sources/GraphQL/Subscription/EventStream.swift)? -Yes, [ConcurrentEventSTream](https://github.com/GraphQLSwift/GraphQL/blob/master/Sources/GraphQL/Subscription/EventStream.swift) worked pratically the same as [AsyncEventStream](/features/async-event-stream/#asynceventstream), but limit itself to only `AsyncThrowingStream`. +Yes, [ConcurrentEventStream](https://github.com/GraphQLSwift/GraphQL/blob/master/Sources/GraphQL/Subscription/EventStream.swift) worked pratically the same as [AsyncEventStream](/features/async-event-stream/#asynceventstream), but limit itself to only `AsyncThrowingStream`. ### PubSub diff --git a/Documentation/guides/getting-started/setup.md b/Documentation/guides/getting-started/setup.md index 3d0458e..b371388 100644 --- a/Documentation/guides/getting-started/setup.md +++ b/Documentation/guides/getting-started/setup.md @@ -36,7 +36,7 @@ let package = Package( dependencies: [ .package(url: "https://github.com/GraphQLSwift/Graphiti.git", from: "1.0.0"), .package(url: "https://github.com/vapor/vapor.git", from: "4.61.1"), - .package(url: "https://github.com/d-exclaimation/pioneer", from: "0.8.6") + .package(url: "https://github.com/d-exclaimation/pioneer", from: "0.9.0") ], targets: [ .target(