Files
speckle-server/modules/core/graph/schemas/streams.graphql
T
2020-04-26 12:41:48 +01:00

73 lines
1.4 KiB
GraphQL

extend type Query {
stream(id: String!): Stream
}
type Stream {
id: String!
name: String!
description: String
isPublic: Boolean!
clonedFrom: Stream
createdAt: String!
updatedAt: String!
"""
All the users with access to this stream.
"""
users: [User]!
role: String
}
extend type User {
"""
All the streams that a user has access to.
"""
streamCollection(offset: Int! = 0, limit: Int! = 100): StreamCollection
role: String
}
type StreamCollection {
totalCount: Int!
streams: [Stream]
}
enum StreamUserRole {
"""
Onwers own.
"""
OWNER,
"""
Contributors can read and write.
"""
WRITE, # CONTRIBUTOR
"""
Reviewers can view and pull.
"""
READ # REVIEWER
}
extend type Mutation {
streamCreate( stream: StreamInput! ): String
streamUpdate( stream: StreamInput! ): Boolean!
streamDelete( id: String! ): Boolean!
"""
Clones a given stream, duplicating it within the current user's account without preserving access rights.
NOTE: Not implemented yet
"""
streamClone( id: String!): Boolean!
"""
Grants permissions to an user on a given stream.
"""
streamGrantPermission( streamId: String!, userId: String!, role: StreamUserRole! ): Boolean
"""
Revokes the permissions of an user on a given stream.
"""
streamRevokePermission( streamId: String!, userId: String! ): Boolean
}
input StreamInput {
id: String
name: String
description: String
isPublic: Boolean
}