mobilizon.chapril.org-mobilizon/schema.graphql

# source: http://localhost:4000/api
# timestamp: Wed Mar 04 2020 10:26:53 GMT+0100 (GMT+01:00)

schema {
  query: RootQueryType
  mutation: RootMutationType
  subscription: RootSubscriptionType
}

"""An action log"""
type ActionLog {
  """The action that was done"""
  action: ActionLogAction

  """The actor that acted"""
  actor: Actor

  """Internal ID for this comment"""
  id: ID

  """The time when the action was performed"""
  insertedAt: DateTime

  """The object that was acted upon"""
  object: ActionLogObject
}

enum ActionLogAction {
  COMMENT_DELETION
  EVENT_DELETION
  EVENT_UPDATE
  NOTE_CREATION
  NOTE_DELETION
  REPORT_UPDATE_CLOSED
  REPORT_UPDATE_OPENED
  REPORT_UPDATE_RESOLVED
}

"""The objects that can be in an action log"""
interface ActionLogObject {
  """Internal ID for this object"""
  id: ID
}

"""An ActivityPub actor"""
interface Actor {
  """The actor's avatar picture"""
  avatar: Picture

  """The actor's banner picture"""
  banner: Picture

  """The actor's domain if (null if it's this instance)"""
  domain: String

  """List of followers"""
  followers: [Follower]

  """Number of followers for this actor"""
  followersCount: Int

  """List of followings"""
  following: [Follower]

  """Number of actors following this actor"""
  followingCount: Int

  """Internal ID for this actor"""
  id: ID

  """If the actor is from this instance"""
  local: Boolean

  """Whether the actors manually approves followers"""
  manuallyApprovesFollowers: Boolean

  """The actor's displayed name"""
  name: String

  """The actor's preferred username"""
  preferredUsername: String

  """The actor's summary"""
  summary: String

  """If the actor is suspended"""
  suspended: Boolean

  """The type of Actor (Person, Group,…)"""
  type: ActorType

  """The ActivityPub actor's URL"""
  url: String
}

"""The list of types an actor can be"""
enum ActorType {
  """An ActivityPub Application"""
  APPLICATION

  """An ActivityPub Group"""
  GROUP

  """An ActivityPub Organization"""
  ORGANIZATION

  """An ActivityPub Person"""
  PERSON

  """An ActivityPub Service"""
  SERVICE
}

type Address {
  country: String
  description: String

  """The geocoordinates for the point where this address is"""
  geom: Point
  id: ID

  """The address's locality"""
  locality: String
  originId: String
  postalCode: String
  region: String

  """The address's street name (with number)"""
  street: String
  type: String
  url: String
}

input AddressInput {
  country: String
  description: String

  """The geocoordinates for the point where this address is"""
  geom: Point
  id: ID

  """The address's locality"""
  locality: String
  originId: String
  postalCode: String
  region: String

  """The address's street name (with number)"""
  street: String
  type: String
  url: String
}

type AdminSettings {
  instanceDescription: String
  instanceName: String
  instanceTerms: String
  instanceTermsType: InstanceTermsType
  instanceTermsUrl: String
  registrationsOpen: Boolean
}

type Anonymous {
  actorId: ID
  eventCreation: AnonymousEventCreation
  participation: AnonymousParticipation
}

type AnonymousEventCreation {
  allowed: Boolean
  validation: AnonymousEventCreationValidation
}

type AnonymousEventCreationValidation {
  captcha: AnonymousEventCreationValidationCaptcha
  email: AnonymousEventCreationValidationEmail
}

type AnonymousEventCreationValidationCaptcha {
  enabled: Boolean
}

type AnonymousEventCreationValidationEmail {
  confirmationRequired: Boolean
  enabled: Boolean
}

type AnonymousParticipation {
  allowed: Boolean
  validation: AnonymousParticipationValidation
}

type AnonymousParticipationValidation {
  captcha: AnonymousParticipationValidationCaptcha
  email: AnonymousParticipationValidationEmail
}

type AnonymousParticipationValidationCaptcha {
  enabled: Boolean
}

type AnonymousParticipationValidationEmail {
  confirmationRequired: Boolean
  enabled: Boolean
}

