-
Notifications
You must be signed in to change notification settings - Fork 1
/
schema.gql
323 lines (268 loc) · 4.67 KB
/
schema.gql
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
"""
Full Post output type
"""
type PostType {
"""
The post id
"""
uuid: Uuid!
"""
Title of post
"""
title: String!
"""
Short overview of post
"""
excerpt: String!
"""
Full content of post
"""
content: String!
"""
Publish status of post
"""
published: Boolean!
"""
Price of post access in satoshis. If free is 0
"""
price: Int!
"""
Creation date of post
"""
createdAt: NaiveDateTime!
}
"""
This should provide a generic Input type for payable
data.
The input should expect an optional `payment` field
which would indicate a payment related to accessing
The requested piece of data.
If the field is not provided, the server should then
build an invoice that would be used to return a payment_request
to the client.
"""
input PayablePostInput {
"""
The ln paywall payment request string
"""
paymentRequest: String
"""
The requested post id
"""
uuid: Uuid!
}
input CreatePostInput {
"""
The title of post
"""
title: String!
"""
The content of the post
"""
content: String!
"""
A short overview of the post
"""
excerpt: String!
"""
Publishing status of the post
"""
published: Boolean!
"""
The access price for post
"""
price: Int!
}
type Mutation {
"""
Creates a post. This mutation is available only for authenticated users.
"""
createPost(post: CreatePostInput!): PostType!
"""
Upload and stores a payable media onto the server
"""
uploadFile(fileInput: FileInput!): Media!
"""
Changes password for current user
"""
changePassword(password: String!): Boolean!
}
"""
Preview Post output type
"""
type PreviewPostType {
"""
The post id
"""
uuid: Uuid!
"""
The title of the post
"""
title: String!
"""
Short overview of the post
"""
excerpt: String!
"""
Creation date of the post
"""
createdAt: NaiveDateTime!
"""
ln value to pay for content access
"""
price: Int!
}
type SettledPayment {
"""
The related media uuid
"""
mediaUuid: Uuid!
"""
The paywall ln invoice payment request string
"""
paymentRequest: String!
"""
The current state of the payment request
"""
state: String
}
union MediaInvoice = ReplacementPayment | AvailablePayment | SettledPayment
"""
A payment request object
"""
type PaymentType {
"""
The paywall ln invoice payment request string
"""
paymentRequest: String!
"""
The expiry time of current invoice
"""
expiresAt: NaiveDateTime!
"""
The current state of the payment request
"""
state: String
}
"""
Full Media output type
"""
type Media {
"""
The media internal id
"""
uuid: Uuid!
"""
Media's title
"""
title: String!
"""
Description of media
"""
description: String
"""
Price of media access in satoshis. If free is 0
"""
price: Int!
"""
Creation date of media
"""
createdAt: NaiveDateTime!
"""
the public URL to a media
"""
publicUrl: String!
"""
The file type
"""
fileType: String
"""
The file size
"""
fileSize: Int
}
type Query {
"""
Retrieves the list of posts
"""
getPostsList: [PreviewPostType!]!
"""
Requests list of files
"""
getFilesList: [Media!]!
"""
Requests an invoice for a media.
If a payment_request is provided, the query will check
for the provided payment_request status and provide a new onee
if necessary.
"""
requestInvoiceForMedia(uuid: Uuid!, paymentRequest: String): MediaInvoice!
"""
Requests a ln query paywall invoice for a given post
"""
requestInvoiceForPost(postId: Uuid!): PaymentType!
"""
Gets a specific post. The query is protected through a paywall
"""
getMedia(uuid: Uuid!, paymentRequest: String): Media!
"""
Gets a specific post. The query is protected through a paywall
"""
getPost(post: PayablePostInput!): PostType!
"""
Gets the list of available medias
"""
getMediasList: [Media!]!
}
"""
NaiveDateTime
"""
scalar NaiveDateTime
"""
Uuid
"""
scalar Uuid
type ReplacementPayment {
"""
The related media uuid
"""
mediaUuid: Uuid!
"""
The paywall ln invoice payment request string
"""
paymentRequest: String!
"""
The expiry time of current invoice
"""
expiresAt: NaiveDateTime!
"""
The current state of the payment request
"""
state: String
}
input FileInput {
filename: String!
title: String!
description: String
price: Int!
published: Boolean!
file: String
}
type AvailablePayment {
"""
The related media uuid
"""
mediaUuid: Uuid!
"""
The paywall ln invoice payment request string
"""
paymentRequest: String!
"""
The expiry time of current invoice
"""
expiresAt: NaiveDateTime!
"""
The current state of the payment request
"""
state: String
}