Add missing leftover documentation for GraphQL schema

Signed-off-by: Thomas Citharel <tcit@tcit.fr>
This commit is contained in:
Thomas Citharel 2020-11-20 15:24:04 +01:00
parent 86cda335dc
commit 68a4222a18
No known key found for this signature in database
GPG key ID: A061B9DDE0CA0773
3 changed files with 18 additions and 0 deletions

View file

@ -80,6 +80,9 @@ defmodule Mobilizon.GraphQL.Schema.Actors.MemberType do
resolve(&Member.reject_invitation/3) resolve(&Member.reject_invitation/3)
end end
@desc """
Update a member's role
"""
field :update_member, :member do field :update_member, :member do
arg(:member_id, non_null(:id), description: "The member ID") arg(:member_id, non_null(:id), description: "The member ID")
arg(:role, non_null(:member_role_enum), description: "The new member role") arg(:role, non_null(:member_role_enum), description: "The new member role")

View file

@ -6,6 +6,9 @@ defmodule Mobilizon.GraphQL.Schema.AddressType do
alias Mobilizon.GraphQL.Resolvers.Address alias Mobilizon.GraphQL.Resolvers.Address
@desc """
An address object
"""
object :address do object :address do
field(:geom, :point, description: "The geocoordinates for the point where this address is") field(:geom, :point, description: "The geocoordinates for the point where this address is")
field(:street, :string, description: "The address's street name (with number)") field(:street, :string, description: "The address's street name (with number)")
@ -20,16 +23,25 @@ defmodule Mobilizon.GraphQL.Schema.AddressType do
field(:origin_id, :string, description: "The address's original ID from the provider") field(:origin_id, :string, description: "The address's original ID from the provider")
end end
@desc """
A phone address
"""
object :phone_address do object :phone_address do
field(:phone, :string, description: "The phone number") field(:phone, :string, description: "The phone number")
field(:info, :string, description: "Additional information about the phone number") field(:info, :string, description: "Additional information about the phone number")
end end
@desc """
An online address
"""
object :online_address do object :online_address do
field(:url, :string) field(:url, :string)
field(:info, :string) field(:info, :string)
end end
@desc """
An address input
"""
input_object :address_input do input_object :address_input do
# Either a full picture object # Either a full picture object
field(:geom, :point, description: "The geocoordinates for the point where this address is") field(:geom, :point, description: "The geocoordinates for the point where this address is")

View file

@ -136,6 +136,9 @@ defmodule Mobilizon.GraphQL.Schema.UserType do
value(:id, description: "The user's ID") value(:id, description: "The user's ID")
end end
@desc """
A set of user settings
"""
object :user_settings do object :user_settings do
field(:timezone, :string, description: "The timezone for this user") field(:timezone, :string, description: "The timezone for this user")