1
0
Fork 0
mirror of https://framagit.org/framasoft/mobilizon.git synced 2024-12-23 00:14:48 +00:00
mobilizon/lib/graphql/schema/config.ex
Thomas Citharel 3eacbb2ca3
Improve GraphQL documentation and cleanup API
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
2020-11-20 11:44:00 +01:00

279 lines
8.8 KiB
Elixir

defmodule Mobilizon.GraphQL.Schema.ConfigType do
@moduledoc """
Schema representation for User
"""
use Absinthe.Schema.Notation
alias Mobilizon.GraphQL.Resolvers.Config
@desc "A config object"
object :config do
# Instance name
field(:name, :string, description: "The instance's name")
field(:description, :string, description: "The instance's short description")
field(:long_description, :string, description: "The instance's long description")
field(:slogan, :string, description: "The instance's slogan")
field(:contact, :string, description: "The instance's contact details")
field(:languages, list_of(:string), description: "The instance's admins languages")
field(:registrations_open, :boolean, description: "Whether the registrations are opened")
field(:registrations_allowlist, :boolean,
description: "Whether the registration are on an allowlist"
)
field(:demo_mode, :boolean, description: "Whether the demo mode is enabled")
field(:country_code, :string, description: "The country code from the IP")
field(:location, :lonlat, description: "The IP's location")
field(:geocoding, :geocoding, description: "The instance's geocoding settings")
field(:maps, :maps, description: "The instance's maps settings")
field(:anonymous, :anonymous, description: "The instance's anonymous action settings")
field(:resource_providers, list_of(:resource_provider),
description: "The instance's enabled resource providers"
)
field(:timezones, list_of(:string), description: "The instance's available timezones")
field(:features, :features, description: "The instance's features")
field(:version, :string, description: "The instance's version")
field(:federating, :boolean, description: "Whether this instance is federation")
field(:terms, :terms, description: "The instance's terms") do
arg(:locale, :string,
default_value: "en",
description:
"The user's locale. The terms will be translated in their language, if available."
)
resolve(&Config.terms/3)
end
field(:privacy, :privacy, description: "The instance's privacy policy") do
arg(:locale, :string,
default_value: "en",
description:
"The user's locale. The privacy policy will be translated in their language, if available."
)
resolve(&Config.privacy/3)
end
field(:rules, :string, description: "The instance's rules")
field(:auth, :auth, description: "The instance auth methods")
end
@desc """
The instance's terms configuration
"""
object :terms do
field(:url, :string, description: "The instance's terms URL.")
field(:type, :instance_terms_type, description: "The instance's terms type")
field(:body_html, :string, description: "The instance's terms body text")
end
@desc """
The instance's privacy policy configuration
"""
object :privacy do
field(:url, :string, description: "The instance's privacy policy URL")
field(:type, :instance_privacy_type, description: "The instance's privacy policy type")
field(:body_html, :string, description: "The instance's privacy policy body text")
end
@desc """
Geographic coordinates
"""
object :lonlat do
field(:longitude, :float, description: "The coordinates longitude")
field(:latitude, :float, description: "The coordinates latitude")
# field(:accuracy_radius, :integer)
end
@desc """
Instance geocoding configuration
"""
object :geocoding do
field(:autocomplete, :boolean,
description: "Whether autocomplete in address fields can be enabled"
)
field(:provider, :string, description: "The geocoding provider")
end
@desc """
Instance maps configuration
"""
object :maps do
field(:tiles, :tiles, description: "The instance's maps tiles configuration")
end
@desc """
Instance tiles configuration
"""
object :tiles do
field(:endpoint, :string, description: "The instance's tiles endpoint")
field(:attribution, :string, description: "The instance's tiles attribution text")
end
@desc """
Instance anonymous configuration
"""
object :anonymous do
field(:participation, :anonymous_participation,
description: "The instance's anonymous participation settings"
)
field(:event_creation, :anonymous_event_creation,
description: "The instance's anonymous event creation settings"
)
field(:reports, :anonymous_reports, description: "The instance's anonymous reports setting")
field(:actor_id, :id,
description: "The actor ID that should be used to perform anonymous actions"
)
end
@desc """
Instance anonymous participation configuration
"""
object :anonymous_participation do
field(:allowed, :boolean, description: "Whether anonymous participations are allowed")
field(:validation, :anonymous_participation_validation,
description: "The ways to validate anonymous participations"
)
end
@desc """
Instance anonymous participation validation configuration
"""
object :anonymous_participation_validation do
field(:email, :anonymous_participation_validation_email,
description: "The policy to validate anonymous participations by email"
)
field(:captcha, :anonymous_participation_validation_captcha,
description: "The policy to validate anonymous participations by captcha"
)
end
@desc """
Instance anonymous participation with validation by email configuration
"""
object :anonymous_participation_validation_email do
field(:enabled, :boolean,
description: "Whether anonymous participation validation by email is enabled"
)
field(:confirmation_required, :boolean,
description: "Whether anonymous participation validation by email is required"
)
end
@desc """
Instance anonymous participation with validation by captcha configuration
"""
object :anonymous_participation_validation_captcha do
field(:enabled, :boolean,
description: "Whether anonymous participation validation by captcha is enabled"
)
end
@desc """
Instance anonymous event creation configuration
"""
object :anonymous_event_creation do
field(:allowed, :boolean, description: "Whether anonymous event creation is enabled")
field(:validation, :anonymous_event_creation_validation,
description: "The methods to validate events created anonymously"
)
end
@desc """
Instance anonymous event creation validation configuration
"""
object :anonymous_event_creation_validation do
field(:email, :anonymous_event_creation_validation_email,
description: "The policy to validate anonymous event creations by email"
)
field(:captcha, :anonymous_event_creation_validation_captcha,
description: "The policy to validate anonymous event creations by captcha"
)
end
@desc """
Instance anonymous event creation email validation configuration
"""
object :anonymous_event_creation_validation_email do
field(:enabled, :boolean,
description: "Whether anonymous event creation with email validation is enabled"
)
field(:confirmation_required, :boolean,
description: "Whether anonymous event creation with email validation is required"
)
end
@desc """
Instance anonymous event creation captcha validation configuration
"""
object :anonymous_event_creation_validation_captcha do
field(:enabled, :boolean,
description: "Whether anonymous event creation with validation by captcha is enabled"
)
end
@desc """
Instance anonymous reports
"""
object :anonymous_reports do
field(:allowed, :boolean, description: "Whether anonymous reports are allowed")
end
@desc """
A resource provider details
"""
object :resource_provider do
field(:type, :string, description: "The resource provider's type")
field(:endpoint, :string, description: "The resource provider's endpoint")
field(:software, :string, description: "The resource provider's software")
end
@desc """
The instance's features
"""
object :features do
field(:groups, :boolean, description: "Whether groups are activated on this instance")
field(:event_creation, :boolean,
description: "Whether event creation is allowed on this instance"
)
end
@desc """
The instance's auth configuration
"""
object :auth do
field(:ldap, :boolean, description: "Whether or not LDAP auth is enabled")
field(:oauth_providers, list_of(:oauth_provider), description: "List of oauth providers")
end
@desc """
An oAuth Provider
"""
object :oauth_provider do
field(:id, :string, description: "The provider ID")
field(:label, :string, description: "The label for the auth provider")
end
object :config_queries do
@desc "Get the instance config"
field :config, :config do
resolve(&Config.get_config/3)
end
end
end