Packages
ash_graphql
1.11.0
1.12.0
1.11.0
1.10.1
1.10.0
1.9.4
1.9.3
1.9.2
1.9.1
1.9.0
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.0
1.5.1
1.5.0
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.1
1.2.0
1.1.1
1.1.0
1.0.1
1.0.0
1.0.0-rc.5
1.0.0-rc.4
retired
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.28.1
0.28.0
0.27.1
0.27.0
0.26.9
0.26.8
0.26.7
0.26.6
0.26.5
0.26.4
0.26.3
0.26.2
0.26.0
0.25.13
0.25.12
0.25.10
0.25.9
0.25.8
0.25.7
0.25.6
0.25.5
0.25.4
0.25.3
0.25.2
0.25.1
0.25.0
0.24.1
0.24.0
0.23.3
0.23.2
0.23.1
0.23.0
0.22.13
0.22.12
0.22.11
0.22.10
0.22.9
0.22.8
0.22.7
0.22.6
0.22.4
0.22.3
0.22.2
0.22.1
0.22.0
0.21.0
retired
0.20.5
0.20.4
0.20.3
0.20.2
0.20.1
0.20.0-rc.3
0.20.0-rc.2
0.20.0-rc.1
0.20.0-rc.0
0.19.0
0.18.0-rc0
0.17.5
0.17.5-rc0
0.17.4
0.17.2
0.17.1
0.17.0
0.16.28
0.16.27
0.16.26
0.16.25
0.16.24
0.16.23
0.16.22
0.16.21
0.16.20
0.16.18-rc5
0.16.18-rc4
0.16.18-rc3
0.16.18-rc2
0.16.18-rc1
0.16.18-rc0
0.16.17
0.16.16
0.16.15
0.16.14
0.16.13
0.16.12
0.16.11
0.16.10
0.16.9
0.16.8
0.16.7
0.16.6
0.16.5
0.16.4
0.16.3
0.16.2
0.16.1
0.16.0
0.15.10
0.15.9
0.15.8
0.15.7
0.15.6
0.15.5
0.15.4
0.15.3
0.15.2
0.15.1
0.15.0
0.14.1
0.14.0
0.13.1
0.13.0
0.12.5
0.12.4
0.12.3
0.12.1
0.12.0
0.10.0
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9.0
0.8.0
0.7.5
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.3
0.6.2
0.6.1
0.6.0
0.5.0
0.4.0
0.3.2
0.3.1
0.3.0
0.2.1
0.2.0
0.1.3
0.1.2
The extension for building GraphQL APIs with Ash
Current section
Files
Jump to
Current section
Files
lib/resource/mutation.ex
# SPDX-FileCopyrightText: 2020 ash_graphql contributors <https://github.com/ash-project/ash_graphql/graphs/contributors>
#
# SPDX-License-Identifier: MIT
defmodule AshGraphql.Resource.Mutation do
@moduledoc "Represents a configured mutation on a resource"
defstruct [
:name,
:action,
:type,
:identity,
:read_action,
:resource,
:upsert?,
:upsert_identity,
:modify_resolution,
:relay_id_translations,
:description,
:deprecate,
:result_name,
:__spark_metadata__,
args: [],
hide_inputs: [],
labels: [],
meta: [],
group: nil
]
@mutation_schema [
name: [
type: :atom,
doc: "The name to use for the mutation.",
default: :get
],
action: [
type: :atom,
doc: "The action to use for the mutation.",
required: true
],
description: [
type: :string,
doc:
"The mutation description that gets shown in the Graphql schema. If not provided, the action description will be used."
],
deprecate: [
type: {:or, [:boolean, :string]},
doc:
"Marks the mutation as deprecated. Pass `true` to omit the reason, or a string to provide a deprecation reason."
],
relay_id_translations: [
type: :keyword_list,
doc: """
A keyword list indicating arguments or attributes that have to be translated from global Relay IDs to internal IDs. See the [Relay guide](/documentation/topics/relay.md#translating-relay-global-ids-passed-as-arguments) for more.
""",
default: []
],
args: [
type: {:list, :atom},
doc: """
A list of action attributes or arguments that should get their own arguments in the mutation instead of being passed in an input object.
"""
],
hide_inputs: [
type: {:list, :atom},
doc: "A list of inputs to hide from the mutation."
],
labels: [
type: {:wrap_list, :atom},
doc: "Labels used to include or exclude this mutation from schemas with matching labels.",
default: []
],
modify_resolution: [
type: :mfa,
doc: """
An MFA that will be called with the resolution, the query, and the result of the action as the first three arguments. See the [the guide](/documentation/topics/modifying-the-resolution.html) for more.
"""
],
meta: [
type: :keyword_list,
doc: "A keyword list of metadata for the mutation.",
default: []
],
group: [
type: :atom,
doc: "An optional grouping key used to nest this mutation under a group wrapper."
],
result_name: [
type: :atom,
doc: "The GraphQL field name for the mutation result. Defaults to `result`."
]
]
@create_schema [
upsert?: [
type: :boolean,
default: false,
doc:
"Whether or not to use the `upsert?: true` option when calling `YourDomain.create/2`."
],
upsert_identity: [
type: :atom,
default: false,
doc: "Which identity to use for the upsert"
]
]
|> Spark.Options.merge(@mutation_schema, "Shared Mutation Options")
@update_schema [
identity: [
type: :atom,
doc: """
The identity to use to fetch the record to be updated. Use `false` if no identity is required.
"""
],
read_action: [
type: :atom,
doc:
"The read action to use to fetch the record to be updated. Defaults to the primary read action."
]
]
|> Spark.Options.merge(@mutation_schema, "Shared Mutation Options")
@destroy_schema [
identity: [
type: :atom,
doc: """
The identity to use to fetch the record to be destroyed. Use `false` if no identity is required.
"""
],
read_action: [
type: :atom,
doc:
"The read action to use to fetch the record to be destroyed. Defaults to the primary read action."
]
]
|> Spark.Options.merge(@mutation_schema, "Shared Mutation Options")
def create_schema, do: @create_schema
def update_schema, do: @update_schema
def destroy_schema, do: @destroy_schema
end