"""
Represents an application

"""
type Application implements Actor {
  """The actor's avatar picture"""
  avatar: Picture

  """The actor's banner picture"""
  banner: Picture

  """The actor's domain if (null if it's this instance)"""
  domain: String

  """List of followers"""
  followers: [Follower]

  """Number of followers for this actor"""
  followersCount: Int

  """List of followings"""
  following: [Follower]

  """Number of actors following this actor"""
  followingCount: Int

  """Internal ID for this application"""
  id: ID

  """If the actor is from this instance"""
  local: Boolean

  """Whether the actors manually approves followers"""
  manuallyApprovesFollowers: Boolean

  """The actor's displayed name"""
  name: String

  """The actor's preferred username"""
  preferredUsername: String

  """The actor's summary"""
  summary: String

  """If the actor is suspended"""
  suspended: Boolean

  """The type of Actor (Person, Group,…)"""
  type: ActorType

  """The ActivityPub actor's URL"""
  url: String
}

"""A comment"""
type Comment implements ActionLogObject {
  actor: Person
  deletedAt: DateTime
  event: Event

  """Internal ID for this comment"""
  id: ID
  inReplyToComment: Comment
  insertedAt: DateTime
  local: Boolean
  originComment: Comment
  primaryLanguage: String
  replies: [Comment]
  text: String
  threadLanguages: [String]!
  totalReplies: Int
  updatedAt: DateTime
  url: String
  uuid: UUID
  visibility: CommentVisibility
}

"""The list of visibility options for a comment"""
enum CommentVisibility {
  """visible only to people invited"""
  INVITE

  """Visible only after a moderator accepted"""
  MODERATED

  """Visible only to people members of the group or followers of the person"""
  PRIVATE

  """Publicly listed and federated. Can be shared."""
  PUBLIC

  """Visible only to people with the link - or invited"""
  UNLISTED
}

"""A config object"""
type Config {
  anonymous: Anonymous
  countryCode: String
  demoMode: Boolean
  description: String
  geocoding: Geocoding
  location: Lonlat
  maps: Maps
  name: String
  registrationsOpen: Boolean
  registrationsWhitelist: Boolean

  """The instance's terms"""
  terms(locale: String = "en"): Terms
}

type Dashboard {
  """Last public event publish"""
  lastPublicEventPublished: Event

  """The number of local comments"""
  numberOfComments: Int

  """The number of local events"""
  numberOfEvents: Int

  """The number of current opened reports"""
  numberOfReports: Int

  """The number of local users"""
  numberOfUsers: Int
}

"""
The `DateTime` scalar type represents a date and time in the UTC
timezone. The DateTime appears in a JSON response as an ISO8601 formatted
string, including UTC timezone ("Z"). The parsed date and time string will
be converted to UTC and any UTC offset other than 0 will be rejected.
"""
scalar DateTime

"""Represents a deleted feed_token"""
type DeletedFeedToken {
  actor: DeletedObject
  user: DeletedObject
}

"""Represents a deleted member"""
type DeletedMember {
  actor: DeletedObject
  parent: DeletedObject
}

"""A struct containing the id of the deleted object"""
type DeletedObject {
  id: ID
}

"""Represents a deleted participant"""
type DeletedParticipant {
  actor: DeletedObject
  event: DeletedObject
  id: ID
}

"""An event"""
type Event implements ActionLogObject {
  """Who the event is attributed to (often a group)"""
  attributedTo: Actor

  """Datetime for when the event begins"""
  beginsOn: DateTime

  """The event's category"""
  category: String

  """The comments in reply to the event"""
  comments: [Comment]

  """When the event was created"""
  createdAt: DateTime

  """The event's description"""
  description: String

  """Whether or not the event is a draft"""
  draft: Boolean

  """Datetime for when the event ends"""
  endsOn: DateTime

  """Internal ID for this event"""
  id: ID

  """The event's visibility"""
  joinOptions: EventJoinOptions

  """Whether the event is local or not"""
  local: Boolean

  """Online address of the event"""
  onlineAddress: String

  """The event options"""
  options: EventOptions

  """The event's organizer (as a person)"""
  organizerActor: Actor
  participantStats: ParticipantStats

  """The event's participants"""
  participants(actorId: ID, limit: Int = 10, page: Int = 1, roles: String = ""): [Participant]

  """Phone address for the event"""
  phoneAddress: String

  """The type of the event's address"""
  physicalAddress: Address

  """The event's picture"""
  picture: Picture

  """When the event was published"""
  publishAt: DateTime

  """Events related to this one"""
  relatedEvents: [Event]

  """The event's description's slug"""
  slug: String

  """Status of the event"""
  status: EventStatus

  """The event's tags"""
  tags: [Tag]

  """The event's title"""
  title: String

  """When the event was last updated"""
  updatedAt: DateTime

  """The ActivityPub Event URL"""
  url: String

  """The Event UUID"""
  uuid: UUID

  """The event's visibility"""
  visibility: EventVisibility
}

