@peasant-labs/schema 0.51.0 → 0.53.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist/internal/generated/contract/zod.gen.d.ts +124 -0
- package/dist/internal/generated/contract/zod.gen.js +3 -1
- package/dist/internal/generated/enums.gen.d.ts +20 -17
- package/dist/internal/generated/enums.gen.js +6 -3
- package/dist/internal/generated/routes.gen.d.ts +652 -0
- package/dist/internal/generated/routes.gen.js +808 -0
- package/dist/internal/generated/versions.gen.d.ts +3 -3
- package/dist/internal/generated/versions.gen.js +3 -3
- package/dist/local-api.d.ts +2 -0
- package/dist/local-api.js +1 -0
- package/dist/route-member.d.ts +33 -0
- package/dist/route-member.js +50 -0
- package/dist/village-api.d.ts +2 -0
- package/dist/village-api.js +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,808 @@
|
|
|
1
|
+
// Code generated by `go run ./cmd/schema-gen`. DO NOT EDIT.
|
|
2
|
+
import { routeMember } from "../../route-member.js";
|
|
3
|
+
/** HttpMethod is the closed set of HTTP methods the Village API and Local API documents declare. */
|
|
4
|
+
export const HttpMethod = Object.freeze({
|
|
5
|
+
Get: "GET",
|
|
6
|
+
Post: "POST",
|
|
7
|
+
Put: "PUT",
|
|
8
|
+
Patch: "PATCH",
|
|
9
|
+
Delete: "DELETE",
|
|
10
|
+
});
|
|
11
|
+
/** ALL_HTTP_METHODS is the canonical order of HttpMethod. */
|
|
12
|
+
export const ALL_HTTP_METHODS = Object.freeze([HttpMethod.Get, HttpMethod.Post, HttpMethod.Put, HttpMethod.Patch, HttpMethod.Delete]);
|
|
13
|
+
export function isHttpMethod(value) {
|
|
14
|
+
return typeof value === "string" && ALL_HTTP_METHODS.includes(value);
|
|
15
|
+
}
|
|
16
|
+
/** VillageRoute holds one member per operation of the Village API document, named by operationId. */
|
|
17
|
+
export const VillageRoute = Object.freeze({
|
|
18
|
+
/**
|
|
19
|
+
* `POST /api/v1/annotations` (operationId `pushAnnotations`).
|
|
20
|
+
*/
|
|
21
|
+
PushAnnotations: routeMember(HttpMethod.Post, "/api/v1/annotations", "pushAnnotations"),
|
|
22
|
+
/**
|
|
23
|
+
* `GET /api/v1/annotations/manifest` (operationId `getAnnotationManifest`).
|
|
24
|
+
*/
|
|
25
|
+
GetAnnotationManifest: routeMember(HttpMethod.Get, "/api/v1/annotations/manifest", "getAnnotationManifest"),
|
|
26
|
+
/**
|
|
27
|
+
* `POST /api/v1/auth/cli/exchange` (operationId `cliExchangeCode`).
|
|
28
|
+
*/
|
|
29
|
+
CliExchangeCode: routeMember(HttpMethod.Post, "/api/v1/auth/cli/exchange", "cliExchangeCode"),
|
|
30
|
+
/**
|
|
31
|
+
* `GET /api/v1/auth/cli/login` (operationId `cliLogin`).
|
|
32
|
+
*/
|
|
33
|
+
CliLogin: routeMember(HttpMethod.Get, "/api/v1/auth/cli/login", "cliLogin"),
|
|
34
|
+
/**
|
|
35
|
+
* `GET /api/v1/auth/me` (operationId `getAuthenticatedVillageUser`).
|
|
36
|
+
*/
|
|
37
|
+
GetAuthenticatedVillageUser: routeMember(HttpMethod.Get, "/api/v1/auth/me", "getAuthenticatedVillageUser"),
|
|
38
|
+
/**
|
|
39
|
+
* `GET /api/v1/auth/orgs` (operationId `listAuthenticatedVillageOrganizations`).
|
|
40
|
+
*/
|
|
41
|
+
ListAuthenticatedVillageOrganizations: routeMember(HttpMethod.Get, "/api/v1/auth/orgs", "listAuthenticatedVillageOrganizations"),
|
|
42
|
+
/**
|
|
43
|
+
* `GET /api/v1/collectives` (operationId `listGroups`).
|
|
44
|
+
*/
|
|
45
|
+
ListGroups: routeMember(HttpMethod.Get, "/api/v1/collectives", "listGroups"),
|
|
46
|
+
/**
|
|
47
|
+
* `POST /api/v1/collectives` (operationId `createGroup`).
|
|
48
|
+
*/
|
|
49
|
+
CreateGroup: routeMember(HttpMethod.Post, "/api/v1/collectives", "createGroup"),
|
|
50
|
+
/**
|
|
51
|
+
* `GET /api/v1/collectives/public` (operationId `listPublicGroups`).
|
|
52
|
+
*/
|
|
53
|
+
ListPublicGroups: routeMember(HttpMethod.Get, "/api/v1/collectives/public", "listPublicGroups"),
|
|
54
|
+
/**
|
|
55
|
+
* `GET /api/v1/collectives/search` (operationId `searchCollectives`).
|
|
56
|
+
*/
|
|
57
|
+
SearchCollectives: routeMember(HttpMethod.Get, "/api/v1/collectives/search", "searchCollectives"),
|
|
58
|
+
/**
|
|
59
|
+
* `GET /api/v1/collectives/visible` (operationId `listVisibleGroups`).
|
|
60
|
+
*/
|
|
61
|
+
ListVisibleGroups: routeMember(HttpMethod.Get, "/api/v1/collectives/visible", "listVisibleGroups"),
|
|
62
|
+
/**
|
|
63
|
+
* `GET /api/v1/collectives/{id}` (operationId `getGroup`).
|
|
64
|
+
*/
|
|
65
|
+
GetGroup: routeMember(HttpMethod.Get, "/api/v1/collectives/{id}", "getGroup"),
|
|
66
|
+
/**
|
|
67
|
+
* `PATCH /api/v1/collectives/{id}` (operationId `updateGroup`).
|
|
68
|
+
*/
|
|
69
|
+
UpdateGroup: routeMember(HttpMethod.Patch, "/api/v1/collectives/{id}", "updateGroup"),
|
|
70
|
+
/**
|
|
71
|
+
* `DELETE /api/v1/collectives/{id}` (operationId `deleteGroup`).
|
|
72
|
+
*/
|
|
73
|
+
DeleteGroup: routeMember(HttpMethod.Delete, "/api/v1/collectives/{id}", "deleteGroup"),
|
|
74
|
+
/**
|
|
75
|
+
* `GET /api/v1/collectives/{id}/contributable` (operationId `listContributableTranscripts`).
|
|
76
|
+
*/
|
|
77
|
+
ListContributableTranscripts: routeMember(HttpMethod.Get, "/api/v1/collectives/{id}/contributable", "listContributableTranscripts"),
|
|
78
|
+
/**
|
|
79
|
+
* `GET /api/v1/collectives/{id}/invitations` (operationId `listGroupInvitations`).
|
|
80
|
+
*/
|
|
81
|
+
ListGroupInvitations: routeMember(HttpMethod.Get, "/api/v1/collectives/{id}/invitations", "listGroupInvitations"),
|
|
82
|
+
/**
|
|
83
|
+
* `POST /api/v1/collectives/{id}/invitations` (operationId `createGroupInvitation`).
|
|
84
|
+
*/
|
|
85
|
+
CreateGroupInvitation: routeMember(HttpMethod.Post, "/api/v1/collectives/{id}/invitations", "createGroupInvitation"),
|
|
86
|
+
/**
|
|
87
|
+
* `DELETE /api/v1/collectives/{id}/invitations/{invitationID}` (operationId `revokeGroupInvitation`).
|
|
88
|
+
*/
|
|
89
|
+
RevokeGroupInvitation: routeMember(HttpMethod.Delete, "/api/v1/collectives/{id}/invitations/{invitationID}", "revokeGroupInvitation"),
|
|
90
|
+
/**
|
|
91
|
+
* `POST /api/v1/collectives/{id}/join` (operationId `joinGroup`).
|
|
92
|
+
*/
|
|
93
|
+
JoinGroup: routeMember(HttpMethod.Post, "/api/v1/collectives/{id}/join", "joinGroup"),
|
|
94
|
+
/**
|
|
95
|
+
* `DELETE /api/v1/collectives/{id}/members/{userID}` (operationId `removeGroupMember`).
|
|
96
|
+
*/
|
|
97
|
+
RemoveGroupMember: routeMember(HttpMethod.Delete, "/api/v1/collectives/{id}/members/{userID}", "removeGroupMember"),
|
|
98
|
+
/**
|
|
99
|
+
* `PATCH /api/v1/collectives/{id}/members/{userID}/role` (operationId `updateGroupMemberRole`).
|
|
100
|
+
*/
|
|
101
|
+
UpdateGroupMemberRole: routeMember(HttpMethod.Patch, "/api/v1/collectives/{id}/members/{userID}/role", "updateGroupMemberRole"),
|
|
102
|
+
/**
|
|
103
|
+
* `GET /api/v1/collectives/{id}/my-shares` (operationId `listMyGroupShares`).
|
|
104
|
+
*/
|
|
105
|
+
ListMyGroupShares: routeMember(HttpMethod.Get, "/api/v1/collectives/{id}/my-shares", "listMyGroupShares"),
|
|
106
|
+
/**
|
|
107
|
+
* `GET /api/v1/collectives/{id}/pending` (operationId `listPendingShares`).
|
|
108
|
+
*/
|
|
109
|
+
ListPendingShares: routeMember(HttpMethod.Get, "/api/v1/collectives/{id}/pending", "listPendingShares"),
|
|
110
|
+
/**
|
|
111
|
+
* `GET /api/v1/collectives/{id}/repositories` (operationId `listGroupRepositories`).
|
|
112
|
+
*/
|
|
113
|
+
ListGroupRepositories: routeMember(HttpMethod.Get, "/api/v1/collectives/{id}/repositories", "listGroupRepositories"),
|
|
114
|
+
/**
|
|
115
|
+
* `POST /api/v1/collectives/{id}/repositories` (operationId `linkGroupRepository`).
|
|
116
|
+
*/
|
|
117
|
+
LinkGroupRepository: routeMember(HttpMethod.Post, "/api/v1/collectives/{id}/repositories", "linkGroupRepository"),
|
|
118
|
+
/**
|
|
119
|
+
* `GET /api/v1/collectives/{id}/repositories/available` (operationId `listAvailableGroupRepositories`).
|
|
120
|
+
*/
|
|
121
|
+
ListAvailableGroupRepositories: routeMember(HttpMethod.Get, "/api/v1/collectives/{id}/repositories/available", "listAvailableGroupRepositories"),
|
|
122
|
+
/**
|
|
123
|
+
* `DELETE /api/v1/collectives/{id}/repositories/{owner}/{name}` (operationId `unlinkGroupRepository`).
|
|
124
|
+
*/
|
|
125
|
+
UnlinkGroupRepository: routeMember(HttpMethod.Delete, "/api/v1/collectives/{id}/repositories/{owner}/{name}", "unlinkGroupRepository"),
|
|
126
|
+
/**
|
|
127
|
+
* `GET /api/v1/collectives/{id}/repositories/{owner}/{name}/commits` (operationId `listGroupRepositoryCommits`).
|
|
128
|
+
*/
|
|
129
|
+
ListGroupRepositoryCommits: routeMember(HttpMethod.Get, "/api/v1/collectives/{id}/repositories/{owner}/{name}/commits", "listGroupRepositoryCommits"),
|
|
130
|
+
/**
|
|
131
|
+
* `POST /api/v1/collectives/{id}/shares` (operationId `batchShareProject`).
|
|
132
|
+
*/
|
|
133
|
+
BatchShareProject: routeMember(HttpMethod.Post, "/api/v1/collectives/{id}/shares", "batchShareProject"),
|
|
134
|
+
/**
|
|
135
|
+
* `PATCH /api/v1/collectives/{id}/shares` (operationId `batchReviewShares`).
|
|
136
|
+
*/
|
|
137
|
+
BatchReviewShares: routeMember(HttpMethod.Patch, "/api/v1/collectives/{id}/shares", "batchReviewShares"),
|
|
138
|
+
/**
|
|
139
|
+
* `PATCH /api/v1/collectives/{id}/shares/{transcriptID}` (operationId `reviewShare`).
|
|
140
|
+
*/
|
|
141
|
+
ReviewShare: routeMember(HttpMethod.Patch, "/api/v1/collectives/{id}/shares/{transcriptID}", "reviewShare"),
|
|
142
|
+
/**
|
|
143
|
+
* `DELETE /api/v1/collectives/{id}/transcripts/{transcriptID}` (operationId `removeGroupTranscript`).
|
|
144
|
+
*/
|
|
145
|
+
RemoveGroupTranscript: routeMember(HttpMethod.Delete, "/api/v1/collectives/{id}/transcripts/{transcriptID}", "removeGroupTranscript"),
|
|
146
|
+
/**
|
|
147
|
+
* `POST /api/v1/email/unsubscribe` (operationId `unsubscribeInvitationEmails`).
|
|
148
|
+
*/
|
|
149
|
+
UnsubscribeInvitationEmails: routeMember(HttpMethod.Post, "/api/v1/email/unsubscribe", "unsubscribeInvitationEmails"),
|
|
150
|
+
/**
|
|
151
|
+
* `GET /api/v1/groups` (operationId `listGroupsDeprecated`).
|
|
152
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
153
|
+
*/
|
|
154
|
+
ListGroupsDeprecated: routeMember(HttpMethod.Get, "/api/v1/groups", "listGroupsDeprecated"),
|
|
155
|
+
/**
|
|
156
|
+
* `POST /api/v1/groups` (operationId `createGroupDeprecated`).
|
|
157
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
158
|
+
*/
|
|
159
|
+
CreateGroupDeprecated: routeMember(HttpMethod.Post, "/api/v1/groups", "createGroupDeprecated"),
|
|
160
|
+
/**
|
|
161
|
+
* `GET /api/v1/groups/public` (operationId `listPublicGroupsDeprecated`).
|
|
162
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
163
|
+
*/
|
|
164
|
+
ListPublicGroupsDeprecated: routeMember(HttpMethod.Get, "/api/v1/groups/public", "listPublicGroupsDeprecated"),
|
|
165
|
+
/**
|
|
166
|
+
* `GET /api/v1/groups/search` (operationId `searchCollectivesDeprecated`).
|
|
167
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
168
|
+
*/
|
|
169
|
+
SearchCollectivesDeprecated: routeMember(HttpMethod.Get, "/api/v1/groups/search", "searchCollectivesDeprecated"),
|
|
170
|
+
/**
|
|
171
|
+
* `GET /api/v1/groups/visible` (operationId `listVisibleGroupsDeprecated`).
|
|
172
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
173
|
+
*/
|
|
174
|
+
ListVisibleGroupsDeprecated: routeMember(HttpMethod.Get, "/api/v1/groups/visible", "listVisibleGroupsDeprecated"),
|
|
175
|
+
/**
|
|
176
|
+
* `GET /api/v1/groups/{id}` (operationId `getGroupDeprecated`).
|
|
177
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
178
|
+
*/
|
|
179
|
+
GetGroupDeprecated: routeMember(HttpMethod.Get, "/api/v1/groups/{id}", "getGroupDeprecated"),
|
|
180
|
+
/**
|
|
181
|
+
* `PATCH /api/v1/groups/{id}` (operationId `updateGroupDeprecated`).
|
|
182
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
183
|
+
*/
|
|
184
|
+
UpdateGroupDeprecated: routeMember(HttpMethod.Patch, "/api/v1/groups/{id}", "updateGroupDeprecated"),
|
|
185
|
+
/**
|
|
186
|
+
* `DELETE /api/v1/groups/{id}` (operationId `deleteGroupDeprecated`).
|
|
187
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
188
|
+
*/
|
|
189
|
+
DeleteGroupDeprecated: routeMember(HttpMethod.Delete, "/api/v1/groups/{id}", "deleteGroupDeprecated"),
|
|
190
|
+
/**
|
|
191
|
+
* `GET /api/v1/groups/{id}/contributable` (operationId `listContributableTranscriptsDeprecated`).
|
|
192
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
193
|
+
*/
|
|
194
|
+
ListContributableTranscriptsDeprecated: routeMember(HttpMethod.Get, "/api/v1/groups/{id}/contributable", "listContributableTranscriptsDeprecated"),
|
|
195
|
+
/**
|
|
196
|
+
* `GET /api/v1/groups/{id}/invitations` (operationId `listGroupInvitationsDeprecated`).
|
|
197
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
198
|
+
*/
|
|
199
|
+
ListGroupInvitationsDeprecated: routeMember(HttpMethod.Get, "/api/v1/groups/{id}/invitations", "listGroupInvitationsDeprecated"),
|
|
200
|
+
/**
|
|
201
|
+
* `POST /api/v1/groups/{id}/invitations` (operationId `createGroupInvitationDeprecated`).
|
|
202
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
203
|
+
*/
|
|
204
|
+
CreateGroupInvitationDeprecated: routeMember(HttpMethod.Post, "/api/v1/groups/{id}/invitations", "createGroupInvitationDeprecated"),
|
|
205
|
+
/**
|
|
206
|
+
* `DELETE /api/v1/groups/{id}/invitations/{invitationID}` (operationId `revokeGroupInvitationDeprecated`).
|
|
207
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
208
|
+
*/
|
|
209
|
+
RevokeGroupInvitationDeprecated: routeMember(HttpMethod.Delete, "/api/v1/groups/{id}/invitations/{invitationID}", "revokeGroupInvitationDeprecated"),
|
|
210
|
+
/**
|
|
211
|
+
* `POST /api/v1/groups/{id}/join` (operationId `joinGroupDeprecated`).
|
|
212
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
213
|
+
*/
|
|
214
|
+
JoinGroupDeprecated: routeMember(HttpMethod.Post, "/api/v1/groups/{id}/join", "joinGroupDeprecated"),
|
|
215
|
+
/**
|
|
216
|
+
* `DELETE /api/v1/groups/{id}/members/{userID}` (operationId `removeGroupMemberDeprecated`).
|
|
217
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
218
|
+
*/
|
|
219
|
+
RemoveGroupMemberDeprecated: routeMember(HttpMethod.Delete, "/api/v1/groups/{id}/members/{userID}", "removeGroupMemberDeprecated"),
|
|
220
|
+
/**
|
|
221
|
+
* `PATCH /api/v1/groups/{id}/members/{userID}/role` (operationId `updateGroupMemberRoleDeprecated`).
|
|
222
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
223
|
+
*/
|
|
224
|
+
UpdateGroupMemberRoleDeprecated: routeMember(HttpMethod.Patch, "/api/v1/groups/{id}/members/{userID}/role", "updateGroupMemberRoleDeprecated"),
|
|
225
|
+
/**
|
|
226
|
+
* `GET /api/v1/groups/{id}/my-shares` (operationId `listMyGroupSharesDeprecated`).
|
|
227
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
228
|
+
*/
|
|
229
|
+
ListMyGroupSharesDeprecated: routeMember(HttpMethod.Get, "/api/v1/groups/{id}/my-shares", "listMyGroupSharesDeprecated"),
|
|
230
|
+
/**
|
|
231
|
+
* `GET /api/v1/groups/{id}/pending` (operationId `listPendingSharesDeprecated`).
|
|
232
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
233
|
+
*/
|
|
234
|
+
ListPendingSharesDeprecated: routeMember(HttpMethod.Get, "/api/v1/groups/{id}/pending", "listPendingSharesDeprecated"),
|
|
235
|
+
/**
|
|
236
|
+
* `GET /api/v1/groups/{id}/repositories` (operationId `listGroupRepositoriesDeprecated`).
|
|
237
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
238
|
+
*/
|
|
239
|
+
ListGroupRepositoriesDeprecated: routeMember(HttpMethod.Get, "/api/v1/groups/{id}/repositories", "listGroupRepositoriesDeprecated"),
|
|
240
|
+
/**
|
|
241
|
+
* `POST /api/v1/groups/{id}/repositories` (operationId `linkGroupRepositoryDeprecated`).
|
|
242
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
243
|
+
*/
|
|
244
|
+
LinkGroupRepositoryDeprecated: routeMember(HttpMethod.Post, "/api/v1/groups/{id}/repositories", "linkGroupRepositoryDeprecated"),
|
|
245
|
+
/**
|
|
246
|
+
* `GET /api/v1/groups/{id}/repositories/available` (operationId `listAvailableGroupRepositoriesDeprecated`).
|
|
247
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
248
|
+
*/
|
|
249
|
+
ListAvailableGroupRepositoriesDeprecated: routeMember(HttpMethod.Get, "/api/v1/groups/{id}/repositories/available", "listAvailableGroupRepositoriesDeprecated"),
|
|
250
|
+
/**
|
|
251
|
+
* `DELETE /api/v1/groups/{id}/repositories/{owner}/{name}` (operationId `unlinkGroupRepositoryDeprecated`).
|
|
252
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
253
|
+
*/
|
|
254
|
+
UnlinkGroupRepositoryDeprecated: routeMember(HttpMethod.Delete, "/api/v1/groups/{id}/repositories/{owner}/{name}", "unlinkGroupRepositoryDeprecated"),
|
|
255
|
+
/**
|
|
256
|
+
* `GET /api/v1/groups/{id}/repositories/{owner}/{name}/commits` (operationId `listGroupRepositoryCommitsDeprecated`).
|
|
257
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
258
|
+
*/
|
|
259
|
+
ListGroupRepositoryCommitsDeprecated: routeMember(HttpMethod.Get, "/api/v1/groups/{id}/repositories/{owner}/{name}/commits", "listGroupRepositoryCommitsDeprecated"),
|
|
260
|
+
/**
|
|
261
|
+
* `POST /api/v1/groups/{id}/shares` (operationId `batchShareProjectDeprecated`).
|
|
262
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
263
|
+
*/
|
|
264
|
+
BatchShareProjectDeprecated: routeMember(HttpMethod.Post, "/api/v1/groups/{id}/shares", "batchShareProjectDeprecated"),
|
|
265
|
+
/**
|
|
266
|
+
* `PATCH /api/v1/groups/{id}/shares` (operationId `batchReviewSharesDeprecated`).
|
|
267
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
268
|
+
*/
|
|
269
|
+
BatchReviewSharesDeprecated: routeMember(HttpMethod.Patch, "/api/v1/groups/{id}/shares", "batchReviewSharesDeprecated"),
|
|
270
|
+
/**
|
|
271
|
+
* `PATCH /api/v1/groups/{id}/shares/{transcriptID}` (operationId `reviewShareDeprecated`).
|
|
272
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
273
|
+
*/
|
|
274
|
+
ReviewShareDeprecated: routeMember(HttpMethod.Patch, "/api/v1/groups/{id}/shares/{transcriptID}", "reviewShareDeprecated"),
|
|
275
|
+
/**
|
|
276
|
+
* `DELETE /api/v1/groups/{id}/transcripts/{transcriptID}` (operationId `removeGroupTranscriptDeprecated`).
|
|
277
|
+
* @deprecated The Village API document marks this operation deprecated.
|
|
278
|
+
*/
|
|
279
|
+
RemoveGroupTranscriptDeprecated: routeMember(HttpMethod.Delete, "/api/v1/groups/{id}/transcripts/{transcriptID}", "removeGroupTranscriptDeprecated"),
|
|
280
|
+
/**
|
|
281
|
+
* `POST /api/v1/integrations/github/webhook` (operationId `receiveGitHubWebhook`).
|
|
282
|
+
*/
|
|
283
|
+
ReceiveGitHubWebhook: routeMember(HttpMethod.Post, "/api/v1/integrations/github/webhook", "receiveGitHubWebhook"),
|
|
284
|
+
/**
|
|
285
|
+
* `GET /api/v1/orgs/{login}` (operationId `getVillageOrganizationCollectives`).
|
|
286
|
+
*/
|
|
287
|
+
GetVillageOrganizationCollectives: routeMember(HttpMethod.Get, "/api/v1/orgs/{login}", "getVillageOrganizationCollectives"),
|
|
288
|
+
/**
|
|
289
|
+
* `GET /api/v1/pull/transcripts` (operationId `listPullableTranscripts`).
|
|
290
|
+
*/
|
|
291
|
+
ListPullableTranscripts: routeMember(HttpMethod.Get, "/api/v1/pull/transcripts", "listPullableTranscripts"),
|
|
292
|
+
/**
|
|
293
|
+
* `POST /api/v1/pull/transcripts/skip-gate` (operationId `pullSkipGate`).
|
|
294
|
+
*/
|
|
295
|
+
PullSkipGate: routeMember(HttpMethod.Post, "/api/v1/pull/transcripts/skip-gate", "pullSkipGate"),
|
|
296
|
+
/**
|
|
297
|
+
* `GET /api/v1/pull/transcripts/{id}` (operationId `getPullTranscript`).
|
|
298
|
+
*/
|
|
299
|
+
GetPullTranscript: routeMember(HttpMethod.Get, "/api/v1/pull/transcripts/{id}", "getPullTranscript"),
|
|
300
|
+
/**
|
|
301
|
+
* `GET /api/v1/pull/transcripts/{id}/annotations` (operationId `getPullTranscriptAnnotations`).
|
|
302
|
+
*/
|
|
303
|
+
GetPullTranscriptAnnotations: routeMember(HttpMethod.Get, "/api/v1/pull/transcripts/{id}/annotations", "getPullTranscriptAnnotations"),
|
|
304
|
+
/**
|
|
305
|
+
* `GET /api/v1/pull/transcripts/{id}/content` (operationId `getPullTranscriptContent`).
|
|
306
|
+
*/
|
|
307
|
+
GetPullTranscriptContent: routeMember(HttpMethod.Get, "/api/v1/pull/transcripts/{id}/content", "getPullTranscriptContent"),
|
|
308
|
+
/**
|
|
309
|
+
* `GET /api/v1/pull/transcripts/{id}/publish-metadata` (operationId `getPullTranscriptPublishMetadata`).
|
|
310
|
+
*/
|
|
311
|
+
GetPullTranscriptPublishMetadata: routeMember(HttpMethod.Get, "/api/v1/pull/transcripts/{id}/publish-metadata", "getPullTranscriptPublishMetadata"),
|
|
312
|
+
/**
|
|
313
|
+
* `GET /api/v1/pulls/{owner}/{name}/{number}` (operationId `getPullRequestAttachment`).
|
|
314
|
+
*/
|
|
315
|
+
GetPullRequestAttachment: routeMember(HttpMethod.Get, "/api/v1/pulls/{owner}/{name}/{number}", "getPullRequestAttachment"),
|
|
316
|
+
/**
|
|
317
|
+
* `DELETE /api/v1/pulls/{owner}/{name}/{number}` (operationId `detachPullRequestAttachment`).
|
|
318
|
+
*/
|
|
319
|
+
DetachPullRequestAttachment: routeMember(HttpMethod.Delete, "/api/v1/pulls/{owner}/{name}/{number}", "detachPullRequestAttachment"),
|
|
320
|
+
/**
|
|
321
|
+
* `POST /api/v1/pulls/{owner}/{name}/{number}/confirm` (operationId `confirmPullRequestAttachment`).
|
|
322
|
+
*/
|
|
323
|
+
ConfirmPullRequestAttachment: routeMember(HttpMethod.Post, "/api/v1/pulls/{owner}/{name}/{number}/confirm", "confirmPullRequestAttachment"),
|
|
324
|
+
/**
|
|
325
|
+
* `GET /api/v1/schema/version` (operationId `getSchemaVersion`).
|
|
326
|
+
*/
|
|
327
|
+
GetSchemaVersion: routeMember(HttpMethod.Get, "/api/v1/schema/version", "getSchemaVersion"),
|
|
328
|
+
/**
|
|
329
|
+
* `GET /api/v1/transcript-groups/{groupId}/members` (operationId `listTranscriptGroupMembers`).
|
|
330
|
+
*/
|
|
331
|
+
ListTranscriptGroupMembers: routeMember(HttpMethod.Get, "/api/v1/transcript-groups/{groupId}/members", "listTranscriptGroupMembers"),
|
|
332
|
+
/**
|
|
333
|
+
* `GET /api/v1/transcripts` (operationId `listTranscripts`).
|
|
334
|
+
*/
|
|
335
|
+
ListTranscripts: routeMember(HttpMethod.Get, "/api/v1/transcripts", "listTranscripts"),
|
|
336
|
+
/**
|
|
337
|
+
* `POST /api/v1/transcripts/publish` (operationId `publishTranscript`).
|
|
338
|
+
*/
|
|
339
|
+
PublishTranscript: routeMember(HttpMethod.Post, "/api/v1/transcripts/publish", "publishTranscript"),
|
|
340
|
+
/**
|
|
341
|
+
* `GET /api/v1/transcripts/{id}` (operationId `getTranscriptMetadata`).
|
|
342
|
+
*/
|
|
343
|
+
GetTranscriptMetadata: routeMember(HttpMethod.Get, "/api/v1/transcripts/{id}", "getTranscriptMetadata"),
|
|
344
|
+
/**
|
|
345
|
+
* `PATCH /api/v1/transcripts/{id}` (operationId `updateTranscript`).
|
|
346
|
+
*/
|
|
347
|
+
UpdateTranscript: routeMember(HttpMethod.Patch, "/api/v1/transcripts/{id}", "updateTranscript"),
|
|
348
|
+
/**
|
|
349
|
+
* `GET /api/v1/transcripts/{id}/collectives` (operationId `listTranscriptCollectives`).
|
|
350
|
+
*/
|
|
351
|
+
ListTranscriptCollectives: routeMember(HttpMethod.Get, "/api/v1/transcripts/{id}/collectives", "listTranscriptCollectives"),
|
|
352
|
+
/**
|
|
353
|
+
* `GET /api/v1/transcripts/{id}/content` (operationId `getTranscriptContent`).
|
|
354
|
+
*/
|
|
355
|
+
GetTranscriptContent: routeMember(HttpMethod.Get, "/api/v1/transcripts/{id}/content", "getTranscriptContent"),
|
|
356
|
+
/**
|
|
357
|
+
* `GET /api/v1/transcripts/{id}/pulls` (operationId `listTranscriptPullRequests`).
|
|
358
|
+
*/
|
|
359
|
+
ListTranscriptPullRequests: routeMember(HttpMethod.Get, "/api/v1/transcripts/{id}/pulls", "listTranscriptPullRequests"),
|
|
360
|
+
/**
|
|
361
|
+
* `GET /api/v1/transcripts/{id}/segments` (operationId `getTranscriptSegments`).
|
|
362
|
+
*/
|
|
363
|
+
GetTranscriptSegments: routeMember(HttpMethod.Get, "/api/v1/transcripts/{id}/segments", "getTranscriptSegments"),
|
|
364
|
+
/**
|
|
365
|
+
* `GET /api/v1/transcripts/{id}/segments/{index}` (operationId `getTranscriptSegment`).
|
|
366
|
+
*/
|
|
367
|
+
GetTranscriptSegment: routeMember(HttpMethod.Get, "/api/v1/transcripts/{id}/segments/{index}", "getTranscriptSegment"),
|
|
368
|
+
/**
|
|
369
|
+
* `POST /api/v1/transcripts/{id}/share` (operationId `shareTranscriptWithGroups`).
|
|
370
|
+
*/
|
|
371
|
+
ShareTranscriptWithGroups: routeMember(HttpMethod.Post, "/api/v1/transcripts/{id}/share", "shareTranscriptWithGroups"),
|
|
372
|
+
/**
|
|
373
|
+
* `DELETE /api/v1/transcripts/{id}/share/{groupID}` (operationId `unshareTranscriptFromGroup`).
|
|
374
|
+
*/
|
|
375
|
+
UnshareTranscriptFromGroup: routeMember(HttpMethod.Delete, "/api/v1/transcripts/{id}/share/{groupID}", "unshareTranscriptFromGroup"),
|
|
376
|
+
/**
|
|
377
|
+
* `GET /api/v1/transcripts/{id}/window` (operationId `getTranscriptWindow`).
|
|
378
|
+
*/
|
|
379
|
+
GetTranscriptWindow: routeMember(HttpMethod.Get, "/api/v1/transcripts/{id}/window", "getTranscriptWindow"),
|
|
380
|
+
/**
|
|
381
|
+
* `GET /api/v1/users/me/collectives/contributions` (operationId `listMyCollectiveContributions`).
|
|
382
|
+
*/
|
|
383
|
+
ListMyCollectiveContributions: routeMember(HttpMethod.Get, "/api/v1/users/me/collectives/contributions", "listMyCollectiveContributions"),
|
|
384
|
+
/**
|
|
385
|
+
* `GET /api/v1/users/me/collectives/{groupId}/submissions` (operationId `listMyCollectiveSubmissions`).
|
|
386
|
+
*/
|
|
387
|
+
ListMyCollectiveSubmissions: routeMember(HttpMethod.Get, "/api/v1/users/me/collectives/{groupId}/submissions", "listMyCollectiveSubmissions"),
|
|
388
|
+
/**
|
|
389
|
+
* `GET /api/v1/users/me/collectives/{groupId}/transcripts/{transcriptId}/events` (operationId `listShareEventHistory`).
|
|
390
|
+
*/
|
|
391
|
+
ListShareEventHistory: routeMember(HttpMethod.Get, "/api/v1/users/me/collectives/{groupId}/transcripts/{transcriptId}/events", "listShareEventHistory"),
|
|
392
|
+
/**
|
|
393
|
+
* `PUT /api/v1/users/me/email` (operationId `setMyNotificationEmail`).
|
|
394
|
+
*/
|
|
395
|
+
SetMyNotificationEmail: routeMember(HttpMethod.Put, "/api/v1/users/me/email", "setMyNotificationEmail"),
|
|
396
|
+
/**
|
|
397
|
+
* `DELETE /api/v1/users/me/email` (operationId `removeMyNotificationEmail`).
|
|
398
|
+
*/
|
|
399
|
+
RemoveMyNotificationEmail: routeMember(HttpMethod.Delete, "/api/v1/users/me/email", "removeMyNotificationEmail"),
|
|
400
|
+
/**
|
|
401
|
+
* `POST /api/v1/users/me/email/verify` (operationId `verifyMyNotificationEmail`).
|
|
402
|
+
*/
|
|
403
|
+
VerifyMyNotificationEmail: routeMember(HttpMethod.Post, "/api/v1/users/me/email/verify", "verifyMyNotificationEmail"),
|
|
404
|
+
/**
|
|
405
|
+
* `GET /api/v1/users/me/invitations` (operationId `listMyInvitations`).
|
|
406
|
+
*/
|
|
407
|
+
ListMyInvitations: routeMember(HttpMethod.Get, "/api/v1/users/me/invitations", "listMyInvitations"),
|
|
408
|
+
/**
|
|
409
|
+
* `POST /api/v1/users/me/invitations/{invitationID}/accept` (operationId `acceptMyInvitation`).
|
|
410
|
+
*/
|
|
411
|
+
AcceptMyInvitation: routeMember(HttpMethod.Post, "/api/v1/users/me/invitations/{invitationID}/accept", "acceptMyInvitation"),
|
|
412
|
+
/**
|
|
413
|
+
* `POST /api/v1/users/me/invitations/{invitationID}/decline` (operationId `declineMyInvitation`).
|
|
414
|
+
*/
|
|
415
|
+
DeclineMyInvitation: routeMember(HttpMethod.Post, "/api/v1/users/me/invitations/{invitationID}/decline", "declineMyInvitation"),
|
|
416
|
+
/**
|
|
417
|
+
* `GET /api/v1/users/me/prompt-requests` (operationId `listMyPromptRequests`).
|
|
418
|
+
*/
|
|
419
|
+
ListMyPromptRequests: routeMember(HttpMethod.Get, "/api/v1/users/me/prompt-requests", "listMyPromptRequests"),
|
|
420
|
+
/**
|
|
421
|
+
* `GET /api/v1/users/me/settings` (operationId `getMySettings`).
|
|
422
|
+
*/
|
|
423
|
+
GetMySettings: routeMember(HttpMethod.Get, "/api/v1/users/me/settings", "getMySettings"),
|
|
424
|
+
/**
|
|
425
|
+
* `PATCH /api/v1/users/me/settings` (operationId `updateMySettings`).
|
|
426
|
+
*/
|
|
427
|
+
UpdateMySettings: routeMember(HttpMethod.Patch, "/api/v1/users/me/settings", "updateMySettings"),
|
|
428
|
+
/**
|
|
429
|
+
* `GET /api/v1/users/me/stats` (operationId `getMyStats`).
|
|
430
|
+
*/
|
|
431
|
+
GetMyStats: routeMember(HttpMethod.Get, "/api/v1/users/me/stats", "getMyStats"),
|
|
432
|
+
});
|
|
433
|
+
/** ALL_VILLAGE_ROUTES is every member of VillageRoute, ordered by pattern and then by ALL_HTTP_METHODS. */
|
|
434
|
+
export const ALL_VILLAGE_ROUTES = Object.freeze([
|
|
435
|
+
VillageRoute.PushAnnotations,
|
|
436
|
+
VillageRoute.GetAnnotationManifest,
|
|
437
|
+
VillageRoute.CliExchangeCode,
|
|
438
|
+
VillageRoute.CliLogin,
|
|
439
|
+
VillageRoute.GetAuthenticatedVillageUser,
|
|
440
|
+
VillageRoute.ListAuthenticatedVillageOrganizations,
|
|
441
|
+
VillageRoute.ListGroups,
|
|
442
|
+
VillageRoute.CreateGroup,
|
|
443
|
+
VillageRoute.ListPublicGroups,
|
|
444
|
+
VillageRoute.SearchCollectives,
|
|
445
|
+
VillageRoute.ListVisibleGroups,
|
|
446
|
+
VillageRoute.GetGroup,
|
|
447
|
+
VillageRoute.UpdateGroup,
|
|
448
|
+
VillageRoute.DeleteGroup,
|
|
449
|
+
VillageRoute.ListContributableTranscripts,
|
|
450
|
+
VillageRoute.ListGroupInvitations,
|
|
451
|
+
VillageRoute.CreateGroupInvitation,
|
|
452
|
+
VillageRoute.RevokeGroupInvitation,
|
|
453
|
+
VillageRoute.JoinGroup,
|
|
454
|
+
VillageRoute.RemoveGroupMember,
|
|
455
|
+
VillageRoute.UpdateGroupMemberRole,
|
|
456
|
+
VillageRoute.ListMyGroupShares,
|
|
457
|
+
VillageRoute.ListPendingShares,
|
|
458
|
+
VillageRoute.ListGroupRepositories,
|
|
459
|
+
VillageRoute.LinkGroupRepository,
|
|
460
|
+
VillageRoute.ListAvailableGroupRepositories,
|
|
461
|
+
VillageRoute.UnlinkGroupRepository,
|
|
462
|
+
VillageRoute.ListGroupRepositoryCommits,
|
|
463
|
+
VillageRoute.BatchShareProject,
|
|
464
|
+
VillageRoute.BatchReviewShares,
|
|
465
|
+
VillageRoute.ReviewShare,
|
|
466
|
+
VillageRoute.RemoveGroupTranscript,
|
|
467
|
+
VillageRoute.UnsubscribeInvitationEmails,
|
|
468
|
+
VillageRoute.ListGroupsDeprecated,
|
|
469
|
+
VillageRoute.CreateGroupDeprecated,
|
|
470
|
+
VillageRoute.ListPublicGroupsDeprecated,
|
|
471
|
+
VillageRoute.SearchCollectivesDeprecated,
|
|
472
|
+
VillageRoute.ListVisibleGroupsDeprecated,
|
|
473
|
+
VillageRoute.GetGroupDeprecated,
|
|
474
|
+
VillageRoute.UpdateGroupDeprecated,
|
|
475
|
+
VillageRoute.DeleteGroupDeprecated,
|
|
476
|
+
VillageRoute.ListContributableTranscriptsDeprecated,
|
|
477
|
+
VillageRoute.ListGroupInvitationsDeprecated,
|
|
478
|
+
VillageRoute.CreateGroupInvitationDeprecated,
|
|
479
|
+
VillageRoute.RevokeGroupInvitationDeprecated,
|
|
480
|
+
VillageRoute.JoinGroupDeprecated,
|
|
481
|
+
VillageRoute.RemoveGroupMemberDeprecated,
|
|
482
|
+
VillageRoute.UpdateGroupMemberRoleDeprecated,
|
|
483
|
+
VillageRoute.ListMyGroupSharesDeprecated,
|
|
484
|
+
VillageRoute.ListPendingSharesDeprecated,
|
|
485
|
+
VillageRoute.ListGroupRepositoriesDeprecated,
|
|
486
|
+
VillageRoute.LinkGroupRepositoryDeprecated,
|
|
487
|
+
VillageRoute.ListAvailableGroupRepositoriesDeprecated,
|
|
488
|
+
VillageRoute.UnlinkGroupRepositoryDeprecated,
|
|
489
|
+
VillageRoute.ListGroupRepositoryCommitsDeprecated,
|
|
490
|
+
VillageRoute.BatchShareProjectDeprecated,
|
|
491
|
+
VillageRoute.BatchReviewSharesDeprecated,
|
|
492
|
+
VillageRoute.ReviewShareDeprecated,
|
|
493
|
+
VillageRoute.RemoveGroupTranscriptDeprecated,
|
|
494
|
+
VillageRoute.ReceiveGitHubWebhook,
|
|
495
|
+
VillageRoute.GetVillageOrganizationCollectives,
|
|
496
|
+
VillageRoute.ListPullableTranscripts,
|
|
497
|
+
VillageRoute.PullSkipGate,
|
|
498
|
+
VillageRoute.GetPullTranscript,
|
|
499
|
+
VillageRoute.GetPullTranscriptAnnotations,
|
|
500
|
+
VillageRoute.GetPullTranscriptContent,
|
|
501
|
+
VillageRoute.GetPullTranscriptPublishMetadata,
|
|
502
|
+
VillageRoute.GetPullRequestAttachment,
|
|
503
|
+
VillageRoute.DetachPullRequestAttachment,
|
|
504
|
+
VillageRoute.ConfirmPullRequestAttachment,
|
|
505
|
+
VillageRoute.GetSchemaVersion,
|
|
506
|
+
VillageRoute.ListTranscriptGroupMembers,
|
|
507
|
+
VillageRoute.ListTranscripts,
|
|
508
|
+
VillageRoute.PublishTranscript,
|
|
509
|
+
VillageRoute.GetTranscriptMetadata,
|
|
510
|
+
VillageRoute.UpdateTranscript,
|
|
511
|
+
VillageRoute.ListTranscriptCollectives,
|
|
512
|
+
VillageRoute.GetTranscriptContent,
|
|
513
|
+
VillageRoute.ListTranscriptPullRequests,
|
|
514
|
+
VillageRoute.GetTranscriptSegments,
|
|
515
|
+
VillageRoute.GetTranscriptSegment,
|
|
516
|
+
VillageRoute.ShareTranscriptWithGroups,
|
|
517
|
+
VillageRoute.UnshareTranscriptFromGroup,
|
|
518
|
+
VillageRoute.GetTranscriptWindow,
|
|
519
|
+
VillageRoute.ListMyCollectiveContributions,
|
|
520
|
+
VillageRoute.ListMyCollectiveSubmissions,
|
|
521
|
+
VillageRoute.ListShareEventHistory,
|
|
522
|
+
VillageRoute.SetMyNotificationEmail,
|
|
523
|
+
VillageRoute.RemoveMyNotificationEmail,
|
|
524
|
+
VillageRoute.VerifyMyNotificationEmail,
|
|
525
|
+
VillageRoute.ListMyInvitations,
|
|
526
|
+
VillageRoute.AcceptMyInvitation,
|
|
527
|
+
VillageRoute.DeclineMyInvitation,
|
|
528
|
+
VillageRoute.ListMyPromptRequests,
|
|
529
|
+
VillageRoute.GetMySettings,
|
|
530
|
+
VillageRoute.UpdateMySettings,
|
|
531
|
+
VillageRoute.GetMyStats,
|
|
532
|
+
]);
|
|
533
|
+
/** LocalRoute holds one member per operation of the Local API document, named by operationId. */
|
|
534
|
+
export const LocalRoute = Object.freeze({
|
|
535
|
+
/**
|
|
536
|
+
* `GET /api/v1/annotation-types` (operationId `listAnnotationTypes`).
|
|
537
|
+
*/
|
|
538
|
+
ListAnnotationTypes: routeMember(HttpMethod.Get, "/api/v1/annotation-types", "listAnnotationTypes"),
|
|
539
|
+
/**
|
|
540
|
+
* `GET /api/v1/annotations` (operationId `listAnnotations`).
|
|
541
|
+
*/
|
|
542
|
+
ListAnnotations: routeMember(HttpMethod.Get, "/api/v1/annotations", "listAnnotations"),
|
|
543
|
+
/**
|
|
544
|
+
* `POST /api/v1/annotations` (operationId `createAnnotation`).
|
|
545
|
+
*/
|
|
546
|
+
CreateAnnotation: routeMember(HttpMethod.Post, "/api/v1/annotations", "createAnnotation"),
|
|
547
|
+
/**
|
|
548
|
+
* `GET /api/v1/attachments/{ref}` (operationId `getAttachment`).
|
|
549
|
+
*/
|
|
550
|
+
GetAttachment: routeMember(HttpMethod.Get, "/api/v1/attachments/{ref}", "getAttachment"),
|
|
551
|
+
/**
|
|
552
|
+
* `GET /api/v1/config/capabilities` (operationId `getUICapabilities`).
|
|
553
|
+
*/
|
|
554
|
+
GetUICapabilities: routeMember(HttpMethod.Get, "/api/v1/config/capabilities", "getUICapabilities"),
|
|
555
|
+
/**
|
|
556
|
+
* `GET /api/v1/config/mock` (operationId `getMockConfig`).
|
|
557
|
+
*/
|
|
558
|
+
GetMockConfig: routeMember(HttpMethod.Get, "/api/v1/config/mock", "getMockConfig"),
|
|
559
|
+
/**
|
|
560
|
+
* `GET /api/v1/health` (operationId `getHealth`).
|
|
561
|
+
*/
|
|
562
|
+
GetHealth: routeMember(HttpMethod.Get, "/api/v1/health", "getHealth"),
|
|
563
|
+
/**
|
|
564
|
+
* `POST /api/v1/kickstart/sessions` (operationId `openKickstartSession`).
|
|
565
|
+
*/
|
|
566
|
+
OpenKickstartSession: routeMember(HttpMethod.Post, "/api/v1/kickstart/sessions", "openKickstartSession"),
|
|
567
|
+
/**
|
|
568
|
+
* `GET /api/v1/kickstart/sessions/{id}` (operationId `getKickstartSession`).
|
|
569
|
+
*/
|
|
570
|
+
GetKickstartSession: routeMember(HttpMethod.Get, "/api/v1/kickstart/sessions/{id}", "getKickstartSession"),
|
|
571
|
+
/**
|
|
572
|
+
* `PATCH /api/v1/kickstart/sessions/{id}` (operationId `patchKickstartSession`).
|
|
573
|
+
*/
|
|
574
|
+
PatchKickstartSession: routeMember(HttpMethod.Patch, "/api/v1/kickstart/sessions/{id}", "patchKickstartSession"),
|
|
575
|
+
/**
|
|
576
|
+
* `POST /api/v1/kickstart/sessions/{id}/commit` (operationId `commitKickstartSession`).
|
|
577
|
+
*/
|
|
578
|
+
CommitKickstartSession: routeMember(HttpMethod.Post, "/api/v1/kickstart/sessions/{id}/commit", "commitKickstartSession"),
|
|
579
|
+
/**
|
|
580
|
+
* `POST /api/v1/kickstart/sessions/{id}/scan` (operationId `scanKickstartSession`).
|
|
581
|
+
*/
|
|
582
|
+
ScanKickstartSession: routeMember(HttpMethod.Post, "/api/v1/kickstart/sessions/{id}/scan", "scanKickstartSession"),
|
|
583
|
+
/**
|
|
584
|
+
* `GET /api/v1/kickstart/sessions/{id}/tree` (operationId `getKickstartTree`).
|
|
585
|
+
*/
|
|
586
|
+
GetKickstartTree: routeMember(HttpMethod.Get, "/api/v1/kickstart/sessions/{id}/tree", "getKickstartTree"),
|
|
587
|
+
/**
|
|
588
|
+
* `GET /api/v1/kickstart/sessions/{id}/tree/{nodeId}/preview` (operationId `getKickstartPreview`).
|
|
589
|
+
*/
|
|
590
|
+
GetKickstartPreview: routeMember(HttpMethod.Get, "/api/v1/kickstart/sessions/{id}/tree/{nodeId}/preview", "getKickstartPreview"),
|
|
591
|
+
/**
|
|
592
|
+
* `GET /api/v1/kickstart/status` (operationId `getKickstartStatus`).
|
|
593
|
+
*/
|
|
594
|
+
GetKickstartStatus: routeMember(HttpMethod.Get, "/api/v1/kickstart/status", "getKickstartStatus"),
|
|
595
|
+
/**
|
|
596
|
+
* `GET /api/v1/map/{projectHash}` (operationId `getMapGraph`).
|
|
597
|
+
*/
|
|
598
|
+
GetMapGraph: routeMember(HttpMethod.Get, "/api/v1/map/{projectHash}", "getMapGraph"),
|
|
599
|
+
/**
|
|
600
|
+
* `GET /api/v1/map/{projectHash}/node` (operationId `getMapNodeDetail`).
|
|
601
|
+
*/
|
|
602
|
+
GetMapNodeDetail: routeMember(HttpMethod.Get, "/api/v1/map/{projectHash}/node", "getMapNodeDetail"),
|
|
603
|
+
/**
|
|
604
|
+
* `GET /api/v1/map/{projectHash}/tasks` (operationId `listProjectTasks`).
|
|
605
|
+
*/
|
|
606
|
+
ListProjectTasks: routeMember(HttpMethod.Get, "/api/v1/map/{projectHash}/tasks", "listProjectTasks"),
|
|
607
|
+
/**
|
|
608
|
+
* `GET /api/v1/projects/resolve` (operationId `resolveProject`).
|
|
609
|
+
*/
|
|
610
|
+
ResolveProject: routeMember(HttpMethod.Get, "/api/v1/projects/resolve", "resolveProject"),
|
|
611
|
+
/**
|
|
612
|
+
* `GET /api/v1/projects/summary` (operationId `listProjectSummaries`).
|
|
613
|
+
*/
|
|
614
|
+
ListProjectSummaries: routeMember(HttpMethod.Get, "/api/v1/projects/summary", "listProjectSummaries"),
|
|
615
|
+
/**
|
|
616
|
+
* `GET /api/v1/publications` (operationId `listPublications`).
|
|
617
|
+
*/
|
|
618
|
+
ListPublications: routeMember(HttpMethod.Get, "/api/v1/publications", "listPublications"),
|
|
619
|
+
/**
|
|
620
|
+
* `GET /api/v1/quality` (operationId `getQualityPage`).
|
|
621
|
+
*/
|
|
622
|
+
GetQualityPage: routeMember(HttpMethod.Get, "/api/v1/quality", "getQualityPage"),
|
|
623
|
+
/**
|
|
624
|
+
* `GET /api/v1/review/{projectHash}` (operationId `listReviewChanges`).
|
|
625
|
+
*/
|
|
626
|
+
ListReviewChanges: routeMember(HttpMethod.Get, "/api/v1/review/{projectHash}", "listReviewChanges"),
|
|
627
|
+
/**
|
|
628
|
+
* `GET /api/v1/review/{projectHash}/change` (operationId `getChangeDetail`).
|
|
629
|
+
*/
|
|
630
|
+
GetChangeDetail: routeMember(HttpMethod.Get, "/api/v1/review/{projectHash}/change", "getChangeDetail"),
|
|
631
|
+
/**
|
|
632
|
+
* `GET /api/v1/review/{projectHash}/diff` (operationId `getChangeDiff`).
|
|
633
|
+
*/
|
|
634
|
+
GetChangeDiff: routeMember(HttpMethod.Get, "/api/v1/review/{projectHash}/diff", "getChangeDiff"),
|
|
635
|
+
/**
|
|
636
|
+
* `GET /api/v1/search` (operationId `searchMessages`).
|
|
637
|
+
*/
|
|
638
|
+
SearchMessages: routeMember(HttpMethod.Get, "/api/v1/search", "searchMessages"),
|
|
639
|
+
/**
|
|
640
|
+
* `GET /api/v1/session-groups/{groupId}/members` (operationId `listLocalHelperGroupMembers`).
|
|
641
|
+
*/
|
|
642
|
+
ListLocalHelperGroupMembers: routeMember(HttpMethod.Get, "/api/v1/session-groups/{groupId}/members", "listLocalHelperGroupMembers"),
|
|
643
|
+
/**
|
|
644
|
+
* `GET /api/v1/session-summaries` (operationId `getSessionSummariesByID`).
|
|
645
|
+
*/
|
|
646
|
+
GetSessionSummariesByID: routeMember(HttpMethod.Get, "/api/v1/session-summaries", "getSessionSummariesByID"),
|
|
647
|
+
/**
|
|
648
|
+
* `GET /api/v1/sessions` (operationId `listSessions`).
|
|
649
|
+
*/
|
|
650
|
+
ListSessions: routeMember(HttpMethod.Get, "/api/v1/sessions", "listSessions"),
|
|
651
|
+
/**
|
|
652
|
+
* `GET /api/v1/sessions/{id}` (operationId `getSession`).
|
|
653
|
+
*/
|
|
654
|
+
GetSession: routeMember(HttpMethod.Get, "/api/v1/sessions/{id}", "getSession"),
|
|
655
|
+
/**
|
|
656
|
+
* `GET /api/v1/sessions/{id}/commits` (operationId `getSessionCommits`).
|
|
657
|
+
*/
|
|
658
|
+
GetSessionCommits: routeMember(HttpMethod.Get, "/api/v1/sessions/{id}/commits", "getSessionCommits"),
|
|
659
|
+
/**
|
|
660
|
+
* `GET /api/v1/sessions/{id}/pull-requests` (operationId `getSessionPullRequests`).
|
|
661
|
+
*/
|
|
662
|
+
GetSessionPullRequests: routeMember(HttpMethod.Get, "/api/v1/sessions/{id}/pull-requests", "getSessionPullRequests"),
|
|
663
|
+
/**
|
|
664
|
+
* `GET /api/v1/sessions/{id}/transcript` (operationId `getSessionTranscript`).
|
|
665
|
+
*/
|
|
666
|
+
GetSessionTranscript: routeMember(HttpMethod.Get, "/api/v1/sessions/{id}/transcript", "getSessionTranscript"),
|
|
667
|
+
/**
|
|
668
|
+
* `GET /api/v1/sessions/{id}/transcript/segments` (operationId `getSessionTranscriptSegments`).
|
|
669
|
+
*/
|
|
670
|
+
GetSessionTranscriptSegments: routeMember(HttpMethod.Get, "/api/v1/sessions/{id}/transcript/segments", "getSessionTranscriptSegments"),
|
|
671
|
+
/**
|
|
672
|
+
* `GET /api/v1/sessions/{id}/transcript/segments/{index}` (operationId `getSessionTranscriptSegment`).
|
|
673
|
+
*/
|
|
674
|
+
GetSessionTranscriptSegment: routeMember(HttpMethod.Get, "/api/v1/sessions/{id}/transcript/segments/{index}", "getSessionTranscriptSegment"),
|
|
675
|
+
/**
|
|
676
|
+
* `GET /api/v1/sessions/{id}/transcript/window` (operationId `getSessionTranscriptWindow`).
|
|
677
|
+
*/
|
|
678
|
+
GetSessionTranscriptWindow: routeMember(HttpMethod.Get, "/api/v1/sessions/{id}/transcript/window", "getSessionTranscriptWindow"),
|
|
679
|
+
/**
|
|
680
|
+
* `GET /api/v1/settings` (operationId `getSettings`).
|
|
681
|
+
*/
|
|
682
|
+
GetSettings: routeMember(HttpMethod.Get, "/api/v1/settings", "getSettings"),
|
|
683
|
+
/**
|
|
684
|
+
* `PATCH /api/v1/settings` (operationId `updateSetting`).
|
|
685
|
+
*/
|
|
686
|
+
UpdateSetting: routeMember(HttpMethod.Patch, "/api/v1/settings", "updateSetting"),
|
|
687
|
+
/**
|
|
688
|
+
* `PUT /api/v1/settings/auto-publish/{id}` (operationId `saveAutoPublishRule`).
|
|
689
|
+
*/
|
|
690
|
+
SaveAutoPublishRule: routeMember(HttpMethod.Put, "/api/v1/settings/auto-publish/{id}", "saveAutoPublishRule"),
|
|
691
|
+
/**
|
|
692
|
+
* `DELETE /api/v1/settings/auto-publish/{id}` (operationId `deleteAutoPublishRule`).
|
|
693
|
+
*/
|
|
694
|
+
DeleteAutoPublishRule: routeMember(HttpMethod.Delete, "/api/v1/settings/auto-publish/{id}", "deleteAutoPublishRule"),
|
|
695
|
+
/**
|
|
696
|
+
* `POST /api/v1/settings/auto-publish/{id}/install` (operationId `installAutoPublishHooks`).
|
|
697
|
+
*/
|
|
698
|
+
InstallAutoPublishHooks: routeMember(HttpMethod.Post, "/api/v1/settings/auto-publish/{id}/install", "installAutoPublishHooks"),
|
|
699
|
+
/**
|
|
700
|
+
* `POST /api/v1/shutdown` (operationId `postShutdown`).
|
|
701
|
+
*/
|
|
702
|
+
PostShutdown: routeMember(HttpMethod.Post, "/api/v1/shutdown", "postShutdown"),
|
|
703
|
+
/**
|
|
704
|
+
* `GET /api/v1/sync/auth` (operationId `getSyncAuth`).
|
|
705
|
+
*/
|
|
706
|
+
GetSyncAuth: routeMember(HttpMethod.Get, "/api/v1/sync/auth", "getSyncAuth"),
|
|
707
|
+
/**
|
|
708
|
+
* `POST /api/v1/sync/login` (operationId `syncLogin`).
|
|
709
|
+
*/
|
|
710
|
+
SyncLogin: routeMember(HttpMethod.Post, "/api/v1/sync/login", "syncLogin"),
|
|
711
|
+
/**
|
|
712
|
+
* `POST /api/v1/sync/logout` (operationId `syncLogout`).
|
|
713
|
+
*/
|
|
714
|
+
SyncLogout: routeMember(HttpMethod.Post, "/api/v1/sync/logout", "syncLogout"),
|
|
715
|
+
/**
|
|
716
|
+
* `POST /api/v1/sync/push` (operationId `pushSyncSessions`).
|
|
717
|
+
*/
|
|
718
|
+
PushSyncSessions: routeMember(HttpMethod.Post, "/api/v1/sync/push", "pushSyncSessions"),
|
|
719
|
+
/**
|
|
720
|
+
* `GET /api/v1/sync/redactions` (operationId `getSyncRedactions`).
|
|
721
|
+
*/
|
|
722
|
+
GetSyncRedactions: routeMember(HttpMethod.Get, "/api/v1/sync/redactions", "getSyncRedactions"),
|
|
723
|
+
/**
|
|
724
|
+
* `GET /api/v1/sync/sessions` (operationId `listSyncSessionsGrouped`).
|
|
725
|
+
*/
|
|
726
|
+
ListSyncSessionsGrouped: routeMember(HttpMethod.Get, "/api/v1/sync/sessions", "listSyncSessionsGrouped"),
|
|
727
|
+
/**
|
|
728
|
+
* `GET /api/v1/village/collective-observations` (operationId `listCollectiveObservations`).
|
|
729
|
+
*/
|
|
730
|
+
ListCollectiveObservations: routeMember(HttpMethod.Get, "/api/v1/village/collective-observations", "listCollectiveObservations"),
|
|
731
|
+
/**
|
|
732
|
+
* `POST /api/v1/village/collective-observations/fetch` (operationId `fetchCollectiveObservations`).
|
|
733
|
+
*/
|
|
734
|
+
FetchCollectiveObservations: routeMember(HttpMethod.Post, "/api/v1/village/collective-observations/fetch", "fetchCollectiveObservations"),
|
|
735
|
+
/**
|
|
736
|
+
* `PUT /api/v1/village/collective-observations/{collectiveId}/tracking` (operationId `trackCollectiveObservation`).
|
|
737
|
+
*/
|
|
738
|
+
TrackCollectiveObservation: routeMember(HttpMethod.Put, "/api/v1/village/collective-observations/{collectiveId}/tracking", "trackCollectiveObservation"),
|
|
739
|
+
/**
|
|
740
|
+
* `DELETE /api/v1/village/collective-observations/{collectiveId}/tracking` (operationId `untrackCollectiveObservation`).
|
|
741
|
+
*/
|
|
742
|
+
UntrackCollectiveObservation: routeMember(HttpMethod.Delete, "/api/v1/village/collective-observations/{collectiveId}/tracking", "untrackCollectiveObservation"),
|
|
743
|
+
/**
|
|
744
|
+
* `GET /api/v1/village/collectives` (operationId `listVillageCollectives`).
|
|
745
|
+
*/
|
|
746
|
+
ListVillageCollectives: routeMember(HttpMethod.Get, "/api/v1/village/collectives", "listVillageCollectives"),
|
|
747
|
+
/**
|
|
748
|
+
* `GET /api/v1/village/contributions` (operationId `listLocalContributionEvidence`).
|
|
749
|
+
*/
|
|
750
|
+
ListLocalContributionEvidence: routeMember(HttpMethod.Get, "/api/v1/village/contributions", "listLocalContributionEvidence"),
|
|
751
|
+
});
|
|
752
|
+
/** ALL_LOCAL_ROUTES is every member of LocalRoute, ordered by pattern and then by ALL_HTTP_METHODS. */
|
|
753
|
+
export const ALL_LOCAL_ROUTES = Object.freeze([
|
|
754
|
+
LocalRoute.ListAnnotationTypes,
|
|
755
|
+
LocalRoute.ListAnnotations,
|
|
756
|
+
LocalRoute.CreateAnnotation,
|
|
757
|
+
LocalRoute.GetAttachment,
|
|
758
|
+
LocalRoute.GetUICapabilities,
|
|
759
|
+
LocalRoute.GetMockConfig,
|
|
760
|
+
LocalRoute.GetHealth,
|
|
761
|
+
LocalRoute.OpenKickstartSession,
|
|
762
|
+
LocalRoute.GetKickstartSession,
|
|
763
|
+
LocalRoute.PatchKickstartSession,
|
|
764
|
+
LocalRoute.CommitKickstartSession,
|
|
765
|
+
LocalRoute.ScanKickstartSession,
|
|
766
|
+
LocalRoute.GetKickstartTree,
|
|
767
|
+
LocalRoute.GetKickstartPreview,
|
|
768
|
+
LocalRoute.GetKickstartStatus,
|
|
769
|
+
LocalRoute.GetMapGraph,
|
|
770
|
+
LocalRoute.GetMapNodeDetail,
|
|
771
|
+
LocalRoute.ListProjectTasks,
|
|
772
|
+
LocalRoute.ResolveProject,
|
|
773
|
+
LocalRoute.ListProjectSummaries,
|
|
774
|
+
LocalRoute.ListPublications,
|
|
775
|
+
LocalRoute.GetQualityPage,
|
|
776
|
+
LocalRoute.ListReviewChanges,
|
|
777
|
+
LocalRoute.GetChangeDetail,
|
|
778
|
+
LocalRoute.GetChangeDiff,
|
|
779
|
+
LocalRoute.SearchMessages,
|
|
780
|
+
LocalRoute.ListLocalHelperGroupMembers,
|
|
781
|
+
LocalRoute.GetSessionSummariesByID,
|
|
782
|
+
LocalRoute.ListSessions,
|
|
783
|
+
LocalRoute.GetSession,
|
|
784
|
+
LocalRoute.GetSessionCommits,
|
|
785
|
+
LocalRoute.GetSessionPullRequests,
|
|
786
|
+
LocalRoute.GetSessionTranscript,
|
|
787
|
+
LocalRoute.GetSessionTranscriptSegments,
|
|
788
|
+
LocalRoute.GetSessionTranscriptSegment,
|
|
789
|
+
LocalRoute.GetSessionTranscriptWindow,
|
|
790
|
+
LocalRoute.GetSettings,
|
|
791
|
+
LocalRoute.UpdateSetting,
|
|
792
|
+
LocalRoute.SaveAutoPublishRule,
|
|
793
|
+
LocalRoute.DeleteAutoPublishRule,
|
|
794
|
+
LocalRoute.InstallAutoPublishHooks,
|
|
795
|
+
LocalRoute.PostShutdown,
|
|
796
|
+
LocalRoute.GetSyncAuth,
|
|
797
|
+
LocalRoute.SyncLogin,
|
|
798
|
+
LocalRoute.SyncLogout,
|
|
799
|
+
LocalRoute.PushSyncSessions,
|
|
800
|
+
LocalRoute.GetSyncRedactions,
|
|
801
|
+
LocalRoute.ListSyncSessionsGrouped,
|
|
802
|
+
LocalRoute.ListCollectiveObservations,
|
|
803
|
+
LocalRoute.FetchCollectiveObservations,
|
|
804
|
+
LocalRoute.TrackCollectiveObservation,
|
|
805
|
+
LocalRoute.UntrackCollectiveObservation,
|
|
806
|
+
LocalRoute.ListVillageCollectives,
|
|
807
|
+
LocalRoute.ListLocalContributionEvidence,
|
|
808
|
+
]);
|