mirror/mobilizon
1
0
Fork 0
mirror of https://framagit.org/framasoft/mobilizon.git synced 2024-12-22 16:03:25 +00:00
Code Issues Releases Wiki Activity
mobilizon/schema.graphql
Thomas Citharel 757d2cabec
Add a dropdown on participate menu, disallow listing participations 
Now requires quering the person endpoint to know if an actor
participates in an event, organizers can make authenticated requests to
event { participants { } } to see the pending / approved participants.

Also closes #174

Signed-off-by: Thomas Citharel <tcit@tcit.fr>
2019-09-26 17:00:01 +02:00

1259 lines
26 KiB
GraphQL
Raw Blame History

# source: http://localhost:4000/api
# timestamp: Wed Sep 25 2019 16:41:05 GMT+0200 (GMT+02:00)
schema {
query: RootQueryType
mutation: RootMutationType
}
"""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 {
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
"""The actors RSA Keys"""
keys: String
"""If the actor is from this instance"""
local: Boolean
"""Whether the actors manually approves followers"""
manuallyApprovesFollowers: Boolean
"""The actor's displayed name"""
name: String
"""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 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 floor this event is at"""
floor: 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
url: String
}
input AddressInput {
country: String
description: String
"""The floor this event is at"""
floor: 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
url: String
}
"""A comment"""
type Comment {
"""Internal ID for this comment"""
id: ID
local: Boolean
primaryLanguage: String
replies: [Comment]
text: String
threadLanguages: [String]!
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 {
description: String
name: String
registrationsOpen: Boolean
}
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
"""When the event was created"""
createdAt: DateTime
"""The event's description"""
description: String
"""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 {
"""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
"""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
}
input EventOptionsInput {
"""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
"""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
}
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
"""What or who the profile follows"""
targetActor: Actor
}
"""
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
"""The actors RSA Keys"""
keys: String
"""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
}
"""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!
}
"""
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
}
"""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 role of this actor at this event"""
role: ParticipantRoleEnum
}
enum ParticipantRoleEnum {
ADMINISTRATOR
CREATOR
MODERATOR
NOT_APPROVED
PARTICIPANT
}
type ParticipantStats {
"""The number of approved participants"""
approved: Int
"""The number of unapproved participants"""
unapproved: Int
}
"""
Represents a person identity
"""
type Person 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
"""A list of the feed tokens for this person"""
feedTokens: [FeedToken]
"""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 person"""
id: ID
"""The actors RSA Keys"""
keys: String
"""If the actor is from this instance"""
local: Boolean
"""Whether the actors manually approves followers"""
manuallyApprovesFollowers: Boolean
"""The list of groups this person is member of"""
memberOf: [Member]
"""The actor's displayed name"""
name: String
"""A list of the events this actor has organized"""
organizedEvents: [Event]
"""The list of events this person goes to"""
participations(eventId: ID): [Participant]
"""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 user this actor is associated to"""
user: User
}
"""Search persons result"""
type Persons {
"""Person elements"""
elements: [Person]!
"""Total elements"""
total: Int!
}
"""A picture"""
type Picture {
"""The picture's alternative text"""
alt: String
"""The picture's detected content type"""
contentType: String
"""The picture's ID"""
id: ID
"""The picture's name"""
name: String
"""The picture's size"""
size: Int
"""The picture's full URL"""
url: String
}
"""An attached picture or a link to a picture"""
input PictureInput {
picture: PictureInputObject
pictureId: String
}
"""An attached picture"""
input PictureInputObject {
actorId: ID
alt: String
file: Upload!
name: String!
}
"""
The `Point` scalar type represents Point geographic information compliant string data,
represented as floats separated by a semi-colon. The geodetic system is WGS 84
"""
scalar Point
"""Token"""
type RefreshedToken {
"""Generated access token"""
accessToken: String!
"""Generated refreshed token"""
refreshToken: String!
}
"""A report object"""
type Report implements ActionLogObject {
"""The comments that are reported"""
comments: [Comment]
"""The comment the reporter added about this report"""
content: String
"""The event that is being reported"""
event: Event
"""The internal ID of the report"""
id: ID
"""When the report was created"""
insertedAt: DateTime
"""The notes made on the event"""
notes: [ReportNote]
"""The actor that is being reported"""
reported: Actor
"""The actor that created the report"""
reporter: Actor
"""Whether the report is still active"""
status: ReportStatus
"""When the report was updated"""
updatedAt: DateTime
"""The URI of the report"""
uri: String
}
"""A report note object"""
type ReportNote implements ActionLogObject {
"""The content of the note"""
content: String
"""The internal ID of the report note"""
id: ID
"""When the report note was created"""
insertedAt: DateTime
"""The moderator who added the note"""
moderator: Actor
"""The report on which this note is added"""
report: Report
}
"""The list of possible statuses for a report object"""
enum ReportStatus {
"""The report has been closed"""
CLOSED
"""The report has been opened"""
OPEN
"""The report has been marked as resolved"""
RESOLVED
}
type RootMutationType {
"""Accept a participation"""
acceptParticipation(id: ID!, moderatorActorId: ID!): Participant
"""Change default actor for user"""
changeDefaultActor(preferredUsername: String!): User
"""Change an user password"""
changePassword(newPassword: String!, oldPassword: String!): User
"""Create a comment"""
createComment(actorUsername: String!, text: String!): Comment
"""Create an event"""
createEvent(
beginsOn: DateTime!
category: String = "meeting"
description: String!
endsOn: DateTime
joinOptions: EventJoinOptions = FREE
onlineAddress: String
options: EventOptionsInput
organizerActorId: ID!
phoneAddress: String
physicalAddress: AddressInput
"""
The picture for the event, either as an object or directly the ID of an existing Picture
"""
picture: PictureInput
publishAt: DateTime
status: EventStatus
"""The list of tags associated to the event"""
tags: [String] = [""]
title: String!
visibility: EventVisibility = PUBLIC
): Event
"""Create a Feed Token"""
createFeedToken(actorId: ID): FeedToken
"""Create a group"""
createGroup(
"""
The avatar for the group, either as an object or directly the ID of an existing Picture
"""
avatar: PictureInput
"""
The banner for the group, either as an object or directly the ID of an existing Picture
"""
banner: PictureInput
"""The identity that creates the group"""
creatorActorId: ID!
"""The displayed name for the group"""
name: String
"""The name for the group"""
preferredUsername: String!
"""The summary for the group"""
summary: String = ""
): Group
"""Create a new person for user"""
createPerson(
"""
The avatar for the profile, either as an object or directly the ID of an existing Picture
"""
avatar: PictureInput
"""
The banner for the profile, either as an object or directly the ID of an existing Picture
"""
banner: PictureInput
"""The displayed name for the new profile"""
name: String = ""
preferredUsername: String!
"""The summary for the new profile"""
summary: String = ""
): Person
"""Create a report"""
createReport(commentsIds: [ID] = [""], content: String, eventId: ID, reportedActorId: ID!, reporterActorId: ID!): Report
"""Create a note on a report"""
createReportNote(content: String, moderatorId: ID!, reportId: ID!): ReportNote
"""Create an user"""
createUser(email: String!, password: String!): User
"""Delete an event"""
deleteEvent(actorId: ID!, eventId: ID!): DeletedObject
"""Delete a feed token"""
deleteFeedToken(token: String!): DeletedFeedToken
"""Delete a group"""
deleteGroup(actorId: ID!, groupId: ID!): DeletedObject
"""Delete an identity"""
deletePerson(preferredUsername: String!): Person
deleteReportNote(moderatorId: ID!, noteId: ID!): DeletedObject
"""Join an event"""
joinEvent(actorId: ID!, eventId: ID!): Participant
"""Join a group"""
joinGroup(actorId: ID!, groupId: ID!): Member
"""Leave an event"""
leaveEvent(actorId: ID!, eventId: ID!): DeletedParticipant
"""Leave an event"""
leaveGroup(actorId: ID!, groupId: ID!): DeletedMember
"""Login an user"""
login(email: String!, password: String!): Login
"""Refresh a token"""
refreshToken(refreshToken: String!): RefreshedToken
"""Register a first profile on registration"""
registerPerson(
"""
The avatar for the profile, either as an object or directly the ID of an existing Picture
"""
avatar: PictureInput
"""
The banner for the profile, either as an object or directly the ID of an existing Picture
"""
banner: PictureInput
"""The email from the user previously created"""
email: String!
"""The displayed name for the new profile"""
name: String = ""
preferredUsername: String!
"""The summary for the new profile"""
summary: String = ""
): Person
"""Reject a participation"""
rejectParticipation(id: ID!, moderatorActorId: ID!): DeletedParticipant
"""Resend registration confirmation token"""
resendConfirmationEmail(email: String!, locale: String = "en"): String
"""Reset user password"""
resetPassword(locale: String = "en", password: String!, token: String!): Login
"""Send a link through email to reset user password"""
sendResetPassword(email: String!, locale: String = "en"): String
"""Update an event"""
updateEvent(
beginsOn: DateTime
category: String
description: String
endsOn: DateTime
eventId: ID!
joinOptions: EventJoinOptions = FREE
onlineAddress: String
options: EventOptionsInput
phoneAddress: String
physicalAddress: AddressInput
"""
The picture for the event, either as an object or directly the ID of an existing Picture
"""
picture: PictureInput
status: EventStatus
"""The list of tags associated to the event"""
tags: [String]
title: String
visibility: EventVisibility = PUBLIC
): Event
"""Update an identity"""
updatePerson(
"""
The avatar for the profile, either as an object or directly the ID of an existing Picture
"""
avatar: PictureInput
"""
The banner for the profile, either as an object or directly the ID of an existing Picture
"""
banner: PictureInput
"""The displayed name for this profile"""
name: String
preferredUsername: String!
"""The summary for this profile"""
summary: String
): Person
"""Update a report"""
updateReportStatus(moderatorId: ID!, reportId: ID!, status: ReportStatus!): Report
"""Upload a picture"""
uploadPicture(actorId: ID!, alt: String, file: Upload!, name: String!): Picture
"""Validate an user after registration"""
validateUser(token: String!): Login
}
"""
Root Query
"""
type RootQueryType {
"""Get the list of action logs"""
actionLogs(limit: Int = 10, page: Int = 1): [ActionLog]
"""Get the instance config"""
config: Config
dashboard: Dashboard
"""Get an event by uuid"""
event(uuid: UUID!): Event
"""Get all events"""
events(limit: Int = 10, page: Int = 1): [Event]
"""Get a group by it's preferred username"""
group(preferredUsername: String!): Group
"""Get all groups"""
groups(limit: Int = 10, page: Int = 1): [Group]
"""Get the persons for an user"""
identities: [Person]
"""Get the current actor for the logged-in user"""
loggedPerson: Person
"""Get the current user"""
loggedUser: User
"""Get a person by it's preferred username"""
person(preferredUsername: String!): Person
"""Get a picture"""
picture(id: String!): Picture
"""Get a report by id"""
report(id: ID!): Report
"""Get all reports"""
reports(limit: Int = 10, page: Int = 1, status: ReportStatus = OPEN): [Report]
"""Reverse geocode coordinates"""
reverseGeocode(latitude: Float!, longitude: Float!): [Address]
"""Search for an address"""
searchAddress(limit: Int = 10, page: Int = 1, query: String!): [Address]
"""Search events"""
searchEvents(limit: Int = 10, page: Int = 1, search: String!): Events
"""Search groups"""
searchGroups(limit: Int = 10, page: Int = 1, search: String!): Groups
"""Search persons"""
searchPersons(limit: Int = 10, page: Int = 1, search: String!): Persons
"""Get the list of tags"""
tags(limit: Int = 10, page: Int = 1): [Tag]!
"""Get an user"""
user(id: ID!): User
"""List instance users"""
users(direction: SortDirection = DESC, limit: Int = 10, page: Int = 1, sort: SortableUserField = ID): Users
}
"""The list of possible options for the event's status"""
enum SortableUserField {
ID
}
"""Available sort directions"""
enum SortDirection {
ASC
DESC
}
"""A tag"""
type Tag {
"""The tag's ID"""
id: ID
"""Related tags to this tag"""
related: [Tag]
"""The tags's slug"""
slug: String
"""The tag's title"""
title: String
}
"""
Represents an uploaded file.
"""
scalar Upload
"""A local user of Mobilizon"""
type User {
"""The datetime the last activation/confirmation token was sent"""
confirmationSentAt: DateTime
"""The account activation/confirmation token"""
confirmationToken: String
"""The datetime when the user was confirmed/activated"""
confirmedAt: DateTime
"""The user's default actor"""
defaultActor: Person
"""The user's email"""
email: String!
"""A list of the feed tokens for this user"""
feedTokens: [FeedToken]
"""The user's ID"""
id: ID!
"""The list of events this user goes to"""
participations(afterDatetime: DateTime, beforeDatetime: DateTime, limit: Int = 10, page: Int = 1): [Participant]
"""The user's list of profiles (identities)"""
profiles: [Person]!
"""The datetime last reset password email was sent"""
resetPasswordSentAt: DateTime
"""The token sent when requesting password token"""
resetPasswordToken: String
"""The role for the user"""
role: UserRole
}
enum UserRole {
ADMINISTRATOR
MODERATOR
USER
}
"""Users list"""
type Users {
"""User elements"""
elements: [User]!
"""Total elements"""
total: Int!
}
"""
The `UUID` scalar type represents UUID4 compliant string data, represented as UTF-8
character sequences. The UUID4 type is most often used to represent unique
human-readable ID strings.
"""
scalar UUID
Reference in a new issue View git blame Copy permalink