"""The list of possible options for the event's status"""
enum EventCommentModeration {
  """Anyone can comment under the event"""
  ALLOW_ALL

  """No one can comment except for the admin"""
  CLOSED

  """Every comment has to be moderated by the admin"""
  MODERATED
}

"""The list of join options for an event"""
enum EventJoinOptions {
  """Anyone can join and is automatically accepted"""
  FREE

  """Participants must be invited"""
  INVITE

  """Manual acceptation"""
  RESTRICTED
}

type EventOffer {
  """The price amount for this offer"""
  price: Float

  """The currency for this price offer"""
  priceCurrency: String

  """The URL to access to this offer"""
  url: String
}

input EventOfferInput {
  """The price amount for this offer"""
  price: Float

  """The currency for this price offer"""
  priceCurrency: String

  """The URL to access to this offer"""
  url: String
}

type EventOptions {
  """
  Whether or not to allow anonymous participation (if the server allows it)
  """
  anonymousParticipation: Boolean

  """The list of special attendees"""
  attendees: [String]

  """The policy on public comment moderation under the event"""
  commentModeration: EventCommentModeration

  """The maximum attendee capacity for this event"""
  maximumAttendeeCapacity: Int

  """The list of offers to show for this event"""
  offers: [EventOffer]

  """The list of participation conditions to accept to join this event"""
  participationConditions: [EventParticipationCondition]

  """The list of the event"""
  program: String

  """The number of remaining seats for this event"""
  remainingAttendeeCapacity: Int

  """Show event end time"""
  showEndTime: Boolean

  """Whether or not to show the participation price"""
  showParticipationPrice: Boolean

  """Whether or not to show the number of remaining seats for this event"""
  showRemainingAttendeeCapacity: Boolean

  """Show event start time"""
  showStartTime: Boolean
}

input EventOptionsInput {
  """
  Whether or not to allow anonymous participation (if the server allows it)
  """
  anonymousParticipation: Boolean = false

  """The list of special attendees"""
  attendees: [String]

  """The policy on public comment moderation under the event"""
  commentModeration: EventCommentModeration

  """The maximum attendee capacity for this event"""
  maximumAttendeeCapacity: Int

  """The list of offers to show for this event"""
  offers: [EventOfferInput]

  """The list of participation conditions to accept to join this event"""
  participationConditions: [EventParticipationConditionInput]

  """The list of the event"""
  program: String

  """The number of remaining seats for this event"""
  remainingAttendeeCapacity: Int

  """Show event end time"""
  showEndTime: Boolean

  """Whether or not to show the participation price"""
  showParticipationPrice: Boolean

  """Whether or not to show the number of remaining seats for this event"""
  showRemainingAttendeeCapacity: Boolean

  """Show event start time"""
  showStartTime: Boolean
}

type EventParticipationCondition {
  """The content for this condition"""
  content: String

  """The title for this condition"""
  title: String

  """The URL to access this condition"""
  url: String
}

input EventParticipationConditionInput {
  """The content for this condition"""
  content: String

  """The title for this condition"""
  title: String

  """The URL to access this condition"""
  url: String
}

"""Search events result"""
type Events {
  """Event elements"""
  elements: [Event]!

  """Total elements"""
  total: Int!
}

"""The list of possible options for the event's status"""
enum EventStatus {
  """The event is cancelled"""
  CANCELLED

  """The event is confirmed"""
  CONFIRMED

  """The event is tentative"""
  TENTATIVE
}

"""The list of visibility options for an event"""
enum EventVisibility {
  """Visible only to people members of the group or followers of the person"""
  PRIVATE

  """Publicly listed and federated. Can be shared."""
  PUBLIC

