@peasant-labs/schema 0.48.0 → 0.50.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/dist/fixtures/session-graph.d.ts +45 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/internal/generated/contract/zod.gen.d.ts +1030 -23
- package/dist/internal/generated/contract/zod.gen.js +344 -2
- package/dist/internal/generated/enums.gen.d.ts +201 -29
- package/dist/internal/generated/enums.gen.js +189 -2
- package/dist/internal/generated/kickstart-limits.gen.d.ts +1 -0
- package/dist/internal/generated/kickstart-limits.gen.js +2 -0
- package/dist/internal/generated/local-api.d.ts +954 -96
- package/dist/internal/generated/public-contract.gen.d.ts +2 -2
- package/dist/internal/generated/public-contract.gen.js +1 -1
- package/dist/internal/generated/session-graph-fixtures.gen.d.ts +45 -1
- package/dist/internal/generated/session-graph-fixtures.gen.js +50 -0
- package/dist/internal/generated/versions.gen.d.ts +2 -2
- package/dist/internal/generated/versions.gen.js +2 -2
- package/dist/local-api.d.ts +1 -1
- package/dist/local-api.js +1 -1
- package/package.json +1 -1
|
@@ -27,7 +27,7 @@ export interface paths {
|
|
|
27
27
|
/** @description List annotations for a session. */
|
|
28
28
|
get: operations["listAnnotations"];
|
|
29
29
|
put?: never;
|
|
30
|
-
/** @description Create a new annotation. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server:
|
|
30
|
+
/** @description Create a new annotation. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
31
31
|
post: operations["createAnnotation"];
|
|
32
32
|
delete?: never;
|
|
33
33
|
options?: never;
|
|
@@ -103,6 +103,126 @@ export interface paths {
|
|
|
103
103
|
patch?: never;
|
|
104
104
|
trace?: never;
|
|
105
105
|
};
|
|
106
|
+
"/api/v1/kickstart/sessions": {
|
|
107
|
+
parameters: {
|
|
108
|
+
query?: never;
|
|
109
|
+
header?: never;
|
|
110
|
+
path?: never;
|
|
111
|
+
cookie?: never;
|
|
112
|
+
};
|
|
113
|
+
get?: never;
|
|
114
|
+
put?: never;
|
|
115
|
+
/** @description Open or join the live session for scope. full is the wizard and selection is the selection page. The same scope returns the same id and revision; the other scope returns a different session and leaves the first untouched. The response is the reconnect snapshot, so the page needs no second read. A scope other than full or selection, and a body that is missing or not the declared shape, is 400 and changes nothing. 500 when the configuration file cannot be read or the first draft cannot be built, and 503 when the setup service is unavailable. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
116
|
+
post: operations["openKickstartSession"];
|
|
117
|
+
delete?: never;
|
|
118
|
+
options?: never;
|
|
119
|
+
head?: never;
|
|
120
|
+
patch?: never;
|
|
121
|
+
trace?: never;
|
|
122
|
+
};
|
|
123
|
+
"/api/v1/kickstart/sessions/{id}": {
|
|
124
|
+
parameters: {
|
|
125
|
+
query?: never;
|
|
126
|
+
header?: never;
|
|
127
|
+
path?: never;
|
|
128
|
+
cookie?: never;
|
|
129
|
+
};
|
|
130
|
+
/** @description Read one session snapshot for reconnect. The forest is not in this body; load it from the tree route. 404 when no session has this id, 500 when the snapshot cannot be built, and 503 when the setup service is unavailable. Returns 403 with a JSON error whose code is request_host_not_local, and serves nothing, when the request's Host header does not name a loopback address. */
|
|
131
|
+
get: operations["getKickstartSession"];
|
|
132
|
+
put?: never;
|
|
133
|
+
post?: never;
|
|
134
|
+
delete?: never;
|
|
135
|
+
options?: never;
|
|
136
|
+
head?: never;
|
|
137
|
+
/** @description Apply one stop's answers, the tree's selected ids, conflict resolutions, or the connect offer. revision is the session revision the caller last rendered. A stale write is applied and reported in the body; it is not a separate status. A stale result may carry no overwritten entries when no answered field changed after that revision. 400 when the body is not valid, when the session is being saved, or when an answer is refused: an unknown field, a field outside this scope, a field hidden in the current view, or a value the field does not accept. Nothing is changed on a 400. 404 when no session has this id, 500 when the answer cannot be applied because of a server defect, and 503 when the setup service is unavailable. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
138
|
+
patch: operations["patchKickstartSession"];
|
|
139
|
+
trace?: never;
|
|
140
|
+
};
|
|
141
|
+
"/api/v1/kickstart/sessions/{id}/commit": {
|
|
142
|
+
parameters: {
|
|
143
|
+
query?: never;
|
|
144
|
+
header?: never;
|
|
145
|
+
path?: never;
|
|
146
|
+
cookie?: never;
|
|
147
|
+
};
|
|
148
|
+
get?: never;
|
|
149
|
+
put?: never;
|
|
150
|
+
/** @description Recompute, merge, swap the configuration, write retention, and start the import. 409 returns the mine/theirs rows and writes nothing. The success body carries the finish actions and the ingest state; it does not install a hook and has no reset control. 400 when the save is refused, for example because an answer is not acceptable or the session is already being saved; nothing is written. 404 when no session has this id. 500 when the configuration file cannot be read or written, and the previous file is unchanged. 503 when another change holds the configuration file, when it kept changing, or when the setup service is unavailable. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
151
|
+
post: operations["commitKickstartSession"];
|
|
152
|
+
delete?: never;
|
|
153
|
+
options?: never;
|
|
154
|
+
head?: never;
|
|
155
|
+
patch?: never;
|
|
156
|
+
trace?: never;
|
|
157
|
+
};
|
|
158
|
+
"/api/v1/kickstart/sessions/{id}/scan": {
|
|
159
|
+
parameters: {
|
|
160
|
+
query?: never;
|
|
161
|
+
header?: never;
|
|
162
|
+
path?: never;
|
|
163
|
+
cookie?: never;
|
|
164
|
+
};
|
|
165
|
+
get?: never;
|
|
166
|
+
put?: never;
|
|
167
|
+
/** @description Rescan the filesystem for one session. Progress is pushed on the kickstart topic; this response is the scan state at accept. The forest is not in the response. 400 when the session is being saved, 404 when no session has this id, 500 when the scan state cannot be built, and 503 when the setup service is unavailable. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
168
|
+
post: operations["scanKickstartSession"];
|
|
169
|
+
delete?: never;
|
|
170
|
+
options?: never;
|
|
171
|
+
head?: never;
|
|
172
|
+
patch?: never;
|
|
173
|
+
trace?: never;
|
|
174
|
+
};
|
|
175
|
+
"/api/v1/kickstart/sessions/{id}/tree": {
|
|
176
|
+
parameters: {
|
|
177
|
+
query?: never;
|
|
178
|
+
header?: never;
|
|
179
|
+
path?: never;
|
|
180
|
+
cookie?: never;
|
|
181
|
+
};
|
|
182
|
+
/** @description Read the whole selection forest for one session. Each node carries the server-computed state. locked is a boolean, not a fourth state. The response has no page, cursor, or limit. 404 when no session has this id, 500 when the forest cannot be built, and 503 when the setup service is unavailable. Returns 403 with a JSON error whose code is request_host_not_local, and serves nothing, when the request's Host header does not name a loopback address. */
|
|
183
|
+
get: operations["getKickstartTree"];
|
|
184
|
+
put?: never;
|
|
185
|
+
post?: never;
|
|
186
|
+
delete?: never;
|
|
187
|
+
options?: never;
|
|
188
|
+
head?: never;
|
|
189
|
+
patch?: never;
|
|
190
|
+
trace?: never;
|
|
191
|
+
};
|
|
192
|
+
"/api/v1/kickstart/sessions/{id}/tree/{nodeId}/preview": {
|
|
193
|
+
parameters: {
|
|
194
|
+
query?: never;
|
|
195
|
+
header?: never;
|
|
196
|
+
path?: never;
|
|
197
|
+
cookie?: never;
|
|
198
|
+
};
|
|
199
|
+
/** @description Read the bounded typed preview lines for one forest row. 404 when the session or the row does not exist, 500 when the session's transcript cannot be read, and 503 when the setup service is unavailable. Returns 403 with a JSON error whose code is request_host_not_local, and serves nothing, when the request's Host header does not name a loopback address. */
|
|
200
|
+
get: operations["getKickstartPreview"];
|
|
201
|
+
put?: never;
|
|
202
|
+
post?: never;
|
|
203
|
+
delete?: never;
|
|
204
|
+
options?: never;
|
|
205
|
+
head?: never;
|
|
206
|
+
patch?: never;
|
|
207
|
+
trace?: never;
|
|
208
|
+
};
|
|
209
|
+
"/api/v1/kickstart/status": {
|
|
210
|
+
parameters: {
|
|
211
|
+
query?: never;
|
|
212
|
+
header?: never;
|
|
213
|
+
path?: never;
|
|
214
|
+
cookie?: never;
|
|
215
|
+
};
|
|
216
|
+
/** @description Read the first-run redirect hook. configured is the only status flag. activeSessionId, when present, is the one full-scope session id; it is omitted when that session is not open. The response is not a session directory and has no per-scope map. 500 when the configuration file cannot be inspected, and 503 when the setup service is unavailable. Returns 403 with a JSON error whose code is request_host_not_local, and serves nothing, when the request's Host header does not name a loopback address. */
|
|
217
|
+
get: operations["getKickstartStatus"];
|
|
218
|
+
put?: never;
|
|
219
|
+
post?: never;
|
|
220
|
+
delete?: never;
|
|
221
|
+
options?: never;
|
|
222
|
+
head?: never;
|
|
223
|
+
patch?: never;
|
|
224
|
+
trace?: never;
|
|
225
|
+
};
|
|
106
226
|
"/api/v1/map/{projectHash}": {
|
|
107
227
|
parameters: {
|
|
108
228
|
query?: never;
|
|
@@ -467,14 +587,14 @@ export interface paths {
|
|
|
467
587
|
path?: never;
|
|
468
588
|
cookie?: never;
|
|
469
589
|
};
|
|
470
|
-
/** @description Read every setting the local settings page shows, with each key's kind, its value in the configuration file (null when unset), the effective value that applies, and metadata, and every auto-publish rule with the recorded repositories it matches and their hook state per event. */
|
|
590
|
+
/** @description Read every setting the local settings page shows, with each key's kind, its value in the configuration file (null when unset), the effective value that applies, and metadata, and every auto-publish rule with the recorded repositories it matches and their hook state per event. 500 when the configuration file, a setting, or the auto-publish rules cannot be read, or a saved value has not been applied; 503 when this server runs without a configuration file, or without the session store the auto-publish rules need. A refused read changes nothing. Returns 403 with a JSON error whose code is request_host_not_local, and serves nothing, when the request's Host header does not name a loopback address. */
|
|
471
591
|
get: operations["getSettings"];
|
|
472
592
|
put?: never;
|
|
473
593
|
post?: never;
|
|
474
594
|
delete?: never;
|
|
475
595
|
options?: never;
|
|
476
596
|
head?: never;
|
|
477
|
-
/** @description Change one editable setting. The body names one key and its new value, which must match the key's kind; null unsets the key so the default applies. The response is the setting as saved, with its metadata. A refused update changes nothing and returns the key and the reason: 400 for an unknown or read-only key, a value of the wrong kind, or a configuration the value would make invalid,
|
|
597
|
+
/** @description Change one editable setting. The body names one key and its new value, which must match the key's kind; null unsets the key so the default applies. The response is the setting as saved, with its metadata. A refused update changes nothing and returns the key and the reason: 400 for an unknown or read-only key, a value of the wrong kind, or a configuration the value would make invalid, 500 when the configuration file cannot be read or written, and 503 when another save holds the configuration file, so this update could not take its lock. A 503 changes nothing and carries the same key and reason; send the update again once the other save has finished. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
478
598
|
patch: operations["updateSetting"];
|
|
479
599
|
trace?: never;
|
|
480
600
|
};
|
|
@@ -486,10 +606,10 @@ export interface paths {
|
|
|
486
606
|
cookie?: never;
|
|
487
607
|
};
|
|
488
608
|
get?: never;
|
|
489
|
-
/** @description Create or replace one auto-publish rule. Supply either kind and match for an explicit pattern, or sessionId alone to resolve a stored session to its current Git repository and save an escaped exact-folder rule. The target modes are mutually exclusive. A session without a resolvable existing directory is refused before saving, without remote or process-directory fallback. Saving a rule installs nothing: the response lists the recorded repositories the rule matches and each one's hook state per event, and installAutoPublishHooks installs in one repository at a time. 400 when the rule is invalid, for example a match pattern the server cannot read for its kind. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server:
|
|
609
|
+
/** @description Create or replace one auto-publish rule. Supply either kind and match for an explicit pattern, or sessionId alone to resolve a stored session to its current Git repository and save an escaped exact-folder rule. The target modes are mutually exclusive. A session without a resolvable existing directory is refused before saving, without remote or process-directory fallback. Saving a rule installs nothing: the response lists the recorded repositories the rule matches and each one's hook state per event, and installAutoPublishHooks installs in one repository at a time. 400 when the rule is invalid, for example a match pattern the server cannot read for its kind. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
490
610
|
put: operations["saveAutoPublishRule"];
|
|
491
611
|
post?: never;
|
|
492
|
-
/** @description Remove one auto-publish rule. The response reports the hooks of the repositories it matched as they are. Hook files are retained, but rule-required hooks stop publishing unless another active rule covers the repository and event. Paused rules grant no publishing consent. Separately installed terminal hooks keep their independent consent. 404 when no rule has this identifier. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server:
|
|
612
|
+
/** @description Remove one auto-publish rule. The response reports the hooks of the repositories it matched as they are. Hook files are retained, but rule-required hooks stop publishing unless another active rule covers the repository and event. Paused rules grant no publishing consent. Separately installed terminal hooks keep their independent consent. 404 when no rule has this identifier. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
493
613
|
delete: operations["deleteAutoPublishRule"];
|
|
494
614
|
options?: never;
|
|
495
615
|
head?: never;
|
|
@@ -505,7 +625,7 @@ export interface paths {
|
|
|
505
625
|
};
|
|
506
626
|
get?: never;
|
|
507
627
|
put?: never;
|
|
508
|
-
/** @description Install the rule's hooks, one per rule event, in one recorded repository the rule matches. Installed hooks require an active auto-publish rule for that repository and event each time they run; removing or pausing the last binding stops publication without removing the hook files. Events are independent: the response reports each event's hook, and a blocked hook carries the remedy, because Peasant never overwrites a hook it does not manage. 400 when the path is not a recorded repository the rule matches, so nothing is installed in an unrecorded repository; 404 when no rule has this identifier. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server:
|
|
628
|
+
/** @description Install the rule's hooks, one per rule event, in one recorded repository the rule matches. Installed hooks require an active auto-publish rule for that repository and event each time they run; removing or pausing the last binding stops publication without removing the hook files. Events are independent: the response reports each event's hook, and a blocked hook carries the remedy, because Peasant never overwrites a hook it does not manage. 400 when the path is not a recorded repository the rule matches, so nothing is installed in an unrecorded repository; 404 when no rule has this identifier. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
509
629
|
post: operations["installAutoPublishHooks"];
|
|
510
630
|
delete?: never;
|
|
511
631
|
options?: never;
|
|
@@ -522,7 +642,7 @@ export interface paths {
|
|
|
522
642
|
};
|
|
523
643
|
get?: never;
|
|
524
644
|
put?: never;
|
|
525
|
-
/** @description Gracefully shutdown the server (localhost only). Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server:
|
|
645
|
+
/** @description Gracefully shutdown the server (localhost only). Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
526
646
|
post: operations["postShutdown"];
|
|
527
647
|
delete?: never;
|
|
528
648
|
options?: never;
|
|
@@ -556,7 +676,7 @@ export interface paths {
|
|
|
556
676
|
};
|
|
557
677
|
get?: never;
|
|
558
678
|
put?: never;
|
|
559
|
-
/** @description Start the Village sign-in in the browser and return at once. pending means the sign-in started; poll getSyncAuth until it reports authenticated. already_authenticated means nothing started. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server:
|
|
679
|
+
/** @description Start the Village sign-in in the browser and return at once. pending means the sign-in started; poll getSyncAuth until it reports authenticated. already_authenticated means nothing started. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
560
680
|
post: operations["syncLogin"];
|
|
561
681
|
delete?: never;
|
|
562
682
|
options?: never;
|
|
@@ -573,7 +693,7 @@ export interface paths {
|
|
|
573
693
|
};
|
|
574
694
|
get?: never;
|
|
575
695
|
put?: never;
|
|
576
|
-
/** @description End this computer's Village sign-in by removing its stored Village credential. This route changes local state only. Logging out a computer that holds no credential returns already_logged_out. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server:
|
|
696
|
+
/** @description End this computer's Village sign-in by removing its stored Village credential. This route changes local state only. Logging out a computer that holds no credential returns already_logged_out. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
577
697
|
post: operations["syncLogout"];
|
|
578
698
|
delete?: never;
|
|
579
699
|
options?: never;
|
|
@@ -590,7 +710,7 @@ export interface paths {
|
|
|
590
710
|
};
|
|
591
711
|
get?: never;
|
|
592
712
|
put?: never;
|
|
593
|
-
/** @description Publish or update local sessions to Village and change who can read them. Publishing is collectives only: collectives.add shares each transcript with a collective, collectives.remove takes it back, and a collective named in neither keeps its access. The request carries no visibility and no license, unknown fields are refused, and the server applies no default license to a publish that names collectives. Each session result lists its steps in the order they ran, the content step first; its status describes the content, so a push that only changes collectives reports skipped with a skipped content step. A skipped step says why and is not a failure. A failed step keeps what Village had for it and makes the session an error; a later step the server did not run after a failure is not_attempted. The counts tally sessions by status after every step ran. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server:
|
|
713
|
+
/** @description Publish or update local sessions to Village and change who can read them. Publishing is collectives only: collectives.add shares each transcript with a collective, collectives.remove takes it back, and a collective named in neither keeps its access. The request carries no visibility and no license, unknown fields are refused, and the server applies no default license to a publish that names collectives. Each session result lists its steps in the order they ran, the content step first; its status describes the content, so a push that only changes collectives reports skipped with a skipped content step. A skipped step says why and is not a failure. A failed step keeps what Village had for it and makes the session an error; a later step the server did not run after a failure is not_attempted. The counts tally sessions by status after every step ran. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
594
714
|
post: operations["pushSyncSessions"];
|
|
595
715
|
delete?: never;
|
|
596
716
|
options?: never;
|
|
@@ -658,7 +778,7 @@ export interface paths {
|
|
|
658
778
|
};
|
|
659
779
|
get?: never;
|
|
660
780
|
put?: never;
|
|
661
|
-
/** @description Synchronously fetch metadata only, with no request body. Complete catalog/history install independently; complete association sets install per transcript. Never transfer bodies, publish, join or alter consent. Typed reports on non-2xx preserve every committed effect and prior completion date. Status precedence: persistence > auth > deadline/cancellation > remote/contract > superseded. 200 only complete; initial auth failure commits nothing. No detached job or refresh alias. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server:
|
|
781
|
+
/** @description Synchronously fetch metadata only, with no request body. Complete catalog/history install independently; complete association sets install per transcript. Never transfer bodies, publish, join or alter consent. Typed reports on non-2xx preserve every committed effect and prior completion date. Status precedence: persistence > auth > deadline/cancellation > remote/contract > superseded. 200 only complete; initial auth failure commits nothing. No detached job or refresh alias. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
662
782
|
post: operations["fetchCollectiveObservations"];
|
|
663
783
|
delete?: never;
|
|
664
784
|
options?: never;
|
|
@@ -674,10 +794,10 @@ export interface paths {
|
|
|
674
794
|
cookie?: never;
|
|
675
795
|
};
|
|
676
796
|
get?: never;
|
|
677
|
-
/** @description Verify selected collective visibility online before storing explicit tracking. No body; tracking grants no membership or publication consent. Verification failure writes no preference; unavailable resources use privacy-safe 404. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server:
|
|
797
|
+
/** @description Verify selected collective visibility online before storing explicit tracking. No body; tracking grants no membership or publication consent. Verification failure writes no preference; unavailable resources use privacy-safe 404. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
678
798
|
put: operations["trackCollectiveObservation"];
|
|
679
799
|
post?: never;
|
|
680
|
-
/** @description Idempotently remove an explicit tracking preference using saved identity offline. No remote mutation or publication consent change. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server:
|
|
800
|
+
/** @description Idempotently remove an explicit tracking preference using saved identity offline. No remote mutation or publication consent change. Returns 403 with a JSON error, and changes nothing, when the request did not come from this local server: the request's Host header does not name a loopback address (code request_host_not_local), or a browser sent it from another origin or from a page this server did not serve (code request_origin_not_local). */
|
|
681
801
|
delete: operations["untrackCollectiveObservation"];
|
|
682
802
|
options?: never;
|
|
683
803
|
head?: never;
|
|
@@ -733,6 +853,27 @@ export interface components {
|
|
|
733
853
|
BestiaryHarness: Schema.Harness;
|
|
734
854
|
ClientMessage: Schema.ClientMessage;
|
|
735
855
|
DashboardPayload: Schema.DashboardPayload;
|
|
856
|
+
/**
|
|
857
|
+
* Kickstart Close Reason
|
|
858
|
+
* @description Why a kickstart session ended: committed or expired
|
|
859
|
+
* @example committed
|
|
860
|
+
* @example expired
|
|
861
|
+
* @enum {string}
|
|
862
|
+
*/
|
|
863
|
+
LocalKickstartCloseReason: Schema.LocalKickstartCloseReason;
|
|
864
|
+
LocalKickstartEvent: Schema.LocalKickstartEvent;
|
|
865
|
+
/**
|
|
866
|
+
* Kickstart Event Kind
|
|
867
|
+
* @description Live kickstart topic discriminator. One event carries one session id
|
|
868
|
+
* @example session
|
|
869
|
+
* @example answers
|
|
870
|
+
* @example conflicts
|
|
871
|
+
* @example scan
|
|
872
|
+
* @example ingest
|
|
873
|
+
* @example closed
|
|
874
|
+
* @enum {string}
|
|
875
|
+
*/
|
|
876
|
+
LocalKickstartEventKind: Schema.LocalKickstartEventKind;
|
|
736
877
|
LocalSessionPage: Schema.LocalSessionPage;
|
|
737
878
|
LocalSyncProjectOption: Schema.LocalSyncProjectOption;
|
|
738
879
|
LocalSyncProjectOptions: Schema.LocalSyncProjectOptions;
|
|
@@ -872,6 +1013,7 @@ export interface components {
|
|
|
872
1013
|
* @example quality
|
|
873
1014
|
* @example annotations
|
|
874
1015
|
* @example project_familiarity
|
|
1016
|
+
* @example kickstart
|
|
875
1017
|
* @enum {string}
|
|
876
1018
|
*/
|
|
877
1019
|
SchemaChannelTopic: Schema.ChannelTopic;
|
|
@@ -1175,6 +1317,182 @@ export interface components {
|
|
|
1175
1317
|
SchemaLocalContributionHistoryResponse: Schema.LocalContributionHistoryResponse;
|
|
1176
1318
|
SchemaLocalContributionTraversalConflict: Schema.LocalContributionTraversalConflict;
|
|
1177
1319
|
SchemaLocalHelperMembersPayload: Schema.LocalHelperMembersPayload;
|
|
1320
|
+
SchemaLocalKickstartAnswers: Schema.LocalKickstartAnswers;
|
|
1321
|
+
SchemaLocalKickstartCommitRefusal: Schema.LocalKickstartCommitRefusal;
|
|
1322
|
+
SchemaLocalKickstartCommitted: Schema.LocalKickstartCommitted;
|
|
1323
|
+
SchemaLocalKickstartConflict: Schema.LocalKickstartConflict;
|
|
1324
|
+
SchemaLocalKickstartConnect: Schema.LocalKickstartConnect;
|
|
1325
|
+
/**
|
|
1326
|
+
* Kickstart Connect Answer
|
|
1327
|
+
* @description Boundary offer answer: accept or skip. accept requires village to be connected
|
|
1328
|
+
* @example accept
|
|
1329
|
+
* @example skip
|
|
1330
|
+
* @enum {string}
|
|
1331
|
+
*/
|
|
1332
|
+
SchemaLocalKickstartConnectAnswer: Schema.LocalKickstartConnectAnswer;
|
|
1333
|
+
SchemaLocalKickstartDiff: Schema.LocalKickstartDiff;
|
|
1334
|
+
SchemaLocalKickstartDiffLine: Schema.LocalKickstartDiffLine;
|
|
1335
|
+
/**
|
|
1336
|
+
* Kickstart Diff Line Type
|
|
1337
|
+
* @description Structured config-diff line: add, del, or ctx
|
|
1338
|
+
* @example add
|
|
1339
|
+
* @example del
|
|
1340
|
+
* @example ctx
|
|
1341
|
+
* @enum {string}
|
|
1342
|
+
*/
|
|
1343
|
+
SchemaLocalKickstartDiffLineType: Schema.LocalKickstartDiffLineType;
|
|
1344
|
+
/**
|
|
1345
|
+
* Kickstart Error Code
|
|
1346
|
+
* @description Machine-readable reason a kickstart route refused a request or could not finish it. Each token answers with one HTTP status
|
|
1347
|
+
* @example kickstart_body_missing
|
|
1348
|
+
* @example kickstart_body_invalid
|
|
1349
|
+
* @example kickstart_scope_invalid
|
|
1350
|
+
* @example kickstart_answers_invalid
|
|
1351
|
+
* @example kickstart_session_committing
|
|
1352
|
+
* @example kickstart_revision_ahead
|
|
1353
|
+
* @example kickstart_answer_refused
|
|
1354
|
+
* @example kickstart_scan_not_done
|
|
1355
|
+
* @example kickstart_field_unknown
|
|
1356
|
+
* @example kickstart_field_out_of_scope
|
|
1357
|
+
* @example kickstart_field_hidden
|
|
1358
|
+
* @example kickstart_tree_answer_shape
|
|
1359
|
+
* @example kickstart_connect_out_of_scope
|
|
1360
|
+
* @example kickstart_connect_not_connected
|
|
1361
|
+
* @example kickstart_connect_unknown
|
|
1362
|
+
* @example kickstart_commit_refused
|
|
1363
|
+
* @example kickstart_session_not_found
|
|
1364
|
+
* @example kickstart_preview_row_not_found
|
|
1365
|
+
* @example kickstart_failed
|
|
1366
|
+
* @example kickstart_status_unreadable
|
|
1367
|
+
* @example kickstart_config_unreadable
|
|
1368
|
+
* @example kickstart_config_unwritable
|
|
1369
|
+
* @example kickstart_session_unbuildable
|
|
1370
|
+
* @example kickstart_answer_unencodable
|
|
1371
|
+
* @example kickstart_preview_unreadable
|
|
1372
|
+
* @example publishing_contract_breach
|
|
1373
|
+
* @example kickstart_unavailable
|
|
1374
|
+
* @example kickstart_config_busy
|
|
1375
|
+
* @example kickstart_config_changing
|
|
1376
|
+
* @enum {string}
|
|
1377
|
+
*/
|
|
1378
|
+
SchemaLocalKickstartErrorCode: Schema.LocalKickstartErrorCode;
|
|
1379
|
+
SchemaLocalKickstartErrorResponse: Schema.LocalKickstartErrorResponse;
|
|
1380
|
+
SchemaLocalKickstartField: Schema.LocalKickstartField;
|
|
1381
|
+
/**
|
|
1382
|
+
* Kickstart Field Kind
|
|
1383
|
+
* @description Control shape of one kickstart field
|
|
1384
|
+
* @example toggle
|
|
1385
|
+
* @example choice
|
|
1386
|
+
* @example action
|
|
1387
|
+
* @example tree
|
|
1388
|
+
* @example notice
|
|
1389
|
+
* @enum {string}
|
|
1390
|
+
*/
|
|
1391
|
+
SchemaLocalKickstartFieldKind: Schema.LocalKickstartFieldKind;
|
|
1392
|
+
SchemaLocalKickstartGuide: Schema.LocalKickstartGuide;
|
|
1393
|
+
SchemaLocalKickstartHunk: Schema.LocalKickstartHunk;
|
|
1394
|
+
SchemaLocalKickstartIngest: Schema.LocalKickstartIngest;
|
|
1395
|
+
/**
|
|
1396
|
+
* Kickstart Ingest State
|
|
1397
|
+
* @description Import state pushed on the kickstart topic
|
|
1398
|
+
* @example idle
|
|
1399
|
+
* @example running
|
|
1400
|
+
* @example busy
|
|
1401
|
+
* @example failed
|
|
1402
|
+
* @enum {string}
|
|
1403
|
+
*/
|
|
1404
|
+
SchemaLocalKickstartIngestState: Schema.LocalKickstartIngestState;
|
|
1405
|
+
SchemaLocalKickstartLine: Schema.LocalKickstartLine;
|
|
1406
|
+
/**
|
|
1407
|
+
* Kickstart Line Kind
|
|
1408
|
+
* @description Typed preview or example line
|
|
1409
|
+
* @example text
|
|
1410
|
+
* @example label
|
|
1411
|
+
* @example before
|
|
1412
|
+
* @example after
|
|
1413
|
+
* @example spacer
|
|
1414
|
+
* @enum {string}
|
|
1415
|
+
*/
|
|
1416
|
+
SchemaLocalKickstartLineKind: Schema.LocalKickstartLineKind;
|
|
1417
|
+
/**
|
|
1418
|
+
* Kickstart Next Step
|
|
1419
|
+
* @description One finish action. auto-publish-settings links to the settings section; it does not install a hook
|
|
1420
|
+
* @example config
|
|
1421
|
+
* @example web-start
|
|
1422
|
+
* @example village-login
|
|
1423
|
+
* @example village-push
|
|
1424
|
+
* @example auto-publish-settings
|
|
1425
|
+
* @enum {string}
|
|
1426
|
+
*/
|
|
1427
|
+
SchemaLocalKickstartNextStep: Schema.LocalKickstartNextStep;
|
|
1428
|
+
SchemaLocalKickstartNode: Schema.LocalKickstartNode;
|
|
1429
|
+
/**
|
|
1430
|
+
* Kickstart Node Kind
|
|
1431
|
+
* @description Row kind in the selection forest
|
|
1432
|
+
* @example project
|
|
1433
|
+
* @example group
|
|
1434
|
+
* @example branch
|
|
1435
|
+
* @example session
|
|
1436
|
+
* @enum {string}
|
|
1437
|
+
*/
|
|
1438
|
+
SchemaLocalKickstartNodeKind: Schema.LocalKickstartNodeKind;
|
|
1439
|
+
/**
|
|
1440
|
+
* Kickstart Node State
|
|
1441
|
+
* @description Server-computed selection of one forest row: none, some, or all. locked is a boolean, not a state
|
|
1442
|
+
* @example none
|
|
1443
|
+
* @example some
|
|
1444
|
+
* @example all
|
|
1445
|
+
* @enum {string}
|
|
1446
|
+
*/
|
|
1447
|
+
SchemaLocalKickstartNodeState: Schema.LocalKickstartNodeState;
|
|
1448
|
+
SchemaLocalKickstartOpenRequest: Schema.LocalKickstartOpenRequest;
|
|
1449
|
+
SchemaLocalKickstartOption: Schema.LocalKickstartOption;
|
|
1450
|
+
SchemaLocalKickstartOverwrite: Schema.LocalKickstartOverwrite;
|
|
1451
|
+
SchemaLocalKickstartPatchResult: Schema.LocalKickstartPatchResult;
|
|
1452
|
+
SchemaLocalKickstartPreview: Schema.LocalKickstartPreview;
|
|
1453
|
+
/**
|
|
1454
|
+
* Kickstart Resolution
|
|
1455
|
+
* @description Which side of one conflict row to keep: mine is the draft, theirs is the file
|
|
1456
|
+
* @example mine
|
|
1457
|
+
* @example theirs
|
|
1458
|
+
* @enum {string}
|
|
1459
|
+
*/
|
|
1460
|
+
SchemaLocalKickstartResolution: Schema.LocalKickstartResolution;
|
|
1461
|
+
SchemaLocalKickstartScan: Schema.LocalKickstartScan;
|
|
1462
|
+
/**
|
|
1463
|
+
* Kickstart Scan State
|
|
1464
|
+
* @description Discovery job state pushed on the kickstart topic
|
|
1465
|
+
* @example idle
|
|
1466
|
+
* @example running
|
|
1467
|
+
* @example done
|
|
1468
|
+
* @example error
|
|
1469
|
+
* @enum {string}
|
|
1470
|
+
*/
|
|
1471
|
+
SchemaLocalKickstartScanState: Schema.LocalKickstartScanState;
|
|
1472
|
+
/**
|
|
1473
|
+
* Kickstart Scope
|
|
1474
|
+
* @description Answer set a kickstart session collects: the whole wizard, or the selection page
|
|
1475
|
+
* @example full
|
|
1476
|
+
* @example selection
|
|
1477
|
+
* @enum {string}
|
|
1478
|
+
*/
|
|
1479
|
+
SchemaLocalKickstartScope: Schema.LocalKickstartScope;
|
|
1480
|
+
SchemaLocalKickstartSession: Schema.LocalKickstartSession;
|
|
1481
|
+
SchemaLocalKickstartStatus: Schema.LocalKickstartStatus;
|
|
1482
|
+
SchemaLocalKickstartStop: Schema.LocalKickstartStop;
|
|
1483
|
+
/**
|
|
1484
|
+
* Kickstart Stop Kind
|
|
1485
|
+
* @description Layout of one kickstart stop
|
|
1486
|
+
* @example connection
|
|
1487
|
+
* @example config
|
|
1488
|
+
* @example review
|
|
1489
|
+
* @example ingest
|
|
1490
|
+
* @enum {string}
|
|
1491
|
+
*/
|
|
1492
|
+
SchemaLocalKickstartStopKind: Schema.LocalKickstartStopKind;
|
|
1493
|
+
SchemaLocalKickstartSummary: Schema.LocalKickstartSummary;
|
|
1494
|
+
SchemaLocalKickstartTree: Schema.LocalKickstartTree;
|
|
1495
|
+
SchemaLocalKickstartVillage: Schema.LocalKickstartVillage;
|
|
1178
1496
|
SchemaLocalOperationDiagnostic: Schema.LocalOperationDiagnostic;
|
|
1179
1497
|
/**
|
|
1180
1498
|
* Local Operation Diagnostic Outcome
|
|
@@ -1266,6 +1584,7 @@ export interface components {
|
|
|
1266
1584
|
* @example project_familiarity
|
|
1267
1585
|
* @example connected
|
|
1268
1586
|
* @example error
|
|
1587
|
+
* @example kickstart
|
|
1269
1588
|
* @enum {string}
|
|
1270
1589
|
*/
|
|
1271
1590
|
SchemaMessageType: Schema.MessageType;
|
|
@@ -1916,7 +2235,7 @@ export interface operations {
|
|
|
1916
2235
|
"application/json": components["schemas"]["SchemaCreateAnnotationResponse"];
|
|
1917
2236
|
};
|
|
1918
2237
|
};
|
|
1919
|
-
/** @description
|
|
2238
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
1920
2239
|
403: {
|
|
1921
2240
|
headers: {
|
|
1922
2241
|
[name: string]: unknown;
|
|
@@ -2031,20 +2350,18 @@ export interface operations {
|
|
|
2031
2350
|
};
|
|
2032
2351
|
};
|
|
2033
2352
|
};
|
|
2034
|
-
|
|
2353
|
+
openKickstartSession: {
|
|
2035
2354
|
parameters: {
|
|
2036
|
-
query?:
|
|
2037
|
-
/** @description Optional commit SHA to build the graph at (default HEAD) */
|
|
2038
|
-
commit?: string;
|
|
2039
|
-
};
|
|
2355
|
+
query?: never;
|
|
2040
2356
|
header?: never;
|
|
2041
|
-
path
|
|
2042
|
-
/** @description Opaque project hash */
|
|
2043
|
-
projectHash: components["schemas"]["SchemaProjectHash"];
|
|
2044
|
-
};
|
|
2357
|
+
path?: never;
|
|
2045
2358
|
cookie?: never;
|
|
2046
2359
|
};
|
|
2047
|
-
requestBody
|
|
2360
|
+
requestBody: {
|
|
2361
|
+
content: {
|
|
2362
|
+
"application/json": components["schemas"]["SchemaLocalKickstartOpenRequest"];
|
|
2363
|
+
};
|
|
2364
|
+
};
|
|
2048
2365
|
responses: {
|
|
2049
2366
|
/** @description OK */
|
|
2050
2367
|
200: {
|
|
@@ -2052,47 +2369,54 @@ export interface operations {
|
|
|
2052
2369
|
[name: string]: unknown;
|
|
2053
2370
|
};
|
|
2054
2371
|
content: {
|
|
2055
|
-
"application/json": components["schemas"]["
|
|
2372
|
+
"application/json": components["schemas"]["SchemaLocalKickstartSession"];
|
|
2056
2373
|
};
|
|
2057
2374
|
};
|
|
2058
|
-
|
|
2059
|
-
|
|
2060
|
-
|
|
2061
|
-
|
|
2062
|
-
|
|
2063
|
-
|
|
2064
|
-
|
|
2375
|
+
/** @description The request was refused and nothing was changed. The JSON error code is one of: kickstart_body_missing, kickstart_body_invalid, kickstart_scope_invalid. */
|
|
2376
|
+
400: {
|
|
2377
|
+
headers: {
|
|
2378
|
+
[name: string]: unknown;
|
|
2379
|
+
};
|
|
2380
|
+
content: {
|
|
2381
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2382
|
+
};
|
|
2065
2383
|
};
|
|
2066
|
-
header
|
|
2067
|
-
|
|
2068
|
-
|
|
2069
|
-
|
|
2384
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
2385
|
+
403: {
|
|
2386
|
+
headers: {
|
|
2387
|
+
[name: string]: unknown;
|
|
2388
|
+
};
|
|
2389
|
+
content: {
|
|
2390
|
+
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
2391
|
+
};
|
|
2070
2392
|
};
|
|
2071
|
-
|
|
2072
|
-
|
|
2073
|
-
requestBody?: never;
|
|
2074
|
-
responses: {
|
|
2075
|
-
/** @description OK */
|
|
2076
|
-
200: {
|
|
2393
|
+
/** @description The server could not finish the request. The JSON error code is one of: kickstart_config_unreadable, kickstart_session_unbuildable, kickstart_failed, publishing_contract_breach. */
|
|
2394
|
+
500: {
|
|
2077
2395
|
headers: {
|
|
2078
2396
|
[name: string]: unknown;
|
|
2079
2397
|
};
|
|
2080
2398
|
content: {
|
|
2081
|
-
"application/json": components["schemas"]["
|
|
2399
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2400
|
+
};
|
|
2401
|
+
};
|
|
2402
|
+
/** @description The setup service cannot take the request now. The JSON error code is one of: kickstart_unavailable. */
|
|
2403
|
+
503: {
|
|
2404
|
+
headers: {
|
|
2405
|
+
[name: string]: unknown;
|
|
2406
|
+
};
|
|
2407
|
+
content: {
|
|
2408
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2082
2409
|
};
|
|
2083
2410
|
};
|
|
2084
2411
|
};
|
|
2085
2412
|
};
|
|
2086
|
-
|
|
2413
|
+
getKickstartSession: {
|
|
2087
2414
|
parameters: {
|
|
2088
|
-
query?:
|
|
2089
|
-
/** @description Optional file or directory filter */
|
|
2090
|
-
file?: string;
|
|
2091
|
-
};
|
|
2415
|
+
query?: never;
|
|
2092
2416
|
header?: never;
|
|
2093
2417
|
path: {
|
|
2094
|
-
/** @description
|
|
2095
|
-
|
|
2418
|
+
/** @description Kickstart session id */
|
|
2419
|
+
id: string;
|
|
2096
2420
|
};
|
|
2097
2421
|
cookie?: never;
|
|
2098
2422
|
};
|
|
@@ -2104,55 +2428,553 @@ export interface operations {
|
|
|
2104
2428
|
[name: string]: unknown;
|
|
2105
2429
|
};
|
|
2106
2430
|
content: {
|
|
2107
|
-
"application/json": components["schemas"]["
|
|
2431
|
+
"application/json": components["schemas"]["SchemaLocalKickstartSession"];
|
|
2108
2432
|
};
|
|
2109
2433
|
};
|
|
2110
|
-
|
|
2111
|
-
|
|
2112
|
-
resolveProject: {
|
|
2113
|
-
parameters: {
|
|
2114
|
-
query: {
|
|
2115
|
-
/** @description Exact project display identity from a saved route */
|
|
2116
|
-
name: string;
|
|
2117
|
-
};
|
|
2118
|
-
header?: never;
|
|
2119
|
-
path?: never;
|
|
2120
|
-
cookie?: never;
|
|
2121
|
-
};
|
|
2122
|
-
requestBody?: never;
|
|
2123
|
-
responses: {
|
|
2124
|
-
/** @description OK */
|
|
2125
|
-
200: {
|
|
2434
|
+
/** @description Refused, and nothing was served, because the request's Host header does not name a loopback address. The JSON error code is request_host_not_local. */
|
|
2435
|
+
403: {
|
|
2126
2436
|
headers: {
|
|
2127
2437
|
[name: string]: unknown;
|
|
2128
2438
|
};
|
|
2129
2439
|
content: {
|
|
2130
|
-
"application/json": components["schemas"]["
|
|
2440
|
+
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
2131
2441
|
};
|
|
2132
2442
|
};
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
listProjectSummaries: {
|
|
2136
|
-
parameters: {
|
|
2137
|
-
query?: never;
|
|
2138
|
-
header?: never;
|
|
2139
|
-
path?: never;
|
|
2140
|
-
cookie?: never;
|
|
2141
|
-
};
|
|
2142
|
-
requestBody?: never;
|
|
2143
|
-
responses: {
|
|
2144
|
-
/** @description OK */
|
|
2145
|
-
200: {
|
|
2443
|
+
/** @description No session or forest row matches. The JSON error code is one of: kickstart_session_not_found. */
|
|
2444
|
+
404: {
|
|
2146
2445
|
headers: {
|
|
2147
2446
|
[name: string]: unknown;
|
|
2148
2447
|
};
|
|
2149
2448
|
content: {
|
|
2150
|
-
"application/json": components["schemas"]["
|
|
2449
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2151
2450
|
};
|
|
2152
2451
|
};
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
|
|
2452
|
+
/** @description The server could not finish the request. The JSON error code is one of: kickstart_failed, publishing_contract_breach. */
|
|
2453
|
+
500: {
|
|
2454
|
+
headers: {
|
|
2455
|
+
[name: string]: unknown;
|
|
2456
|
+
};
|
|
2457
|
+
content: {
|
|
2458
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2459
|
+
};
|
|
2460
|
+
};
|
|
2461
|
+
/** @description The setup service cannot take the request now. The JSON error code is one of: kickstart_unavailable. */
|
|
2462
|
+
503: {
|
|
2463
|
+
headers: {
|
|
2464
|
+
[name: string]: unknown;
|
|
2465
|
+
};
|
|
2466
|
+
content: {
|
|
2467
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2468
|
+
};
|
|
2469
|
+
};
|
|
2470
|
+
};
|
|
2471
|
+
};
|
|
2472
|
+
patchKickstartSession: {
|
|
2473
|
+
parameters: {
|
|
2474
|
+
query?: never;
|
|
2475
|
+
header?: never;
|
|
2476
|
+
path: {
|
|
2477
|
+
/** @description Kickstart session id */
|
|
2478
|
+
id: string;
|
|
2479
|
+
};
|
|
2480
|
+
cookie?: never;
|
|
2481
|
+
};
|
|
2482
|
+
requestBody: {
|
|
2483
|
+
content: {
|
|
2484
|
+
"application/json": components["schemas"]["SchemaLocalKickstartAnswers"];
|
|
2485
|
+
};
|
|
2486
|
+
};
|
|
2487
|
+
responses: {
|
|
2488
|
+
/** @description OK */
|
|
2489
|
+
200: {
|
|
2490
|
+
headers: {
|
|
2491
|
+
[name: string]: unknown;
|
|
2492
|
+
};
|
|
2493
|
+
content: {
|
|
2494
|
+
"application/json": components["schemas"]["SchemaLocalKickstartPatchResult"];
|
|
2495
|
+
};
|
|
2496
|
+
};
|
|
2497
|
+
/** @description The request was refused and nothing was changed. The JSON error code is one of: kickstart_body_missing, kickstart_body_invalid, kickstart_answers_invalid, kickstart_session_committing, kickstart_revision_ahead, kickstart_answer_refused, kickstart_scan_not_done, kickstart_field_unknown, kickstart_field_out_of_scope, kickstart_field_hidden, kickstart_tree_answer_shape, kickstart_connect_out_of_scope, kickstart_connect_not_connected, kickstart_connect_unknown. */
|
|
2498
|
+
400: {
|
|
2499
|
+
headers: {
|
|
2500
|
+
[name: string]: unknown;
|
|
2501
|
+
};
|
|
2502
|
+
content: {
|
|
2503
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2504
|
+
};
|
|
2505
|
+
};
|
|
2506
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
2507
|
+
403: {
|
|
2508
|
+
headers: {
|
|
2509
|
+
[name: string]: unknown;
|
|
2510
|
+
};
|
|
2511
|
+
content: {
|
|
2512
|
+
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
2513
|
+
};
|
|
2514
|
+
};
|
|
2515
|
+
/** @description No session or forest row matches. The JSON error code is one of: kickstart_session_not_found. */
|
|
2516
|
+
404: {
|
|
2517
|
+
headers: {
|
|
2518
|
+
[name: string]: unknown;
|
|
2519
|
+
};
|
|
2520
|
+
content: {
|
|
2521
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2522
|
+
};
|
|
2523
|
+
};
|
|
2524
|
+
/** @description The server could not finish the request. The JSON error code is one of: kickstart_answer_unencodable, kickstart_session_unbuildable, kickstart_failed, publishing_contract_breach. */
|
|
2525
|
+
500: {
|
|
2526
|
+
headers: {
|
|
2527
|
+
[name: string]: unknown;
|
|
2528
|
+
};
|
|
2529
|
+
content: {
|
|
2530
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2531
|
+
};
|
|
2532
|
+
};
|
|
2533
|
+
/** @description The setup service cannot take the request now. The JSON error code is one of: kickstart_unavailable. */
|
|
2534
|
+
503: {
|
|
2535
|
+
headers: {
|
|
2536
|
+
[name: string]: unknown;
|
|
2537
|
+
};
|
|
2538
|
+
content: {
|
|
2539
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2540
|
+
};
|
|
2541
|
+
};
|
|
2542
|
+
};
|
|
2543
|
+
};
|
|
2544
|
+
commitKickstartSession: {
|
|
2545
|
+
parameters: {
|
|
2546
|
+
query?: never;
|
|
2547
|
+
header?: never;
|
|
2548
|
+
path: {
|
|
2549
|
+
/** @description Kickstart session id */
|
|
2550
|
+
id: string;
|
|
2551
|
+
};
|
|
2552
|
+
cookie?: never;
|
|
2553
|
+
};
|
|
2554
|
+
requestBody?: never;
|
|
2555
|
+
responses: {
|
|
2556
|
+
/** @description OK */
|
|
2557
|
+
200: {
|
|
2558
|
+
headers: {
|
|
2559
|
+
[name: string]: unknown;
|
|
2560
|
+
};
|
|
2561
|
+
content: {
|
|
2562
|
+
"application/json": components["schemas"]["SchemaLocalKickstartCommitted"];
|
|
2563
|
+
};
|
|
2564
|
+
};
|
|
2565
|
+
/** @description The request was refused and nothing was changed. The JSON error code is one of: kickstart_session_committing, kickstart_commit_refused. */
|
|
2566
|
+
400: {
|
|
2567
|
+
headers: {
|
|
2568
|
+
[name: string]: unknown;
|
|
2569
|
+
};
|
|
2570
|
+
content: {
|
|
2571
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2572
|
+
};
|
|
2573
|
+
};
|
|
2574
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
2575
|
+
403: {
|
|
2576
|
+
headers: {
|
|
2577
|
+
[name: string]: unknown;
|
|
2578
|
+
};
|
|
2579
|
+
content: {
|
|
2580
|
+
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
2581
|
+
};
|
|
2582
|
+
};
|
|
2583
|
+
/** @description No session or forest row matches. The JSON error code is one of: kickstart_session_not_found. */
|
|
2584
|
+
404: {
|
|
2585
|
+
headers: {
|
|
2586
|
+
[name: string]: unknown;
|
|
2587
|
+
};
|
|
2588
|
+
content: {
|
|
2589
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2590
|
+
};
|
|
2591
|
+
};
|
|
2592
|
+
/** @description Conflict */
|
|
2593
|
+
409: {
|
|
2594
|
+
headers: {
|
|
2595
|
+
[name: string]: unknown;
|
|
2596
|
+
};
|
|
2597
|
+
content: {
|
|
2598
|
+
"application/json": components["schemas"]["SchemaLocalKickstartCommitRefusal"];
|
|
2599
|
+
};
|
|
2600
|
+
};
|
|
2601
|
+
/** @description The server could not finish the request. The JSON error code is one of: kickstart_config_unreadable, kickstart_config_unwritable, kickstart_session_unbuildable, kickstart_failed, publishing_contract_breach. */
|
|
2602
|
+
500: {
|
|
2603
|
+
headers: {
|
|
2604
|
+
[name: string]: unknown;
|
|
2605
|
+
};
|
|
2606
|
+
content: {
|
|
2607
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2608
|
+
};
|
|
2609
|
+
};
|
|
2610
|
+
/** @description The setup service cannot take the request now. The JSON error code is one of: kickstart_unavailable, kickstart_config_busy, kickstart_config_changing. */
|
|
2611
|
+
503: {
|
|
2612
|
+
headers: {
|
|
2613
|
+
[name: string]: unknown;
|
|
2614
|
+
};
|
|
2615
|
+
content: {
|
|
2616
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2617
|
+
};
|
|
2618
|
+
};
|
|
2619
|
+
};
|
|
2620
|
+
};
|
|
2621
|
+
scanKickstartSession: {
|
|
2622
|
+
parameters: {
|
|
2623
|
+
query?: never;
|
|
2624
|
+
header?: never;
|
|
2625
|
+
path: {
|
|
2626
|
+
/** @description Kickstart session id */
|
|
2627
|
+
id: string;
|
|
2628
|
+
};
|
|
2629
|
+
cookie?: never;
|
|
2630
|
+
};
|
|
2631
|
+
requestBody?: never;
|
|
2632
|
+
responses: {
|
|
2633
|
+
/** @description OK */
|
|
2634
|
+
200: {
|
|
2635
|
+
headers: {
|
|
2636
|
+
[name: string]: unknown;
|
|
2637
|
+
};
|
|
2638
|
+
content: {
|
|
2639
|
+
"application/json": components["schemas"]["SchemaLocalKickstartScan"];
|
|
2640
|
+
};
|
|
2641
|
+
};
|
|
2642
|
+
/** @description The request was refused and nothing was changed. The JSON error code is one of: kickstart_session_committing. */
|
|
2643
|
+
400: {
|
|
2644
|
+
headers: {
|
|
2645
|
+
[name: string]: unknown;
|
|
2646
|
+
};
|
|
2647
|
+
content: {
|
|
2648
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2649
|
+
};
|
|
2650
|
+
};
|
|
2651
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
2652
|
+
403: {
|
|
2653
|
+
headers: {
|
|
2654
|
+
[name: string]: unknown;
|
|
2655
|
+
};
|
|
2656
|
+
content: {
|
|
2657
|
+
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
2658
|
+
};
|
|
2659
|
+
};
|
|
2660
|
+
/** @description No session or forest row matches. The JSON error code is one of: kickstart_session_not_found. */
|
|
2661
|
+
404: {
|
|
2662
|
+
headers: {
|
|
2663
|
+
[name: string]: unknown;
|
|
2664
|
+
};
|
|
2665
|
+
content: {
|
|
2666
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2667
|
+
};
|
|
2668
|
+
};
|
|
2669
|
+
/** @description The server could not finish the request. The JSON error code is one of: kickstart_failed, publishing_contract_breach. */
|
|
2670
|
+
500: {
|
|
2671
|
+
headers: {
|
|
2672
|
+
[name: string]: unknown;
|
|
2673
|
+
};
|
|
2674
|
+
content: {
|
|
2675
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2676
|
+
};
|
|
2677
|
+
};
|
|
2678
|
+
/** @description The setup service cannot take the request now. The JSON error code is one of: kickstart_unavailable. */
|
|
2679
|
+
503: {
|
|
2680
|
+
headers: {
|
|
2681
|
+
[name: string]: unknown;
|
|
2682
|
+
};
|
|
2683
|
+
content: {
|
|
2684
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2685
|
+
};
|
|
2686
|
+
};
|
|
2687
|
+
};
|
|
2688
|
+
};
|
|
2689
|
+
getKickstartTree: {
|
|
2690
|
+
parameters: {
|
|
2691
|
+
query?: never;
|
|
2692
|
+
header?: never;
|
|
2693
|
+
path: {
|
|
2694
|
+
/** @description Kickstart session id */
|
|
2695
|
+
id: string;
|
|
2696
|
+
};
|
|
2697
|
+
cookie?: never;
|
|
2698
|
+
};
|
|
2699
|
+
requestBody?: never;
|
|
2700
|
+
responses: {
|
|
2701
|
+
/** @description OK */
|
|
2702
|
+
200: {
|
|
2703
|
+
headers: {
|
|
2704
|
+
[name: string]: unknown;
|
|
2705
|
+
};
|
|
2706
|
+
content: {
|
|
2707
|
+
"application/json": components["schemas"]["SchemaLocalKickstartTree"];
|
|
2708
|
+
};
|
|
2709
|
+
};
|
|
2710
|
+
/** @description Refused, and nothing was served, because the request's Host header does not name a loopback address. The JSON error code is request_host_not_local. */
|
|
2711
|
+
403: {
|
|
2712
|
+
headers: {
|
|
2713
|
+
[name: string]: unknown;
|
|
2714
|
+
};
|
|
2715
|
+
content: {
|
|
2716
|
+
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
2717
|
+
};
|
|
2718
|
+
};
|
|
2719
|
+
/** @description No session or forest row matches. The JSON error code is one of: kickstart_session_not_found. */
|
|
2720
|
+
404: {
|
|
2721
|
+
headers: {
|
|
2722
|
+
[name: string]: unknown;
|
|
2723
|
+
};
|
|
2724
|
+
content: {
|
|
2725
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2726
|
+
};
|
|
2727
|
+
};
|
|
2728
|
+
/** @description The server could not finish the request. The JSON error code is one of: kickstart_failed, publishing_contract_breach. */
|
|
2729
|
+
500: {
|
|
2730
|
+
headers: {
|
|
2731
|
+
[name: string]: unknown;
|
|
2732
|
+
};
|
|
2733
|
+
content: {
|
|
2734
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2735
|
+
};
|
|
2736
|
+
};
|
|
2737
|
+
/** @description The setup service cannot take the request now. The JSON error code is one of: kickstart_unavailable. */
|
|
2738
|
+
503: {
|
|
2739
|
+
headers: {
|
|
2740
|
+
[name: string]: unknown;
|
|
2741
|
+
};
|
|
2742
|
+
content: {
|
|
2743
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2744
|
+
};
|
|
2745
|
+
};
|
|
2746
|
+
};
|
|
2747
|
+
};
|
|
2748
|
+
getKickstartPreview: {
|
|
2749
|
+
parameters: {
|
|
2750
|
+
query?: never;
|
|
2751
|
+
header?: never;
|
|
2752
|
+
path: {
|
|
2753
|
+
/** @description Kickstart session id */
|
|
2754
|
+
id: string;
|
|
2755
|
+
/** @description Forest row id */
|
|
2756
|
+
nodeId: string;
|
|
2757
|
+
};
|
|
2758
|
+
cookie?: never;
|
|
2759
|
+
};
|
|
2760
|
+
requestBody?: never;
|
|
2761
|
+
responses: {
|
|
2762
|
+
/** @description OK */
|
|
2763
|
+
200: {
|
|
2764
|
+
headers: {
|
|
2765
|
+
[name: string]: unknown;
|
|
2766
|
+
};
|
|
2767
|
+
content: {
|
|
2768
|
+
"application/json": components["schemas"]["SchemaLocalKickstartPreview"];
|
|
2769
|
+
};
|
|
2770
|
+
};
|
|
2771
|
+
/** @description Refused, and nothing was served, because the request's Host header does not name a loopback address. The JSON error code is request_host_not_local. */
|
|
2772
|
+
403: {
|
|
2773
|
+
headers: {
|
|
2774
|
+
[name: string]: unknown;
|
|
2775
|
+
};
|
|
2776
|
+
content: {
|
|
2777
|
+
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
2778
|
+
};
|
|
2779
|
+
};
|
|
2780
|
+
/** @description No session or forest row matches. The JSON error code is one of: kickstart_session_not_found, kickstart_preview_row_not_found. */
|
|
2781
|
+
404: {
|
|
2782
|
+
headers: {
|
|
2783
|
+
[name: string]: unknown;
|
|
2784
|
+
};
|
|
2785
|
+
content: {
|
|
2786
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2787
|
+
};
|
|
2788
|
+
};
|
|
2789
|
+
/** @description The server could not finish the request. The JSON error code is one of: kickstart_preview_unreadable, publishing_contract_breach. */
|
|
2790
|
+
500: {
|
|
2791
|
+
headers: {
|
|
2792
|
+
[name: string]: unknown;
|
|
2793
|
+
};
|
|
2794
|
+
content: {
|
|
2795
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2796
|
+
};
|
|
2797
|
+
};
|
|
2798
|
+
/** @description The setup service cannot take the request now. The JSON error code is one of: kickstart_unavailable. */
|
|
2799
|
+
503: {
|
|
2800
|
+
headers: {
|
|
2801
|
+
[name: string]: unknown;
|
|
2802
|
+
};
|
|
2803
|
+
content: {
|
|
2804
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2805
|
+
};
|
|
2806
|
+
};
|
|
2807
|
+
};
|
|
2808
|
+
};
|
|
2809
|
+
getKickstartStatus: {
|
|
2810
|
+
parameters: {
|
|
2811
|
+
query?: never;
|
|
2812
|
+
header?: never;
|
|
2813
|
+
path?: never;
|
|
2814
|
+
cookie?: never;
|
|
2815
|
+
};
|
|
2816
|
+
requestBody?: never;
|
|
2817
|
+
responses: {
|
|
2818
|
+
/** @description OK */
|
|
2819
|
+
200: {
|
|
2820
|
+
headers: {
|
|
2821
|
+
[name: string]: unknown;
|
|
2822
|
+
};
|
|
2823
|
+
content: {
|
|
2824
|
+
"application/json": components["schemas"]["SchemaLocalKickstartStatus"];
|
|
2825
|
+
};
|
|
2826
|
+
};
|
|
2827
|
+
/** @description Refused, and nothing was served, because the request's Host header does not name a loopback address. The JSON error code is request_host_not_local. */
|
|
2828
|
+
403: {
|
|
2829
|
+
headers: {
|
|
2830
|
+
[name: string]: unknown;
|
|
2831
|
+
};
|
|
2832
|
+
content: {
|
|
2833
|
+
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
2834
|
+
};
|
|
2835
|
+
};
|
|
2836
|
+
/** @description The server could not finish the request. The JSON error code is one of: kickstart_status_unreadable, publishing_contract_breach. */
|
|
2837
|
+
500: {
|
|
2838
|
+
headers: {
|
|
2839
|
+
[name: string]: unknown;
|
|
2840
|
+
};
|
|
2841
|
+
content: {
|
|
2842
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2843
|
+
};
|
|
2844
|
+
};
|
|
2845
|
+
/** @description The setup service cannot take the request now. The JSON error code is one of: kickstart_unavailable. */
|
|
2846
|
+
503: {
|
|
2847
|
+
headers: {
|
|
2848
|
+
[name: string]: unknown;
|
|
2849
|
+
};
|
|
2850
|
+
content: {
|
|
2851
|
+
"application/json": components["schemas"]["SchemaLocalKickstartErrorResponse"];
|
|
2852
|
+
};
|
|
2853
|
+
};
|
|
2854
|
+
};
|
|
2855
|
+
};
|
|
2856
|
+
getMapGraph: {
|
|
2857
|
+
parameters: {
|
|
2858
|
+
query?: {
|
|
2859
|
+
/** @description Optional commit SHA to build the graph at (default HEAD) */
|
|
2860
|
+
commit?: string;
|
|
2861
|
+
};
|
|
2862
|
+
header?: never;
|
|
2863
|
+
path: {
|
|
2864
|
+
/** @description Opaque project hash */
|
|
2865
|
+
projectHash: components["schemas"]["SchemaProjectHash"];
|
|
2866
|
+
};
|
|
2867
|
+
cookie?: never;
|
|
2868
|
+
};
|
|
2869
|
+
requestBody?: never;
|
|
2870
|
+
responses: {
|
|
2871
|
+
/** @description OK */
|
|
2872
|
+
200: {
|
|
2873
|
+
headers: {
|
|
2874
|
+
[name: string]: unknown;
|
|
2875
|
+
};
|
|
2876
|
+
content: {
|
|
2877
|
+
"application/json": components["schemas"]["SchemaMapGraphPayload"];
|
|
2878
|
+
};
|
|
2879
|
+
};
|
|
2880
|
+
};
|
|
2881
|
+
};
|
|
2882
|
+
getMapNodeDetail: {
|
|
2883
|
+
parameters: {
|
|
2884
|
+
query: {
|
|
2885
|
+
/** @description Repo-relative node ID */
|
|
2886
|
+
path: string;
|
|
2887
|
+
};
|
|
2888
|
+
header?: never;
|
|
2889
|
+
path: {
|
|
2890
|
+
/** @description Opaque project hash */
|
|
2891
|
+
projectHash: components["schemas"]["SchemaProjectHash"];
|
|
2892
|
+
};
|
|
2893
|
+
cookie?: never;
|
|
2894
|
+
};
|
|
2895
|
+
requestBody?: never;
|
|
2896
|
+
responses: {
|
|
2897
|
+
/** @description OK */
|
|
2898
|
+
200: {
|
|
2899
|
+
headers: {
|
|
2900
|
+
[name: string]: unknown;
|
|
2901
|
+
};
|
|
2902
|
+
content: {
|
|
2903
|
+
"application/json": components["schemas"]["SchemaMapNodeDetailPayload"];
|
|
2904
|
+
};
|
|
2905
|
+
};
|
|
2906
|
+
};
|
|
2907
|
+
};
|
|
2908
|
+
listProjectTasks: {
|
|
2909
|
+
parameters: {
|
|
2910
|
+
query?: {
|
|
2911
|
+
/** @description Optional file or directory filter */
|
|
2912
|
+
file?: string;
|
|
2913
|
+
};
|
|
2914
|
+
header?: never;
|
|
2915
|
+
path: {
|
|
2916
|
+
/** @description Opaque project hash */
|
|
2917
|
+
projectHash: components["schemas"]["SchemaProjectHash"];
|
|
2918
|
+
};
|
|
2919
|
+
cookie?: never;
|
|
2920
|
+
};
|
|
2921
|
+
requestBody?: never;
|
|
2922
|
+
responses: {
|
|
2923
|
+
/** @description OK */
|
|
2924
|
+
200: {
|
|
2925
|
+
headers: {
|
|
2926
|
+
[name: string]: unknown;
|
|
2927
|
+
};
|
|
2928
|
+
content: {
|
|
2929
|
+
"application/json": components["schemas"]["SchemaProjectTasksPayload"];
|
|
2930
|
+
};
|
|
2931
|
+
};
|
|
2932
|
+
};
|
|
2933
|
+
};
|
|
2934
|
+
resolveProject: {
|
|
2935
|
+
parameters: {
|
|
2936
|
+
query: {
|
|
2937
|
+
/** @description Exact project display identity from a saved route */
|
|
2938
|
+
name: string;
|
|
2939
|
+
};
|
|
2940
|
+
header?: never;
|
|
2941
|
+
path?: never;
|
|
2942
|
+
cookie?: never;
|
|
2943
|
+
};
|
|
2944
|
+
requestBody?: never;
|
|
2945
|
+
responses: {
|
|
2946
|
+
/** @description OK */
|
|
2947
|
+
200: {
|
|
2948
|
+
headers: {
|
|
2949
|
+
[name: string]: unknown;
|
|
2950
|
+
};
|
|
2951
|
+
content: {
|
|
2952
|
+
"application/json": components["schemas"]["SchemaProjectResolutionPayload"];
|
|
2953
|
+
};
|
|
2954
|
+
};
|
|
2955
|
+
};
|
|
2956
|
+
};
|
|
2957
|
+
listProjectSummaries: {
|
|
2958
|
+
parameters: {
|
|
2959
|
+
query?: never;
|
|
2960
|
+
header?: never;
|
|
2961
|
+
path?: never;
|
|
2962
|
+
cookie?: never;
|
|
2963
|
+
};
|
|
2964
|
+
requestBody?: never;
|
|
2965
|
+
responses: {
|
|
2966
|
+
/** @description OK */
|
|
2967
|
+
200: {
|
|
2968
|
+
headers: {
|
|
2969
|
+
[name: string]: unknown;
|
|
2970
|
+
};
|
|
2971
|
+
content: {
|
|
2972
|
+
"application/json": components["schemas"]["SchemaProjectSummariesPayload"];
|
|
2973
|
+
};
|
|
2974
|
+
};
|
|
2975
|
+
};
|
|
2976
|
+
};
|
|
2977
|
+
listPublications: {
|
|
2156
2978
|
parameters: {
|
|
2157
2979
|
query: {
|
|
2158
2980
|
/** @description Comma-separated local session IDs */
|
|
@@ -2750,6 +3572,33 @@ export interface operations {
|
|
|
2750
3572
|
"application/json": components["schemas"]["SchemaLocalSettingsResponse"];
|
|
2751
3573
|
};
|
|
2752
3574
|
};
|
|
3575
|
+
/** @description Refused, and nothing was served, because the request's Host header does not name a loopback address. The JSON error code is request_host_not_local. */
|
|
3576
|
+
403: {
|
|
3577
|
+
headers: {
|
|
3578
|
+
[name: string]: unknown;
|
|
3579
|
+
};
|
|
3580
|
+
content: {
|
|
3581
|
+
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
3582
|
+
};
|
|
3583
|
+
};
|
|
3584
|
+
/** @description The settings could not be read. The JSON error code is one of: settings_unreadable, settings_auto_publish_unreadable, settings_value_not_applied, publishing_contract_breach. */
|
|
3585
|
+
500: {
|
|
3586
|
+
headers: {
|
|
3587
|
+
[name: string]: unknown;
|
|
3588
|
+
};
|
|
3589
|
+
content: {
|
|
3590
|
+
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
3591
|
+
};
|
|
3592
|
+
};
|
|
3593
|
+
/** @description The settings cannot be served now. The JSON error code is one of: settings_unavailable, auto_publish_unavailable. */
|
|
3594
|
+
503: {
|
|
3595
|
+
headers: {
|
|
3596
|
+
[name: string]: unknown;
|
|
3597
|
+
};
|
|
3598
|
+
content: {
|
|
3599
|
+
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
3600
|
+
};
|
|
3601
|
+
};
|
|
2753
3602
|
};
|
|
2754
3603
|
};
|
|
2755
3604
|
updateSetting: {
|
|
@@ -2783,7 +3632,7 @@ export interface operations {
|
|
|
2783
3632
|
"application/json": components["schemas"]["SchemaLocalSettingRefusal"];
|
|
2784
3633
|
};
|
|
2785
3634
|
};
|
|
2786
|
-
/** @description
|
|
3635
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
2787
3636
|
403: {
|
|
2788
3637
|
headers: {
|
|
2789
3638
|
[name: string]: unknown;
|
|
@@ -2801,6 +3650,15 @@ export interface operations {
|
|
|
2801
3650
|
"application/json": components["schemas"]["SchemaLocalSettingRefusal"];
|
|
2802
3651
|
};
|
|
2803
3652
|
};
|
|
3653
|
+
/** @description Service Unavailable */
|
|
3654
|
+
503: {
|
|
3655
|
+
headers: {
|
|
3656
|
+
[name: string]: unknown;
|
|
3657
|
+
};
|
|
3658
|
+
content: {
|
|
3659
|
+
"application/json": components["schemas"]["SchemaLocalSettingRefusal"];
|
|
3660
|
+
};
|
|
3661
|
+
};
|
|
2804
3662
|
};
|
|
2805
3663
|
};
|
|
2806
3664
|
saveAutoPublishRule: {
|
|
@@ -2837,7 +3695,7 @@ export interface operations {
|
|
|
2837
3695
|
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
2838
3696
|
};
|
|
2839
3697
|
};
|
|
2840
|
-
/** @description
|
|
3698
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
2841
3699
|
403: {
|
|
2842
3700
|
headers: {
|
|
2843
3701
|
[name: string]: unknown;
|
|
@@ -2869,7 +3727,7 @@ export interface operations {
|
|
|
2869
3727
|
"application/json": components["schemas"]["SchemaAutoPublishRemovalResponse"];
|
|
2870
3728
|
};
|
|
2871
3729
|
};
|
|
2872
|
-
/** @description
|
|
3730
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
2873
3731
|
403: {
|
|
2874
3732
|
headers: {
|
|
2875
3733
|
[name: string]: unknown;
|
|
@@ -2923,7 +3781,7 @@ export interface operations {
|
|
|
2923
3781
|
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
2924
3782
|
};
|
|
2925
3783
|
};
|
|
2926
|
-
/** @description
|
|
3784
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
2927
3785
|
403: {
|
|
2928
3786
|
headers: {
|
|
2929
3787
|
[name: string]: unknown;
|
|
@@ -2961,7 +3819,7 @@ export interface operations {
|
|
|
2961
3819
|
"application/json": components["schemas"]["SchemaShutdownResponse"];
|
|
2962
3820
|
};
|
|
2963
3821
|
};
|
|
2964
|
-
/** @description
|
|
3822
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
2965
3823
|
403: {
|
|
2966
3824
|
headers: {
|
|
2967
3825
|
[name: string]: unknown;
|
|
@@ -3010,7 +3868,7 @@ export interface operations {
|
|
|
3010
3868
|
"application/json": components["schemas"]["SchemaSyncLoginResponse"];
|
|
3011
3869
|
};
|
|
3012
3870
|
};
|
|
3013
|
-
/** @description
|
|
3871
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
3014
3872
|
403: {
|
|
3015
3873
|
headers: {
|
|
3016
3874
|
[name: string]: unknown;
|
|
@@ -3039,7 +3897,7 @@ export interface operations {
|
|
|
3039
3897
|
"application/json": components["schemas"]["SchemaSyncLogoutResponse"];
|
|
3040
3898
|
};
|
|
3041
3899
|
};
|
|
3042
|
-
/** @description
|
|
3900
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
3043
3901
|
403: {
|
|
3044
3902
|
headers: {
|
|
3045
3903
|
[name: string]: unknown;
|
|
@@ -3072,7 +3930,7 @@ export interface operations {
|
|
|
3072
3930
|
"application/json": components["schemas"]["SchemaSyncPushResponse"];
|
|
3073
3931
|
};
|
|
3074
3932
|
};
|
|
3075
|
-
/** @description
|
|
3933
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
3076
3934
|
403: {
|
|
3077
3935
|
headers: {
|
|
3078
3936
|
[name: string]: unknown;
|
|
@@ -3251,7 +4109,7 @@ export interface operations {
|
|
|
3251
4109
|
"application/json": components["schemas"]["SchemaCollectiveFetchReport"] | components["schemas"]["OpenapiLocalErrorResponse"];
|
|
3252
4110
|
};
|
|
3253
4111
|
};
|
|
3254
|
-
/** @description
|
|
4112
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
3255
4113
|
403: {
|
|
3256
4114
|
headers: {
|
|
3257
4115
|
[name: string]: unknown;
|
|
@@ -3336,7 +4194,7 @@ export interface operations {
|
|
|
3336
4194
|
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
3337
4195
|
};
|
|
3338
4196
|
};
|
|
3339
|
-
/** @description
|
|
4197
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
3340
4198
|
403: {
|
|
3341
4199
|
headers: {
|
|
3342
4200
|
[name: string]: unknown;
|
|
@@ -3421,7 +4279,7 @@ export interface operations {
|
|
|
3421
4279
|
"application/json": components["schemas"]["OpenapiLocalErrorResponse"];
|
|
3422
4280
|
};
|
|
3423
4281
|
};
|
|
3424
|
-
/** @description
|
|
4282
|
+
/** @description Refused, and nothing was changed, because the request did not come from this local server. The JSON error code is request_host_not_local when the request's Host header does not name a loopback address, and request_origin_not_local when a browser sent it from another origin or from a page this server did not serve. */
|
|
3425
4283
|
403: {
|
|
3426
4284
|
headers: {
|
|
3427
4285
|
[name: string]: unknown;
|