diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 43de34e..fef2d3d 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -26,7 +26,7 @@ jobs: uses: actions/checkout@v3 - name: Setup Pages if: github.ref_name == github.event.repository.default_branch - uses: actions/configure-pages@v2 + uses: actions/configure-pages@v5 - name: Set up node version uses: actions/setup-node@v2 with: @@ -36,7 +36,7 @@ jobs: npm install npm run build - name: Upload artifact - uses: actions/upload-pages-artifact@v1 + uses: actions/upload-pages-artifact@v3 with: path: 'build' deploy: @@ -49,4 +49,4 @@ jobs: steps: - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v1 \ No newline at end of file + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/docs/graphql/index.md b/docs/graphql/index.md index d6935d1..bd4dbb1 100644 --- a/docs/graphql/index.md +++ b/docs/graphql/index.md @@ -6,6 +6,12 @@ GraphQL is a query language for APIs and can provide some nice benefits over a t Coilpack ships with the GraphQL integration disabled by default. If you would like to use GraphQL you can add `COILPACK_GRAPHQL_ENABLED=true` to your Laravel `.env` file +## Enabling Developer Tools + +You can interact with your site's GraphQL endpoints by using the built-in GraphiQL tool at `/graphiql` in the ExpressionEngine control panel. Once GraphQL is enabled this endpoint can be made available by adding `COILPACK_GRAPHIQL_ENABLED=true` to your Laravel `.env` file. + +Alternatively we recommend using [GraphQL Playground](https://github.com/graphql/graphql-playground) or [Insomnia](https://insomnia.rest/) to test your queries. + ## Securing your GraphQL Endpoint It is recommended that you secure your GraphQL endpoint in a production environment so authentication is required by default. You can use the command `php artisan coilpack:graphql --generate-token` to create a token and save it to your `.env` file. This token should be sent as an authorization header with any requests to the `/graphql` endpoint like this `Authorization: Bearer {COILPACK_GRAPHQL_TOKEN}`. @@ -66,12 +72,6 @@ The GraphQL integration's behavior can be configured in the `config/coilpack.php ... ``` -## Tools - -You can interact with your site's GraphQL endpoints by using the built-in GraphiQL tool at `/graphiql`. Once GraphQL is enabled this endpoint can be made available by adding `COILPACK_GRAPHIQL_ENABLED=true` to your Laravel `.env` file. - -Alternatively we recommend using [GraphQL Playground](https://github.com/graphql/graphql-playground) or [Insomnia](https://insomnia.rest/) to test your queries. - ## Add-on Developers If you are developing an Add-on for ExpressionEngine and would like to support GraphQL please refer to our [Add-ons documentation](../advanced/addons/graphql).