  """Visible only after a moderator accepted"""
  RESTRICTED

  """Visible only to people with the link - or invited"""
  UNLISTED
}

"""Represents a participant to an event"""
type FeedToken {
  """The event which the actor participates in"""
  actor: Actor

  """The role of this actor at this event"""
  token: String

  """The actor that participates to the event"""
  user: User
}

"""
Represents an actor's follower

"""
type Follower {
  """Which profile follows"""
  actor: Actor

  """Whether the follow has been approved by the target actor"""
  approved: Boolean

  """When the follow was created"""
  insertedAt: DateTime

  """What or who the profile follows"""
  targetActor: Actor

  """When the follow was updated"""
  updatedAt: DateTime
}

type Geocoding {
  autocomplete: Boolean
  provider: String
}

"""
Represents a group of actors

"""
type Group implements Actor {
  """The actor's avatar picture"""
  avatar: Picture

  """The actor's banner picture"""
  banner: Picture

  """The actor's domain if (null if it's this instance)"""
  domain: String

  """List of followers"""
  followers: [Follower]

  """Number of followers for this actor"""
  followersCount: Int

  """List of followings"""
  following: [Follower]

  """Number of actors following this actor"""
  followingCount: Int

  """Internal ID for this group"""
  id: ID

  """If the actor is from this instance"""
  local: Boolean

  """Whether the actors manually approves followers"""
  manuallyApprovesFollowers: Boolean

  """List of group members"""
  members: [Member]!

  """The actor's displayed name"""
  name: String

  """Whether the group is opened to all or has restricted access"""
  openness: Openness

  """A list of the events this actor has organized"""
  organizedEvents: [Event]

  """The actor's preferred username"""
  preferredUsername: String

  """The actor's summary"""
  summary: String

  """If the actor is suspended"""
  suspended: Boolean

  """The type of Actor (Person, Group,…)"""
  type: ActorType

  """The type of group : Group, Community,…"""
  types: GroupType

  """The ActivityPub actor's URL"""
  url: String
}

"""Search groups result"""
type Groups {
  """Group elements"""
  elements: [Group]!

  """Total elements"""
  total: Int!
}

"""
The types of Group that exist

"""
enum GroupType {
  """A public group of many actors"""
  COMMUNITY

  """A private group of persons"""
  GROUP
}

enum InstanceTermsType {
  CUSTOM
  DEFAULT
  URL
}

"""A JWT and the associated user ID"""
type Login {
  """A JWT Token for this session"""
  accessToken: String!

  """A JWT Token to refresh the access token"""
  refreshToken: String!

  """The user associated to this session"""
  user: User!
}

type Lonlat {
  accuracyRadius: Int
  latitude: Float
  longitude: Float
}

type Maps {
  tiles: Tiles
}

"""
Represents a member of a group

"""
type Member {
  """Which profile is member of"""
  actor: Person

  """Of which the profile is member"""
  parent: Group

  """The role of this membership"""
  role: Int
}

"""
Describes how an actor is opened to follows

"""
enum Openness {
  """The actor can only be followed by invitation"""
  INVITE_ONLY

  """The actor needs to accept the following before it's effective"""
  MODERATED

  """The actor is open to followings"""
  OPEN
}

type PaginatedFollowerList {
  """A list of followers"""
  elements: [Follower]

  """The total number of elements in the list"""
  total: Int
}

"""Represents a participant to an event"""
type Participant {
  """The actor that participates to the event"""
  actor: Actor

  """The event which the actor participates in"""
  event: Event

  """The participation ID"""
  id: ID

  """The datetime this participant was created"""
  insertedAt: DateTime

  """The metadata associated to this participant"""
  metadata: ParticipantMetadata

  """The role of this actor at this event"""
  role: ParticipantRoleEnum
}

type ParticipantMetadata {
  """The eventual token to leave an event when user is anonymous"""
  cancellationToken: String

  """The eventual message the participant left"""
  message: String
}

enum ParticipantRoleEnum {
  ADMINISTRATOR
  CREATOR
  MODERATOR
  NOT_APPROVED
  NOT_CONFIRMED
  PARTICIPANT
  REJECTED
}

type ParticipantStats {
  """The number of administrators"""
  administrator: Int

  """The number of creators"""
  creator: Int

  """The number of approved participants"""
  going: Int