Skip to content

Commit

Permalink
docs: improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zachdaniel committed Sep 15, 2023
1 parent 0ec7625 commit f7122eb
Show file tree
Hide file tree
Showing 23 changed files with 1,092 additions and 216 deletions.
3 changes: 2 additions & 1 deletion .check.exs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
## ...or adjusted (e.g. use one-line formatter for more compact credo output)
# {:credo, "mix credo --format oneline"},

{:check_formatter, command: "mix spark.formatter --check"}
{:check_formatter, command: "mix spark.formatter --check"},
{:doctor, false}

## custom new tools may be added (mix tasks or arbitrary commands)
# {:my_mix_task, command: "mix release", env: %{"MIX_ENV" => "prod"}},
Expand Down
37 changes: 37 additions & 0 deletions documentation/dsls/DSL:-AshGraphql.Api.cheatmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# DSL: AshGraphql.Api

The entrypoint for adding graphql behavior to an Ash API


## graphql
Global configuration for graphql




### Examples
```
graphql do
authorize? false # To skip authorization for this API
end

```




### Options
| Name | Type | Default | Docs |
| --- | --- | --- | --- |
| `authorize?` | `boolean` | true | Whether or not to perform authorization for this API |
| `tracer` | `atom` | | A tracer to use to trace execution in the graphql. Will use `config :ash, :tracer` if it is set. |
| `root_level_errors?` | `boolean` | false | By default, mutation errors are shown in their result object's errors key, but this setting places those errors in the top level errors list |
| `error_handler` | `mfa` | {AshGraphql.DefaultErrorHandler, :handle_error, []} | Set an MFA to intercept/handle any errors that are generated. |
| `show_raised_errors?` | `boolean` | false | For security purposes, if an error is *raised* then Ash simply shows a generic error. If you want to show those errors, set this to true. |
| `debug?` | `boolean` | false | Whether or not to log (extremely verbose) debug information |






Loading

0 comments on commit f7122eb

Please sign in to comment.