@meshery/schemas 1.3.102 → 1.3.103
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/cloudApi.d.mts +4496 -4098
- package/dist/cloudApi.d.ts +4496 -4098
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/core/Core.d.ts +1 -1
- package/dist/constructs/v1alpha1/core/CoreSchema.js +1 -1
- package/dist/constructs/v1alpha1/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta1/diagnostics/Diagnostics.d.ts +536 -0
- package/dist/constructs/v1beta1/diagnostics/Diagnostics.js +1 -0
- package/dist/constructs/v1beta1/diagnostics/Diagnostics.mjs +0 -0
- package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.js +2 -0
- package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.mjs +2 -0
- package/dist/constructs/v1beta1/support/Support.d.ts +373 -0
- package/dist/constructs/v1beta1/support/SupportSchema.js +1 -1
- package/dist/constructs/v1beta1/support/SupportSchema.mjs +1 -1
- package/dist/constructs/v1beta2/core/Core.d.ts +26 -1
- package/dist/constructs/v1beta2/core/CoreSchema.js +1 -1
- package/dist/constructs/v1beta2/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealth.d.ts +50 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.js +1 -1
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.mjs +1 -1
- package/dist/constructs/v1beta3/claim/Claim.d.ts +150 -0
- package/dist/constructs/v1beta3/claim/ClaimSchema.js +2 -2
- package/dist/constructs/v1beta3/claim/ClaimSchema.mjs +2 -2
- package/dist/constructs/v1beta3/connection/Connection.d.ts +100 -0
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
- package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +150 -0
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +5 -5
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +5 -5
- package/dist/constructs/v1beta3/design/DesignSchema.js +5 -5
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +5 -5
- package/dist/constructs/v1beta3/event/Event.d.ts +275 -0
- package/dist/constructs/v1beta3/event/EventSchema.js +3 -3
- package/dist/constructs/v1beta3/event/EventSchema.mjs +3 -3
- package/dist/constructs/v1beta3/github/GithubSchema.js +1 -1
- package/dist/constructs/v1beta3/github/GithubSchema.mjs +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/ledger/Ledger.d.ts +175 -0
- package/dist/constructs/v1beta3/ledger/LedgerSchema.js +5 -5
- package/dist/constructs/v1beta3/ledger/LedgerSchema.mjs +5 -5
- package/dist/constructs/v1beta3/profile/Profile.d.ts +225 -0
- package/dist/constructs/v1beta3/profile/ProfileSchema.js +1 -1
- package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +1 -1
- package/dist/constructs/v1beta3/provider_capability/ProviderCapability.d.ts +50 -0
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.js +1 -1
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.mjs +1 -1
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +225 -0
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +8 -8
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +8 -8
- package/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,536 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
"/api/diagnostics/failures": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
get?: never;
|
|
15
|
+
put?: never;
|
|
16
|
+
/**
|
|
17
|
+
* Submit a failure diagnostic
|
|
18
|
+
* @description Accepts a small, anonymous, redacted diagnostic of a client-side failure, so maintainers learn about it before anyone writes in. Authentication is a per-client-kind, per-release-channel pre-shared key in the X-Client-Key header (a speed bump plus a revocation handle, not a strong secret: the key ships in the app and can be extracted). A signed-in caller may use its bearer token instead; then the organization is attached, and only then. The server enforces a body cap, strict decoding (unknown fields are rejected), rate limits, server-side re-redaction, and a 90-day retention on stored rows. Served by Layer5 Cloud (meshery-cloud #6330); see Blowhorn issue #771.
|
|
19
|
+
*/
|
|
20
|
+
post: operations["submitFailureDiagnostic"];
|
|
21
|
+
delete?: never;
|
|
22
|
+
options?: never;
|
|
23
|
+
head?: never;
|
|
24
|
+
patch?: never;
|
|
25
|
+
trace?: never;
|
|
26
|
+
};
|
|
27
|
+
}
|
|
28
|
+
export type webhooks = Record<string, never>;
|
|
29
|
+
export interface components {
|
|
30
|
+
schemas: {
|
|
31
|
+
/** @description A single anonymous, redacted report of a client-side failure. The same failure is deduplicated per install per day: one report carries the first time it was seen and how many times it has occurred since. Nothing in this report identifies a person: no config files, logs, account names, post text, or tokens, and the failure message keeps only the redacted cause sentence. Every object in this schema is closed (additionalProperties: false), so a client sending an unknown field gets a 400 rather than a silently widened report. */
|
|
32
|
+
FailureDiagnostic: {
|
|
33
|
+
/**
|
|
34
|
+
* Diagnostic ID
|
|
35
|
+
* Format: uuid
|
|
36
|
+
* @description Id generated by the client for this report. A human support request links back to it through AnonymousSupportRequest.diagnosticId.
|
|
37
|
+
*/
|
|
38
|
+
diagnosticId: string;
|
|
39
|
+
/**
|
|
40
|
+
* Occurred At
|
|
41
|
+
* Format: date-time
|
|
42
|
+
* @description When this occurrence of the failure happened.
|
|
43
|
+
*/
|
|
44
|
+
occurredAt: string;
|
|
45
|
+
/**
|
|
46
|
+
* First Seen At
|
|
47
|
+
* Format: date-time
|
|
48
|
+
* @description When this failure was first seen on this install, for the deduplication window the count covers.
|
|
49
|
+
*/
|
|
50
|
+
firstSeenAt: string;
|
|
51
|
+
/**
|
|
52
|
+
* Count
|
|
53
|
+
* @description How many times the same failure has occurred on this install within the deduplication window (per install per day).
|
|
54
|
+
*/
|
|
55
|
+
count: number;
|
|
56
|
+
/** Client */
|
|
57
|
+
client: {
|
|
58
|
+
/**
|
|
59
|
+
* Kind
|
|
60
|
+
* @description The client that produced this report.
|
|
61
|
+
* @enum {string}
|
|
62
|
+
*/
|
|
63
|
+
kind: "blowhorn-desktop";
|
|
64
|
+
/**
|
|
65
|
+
* Version
|
|
66
|
+
* @description Client version, for example the app release version.
|
|
67
|
+
*/
|
|
68
|
+
version: string;
|
|
69
|
+
/**
|
|
70
|
+
* Build SHA
|
|
71
|
+
* @description Source revision the client build came from.
|
|
72
|
+
*/
|
|
73
|
+
buildSha: string;
|
|
74
|
+
/**
|
|
75
|
+
* Channel
|
|
76
|
+
* @description Release channel the client build belongs to. Kept a free string rather than an enum: channel names are release-process values, and a new channel must not make older clients' reports undecodable.
|
|
77
|
+
*/
|
|
78
|
+
channel: string;
|
|
79
|
+
};
|
|
80
|
+
/** Operating System */
|
|
81
|
+
os: {
|
|
82
|
+
/**
|
|
83
|
+
* Name
|
|
84
|
+
* @description Operating system name.
|
|
85
|
+
*/
|
|
86
|
+
name: string;
|
|
87
|
+
/**
|
|
88
|
+
* Version
|
|
89
|
+
* @description Operating system version.
|
|
90
|
+
*/
|
|
91
|
+
version: string;
|
|
92
|
+
/**
|
|
93
|
+
* Architecture
|
|
94
|
+
* @description Operating system architecture.
|
|
95
|
+
*/
|
|
96
|
+
arch: string;
|
|
97
|
+
};
|
|
98
|
+
/** Failure */
|
|
99
|
+
failure: {
|
|
100
|
+
/**
|
|
101
|
+
* Surface
|
|
102
|
+
* @description Where the failure first became visible to the person.
|
|
103
|
+
* @enum {string}
|
|
104
|
+
*/
|
|
105
|
+
surface: "tray" | "popover" | "console" | "service";
|
|
106
|
+
/**
|
|
107
|
+
* Cause
|
|
108
|
+
* @description Stable machine-readable name for the cause. Deliberately a patterned string, not a closed enum: new failure causes are named by the client over time, and a closed enum would make the server reject reports carrying a cause it does not know yet. Consumers must treat an unknown cause as opaque, never as an error. Known causes today are the Blowhorn engine's StoreUnavailable.cause names: unavailable, not_configured, incomplete, bad_setting, config_unreadable, tunnel_refused, tunnel_silent, tunnel_off, not_postgres, auth_rejected, host_not_permitted, database_missing, timeout, version_unreadable, ledger_unreadable, schema_behind, schema_ahead, schema_edited, no_organization, unknown_organization, plus other named causes as clients add them.
|
|
109
|
+
*/
|
|
110
|
+
cause: string;
|
|
111
|
+
/**
|
|
112
|
+
* Code
|
|
113
|
+
* @description Machine-readable code for the failure, when the failure carries one beyond its cause (for example an exit or provider code). Kept a string so numeric and symbolic codes both fit; empty when the failure carries no code.
|
|
114
|
+
*/
|
|
115
|
+
code: string;
|
|
116
|
+
/**
|
|
117
|
+
* Message
|
|
118
|
+
* @description Redacted human-readable sentence for the failure: only the cause sentence survives, with paths, usernames, emails, profile names, post text, and tokens removed.
|
|
119
|
+
*/
|
|
120
|
+
message: string;
|
|
121
|
+
/**
|
|
122
|
+
* Ticks Skipped
|
|
123
|
+
* @description How many scheduled ticks the failure skipped, when the failure interrupted scheduled work.
|
|
124
|
+
*/
|
|
125
|
+
ticksSkipped: number;
|
|
126
|
+
};
|
|
127
|
+
/** Compatibility */
|
|
128
|
+
compat: {
|
|
129
|
+
/**
|
|
130
|
+
* Requires Schema
|
|
131
|
+
* @description Schema version the client requires the server to speak for this report to be understood.
|
|
132
|
+
*/
|
|
133
|
+
requiresSchema: string;
|
|
134
|
+
/**
|
|
135
|
+
* Contract Version
|
|
136
|
+
* @description Version of the client-server contract this report was built against. Kept a string so dotted versions and plain numbers both fit.
|
|
137
|
+
*/
|
|
138
|
+
contractVersion: string;
|
|
139
|
+
};
|
|
140
|
+
/**
|
|
141
|
+
* Install ID
|
|
142
|
+
* Format: uuid
|
|
143
|
+
* @description Optional per-install id, present only when the person has not opted out of failure reports. A random uuid4 minted once per install (Blowhorn's installationId, written beside cloud.yaml and reused), never a hardware id. Omitted entirely when opted out.
|
|
144
|
+
*/
|
|
145
|
+
installId?: string;
|
|
146
|
+
};
|
|
147
|
+
};
|
|
148
|
+
responses: {
|
|
149
|
+
/** @description Invalid request body or request param */
|
|
150
|
+
MeshkitError400: {
|
|
151
|
+
headers: {
|
|
152
|
+
[name: string]: unknown;
|
|
153
|
+
};
|
|
154
|
+
content: {
|
|
155
|
+
"application/json": {
|
|
156
|
+
/** @description The sentence the caller is shown. */
|
|
157
|
+
error: string;
|
|
158
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
159
|
+
code?: string;
|
|
160
|
+
/**
|
|
161
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
162
|
+
* @enum {string}
|
|
163
|
+
*/
|
|
164
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
165
|
+
/** @description MeshKit's probable causes of the error. */
|
|
166
|
+
probableCause?: string[];
|
|
167
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
168
|
+
suggestedRemediation?: string[];
|
|
169
|
+
};
|
|
170
|
+
};
|
|
171
|
+
};
|
|
172
|
+
/** @description Internal server error */
|
|
173
|
+
MeshkitError500: {
|
|
174
|
+
headers: {
|
|
175
|
+
[name: string]: unknown;
|
|
176
|
+
};
|
|
177
|
+
content: {
|
|
178
|
+
"application/json": {
|
|
179
|
+
/** @description The sentence the caller is shown. */
|
|
180
|
+
error: string;
|
|
181
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
182
|
+
code?: string;
|
|
183
|
+
/**
|
|
184
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
185
|
+
* @enum {string}
|
|
186
|
+
*/
|
|
187
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
188
|
+
/** @description MeshKit's probable causes of the error. */
|
|
189
|
+
probableCause?: string[];
|
|
190
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
191
|
+
suggestedRemediation?: string[];
|
|
192
|
+
};
|
|
193
|
+
};
|
|
194
|
+
};
|
|
195
|
+
/** @description Neither a signed-in session nor a valid X-Client-Key. A missing, revoked, expired, not-yet-valid or unknown key all answer alike, so key existence is not an oracle. Rotate the client key; this is not an expired session. */
|
|
196
|
+
ClientKeyUnauthorized: {
|
|
197
|
+
headers: {
|
|
198
|
+
[name: string]: unknown;
|
|
199
|
+
};
|
|
200
|
+
content: {
|
|
201
|
+
"application/json": {
|
|
202
|
+
/** @description The refusal, for example "Client key required for operation is invalid or missing". */
|
|
203
|
+
message: string;
|
|
204
|
+
};
|
|
205
|
+
};
|
|
206
|
+
};
|
|
207
|
+
/** @description The request body exceeds the 16 KB cap. Do not retry the same body. */
|
|
208
|
+
PayloadTooLarge: {
|
|
209
|
+
headers: {
|
|
210
|
+
[name: string]: unknown;
|
|
211
|
+
};
|
|
212
|
+
content: {
|
|
213
|
+
"application/json": {
|
|
214
|
+
/** @description The sentence the caller is shown. */
|
|
215
|
+
error: string;
|
|
216
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
217
|
+
code?: string;
|
|
218
|
+
/**
|
|
219
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
220
|
+
* @enum {string}
|
|
221
|
+
*/
|
|
222
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
223
|
+
/** @description MeshKit's probable causes of the error. */
|
|
224
|
+
probableCause?: string[];
|
|
225
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
226
|
+
suggestedRemediation?: string[];
|
|
227
|
+
};
|
|
228
|
+
};
|
|
229
|
+
};
|
|
230
|
+
/** @description Rate limit exceeded; retry after the Retry-After interval. */
|
|
231
|
+
RateLimited: {
|
|
232
|
+
headers: {
|
|
233
|
+
/** @description Seconds to wait before retrying; always a whole number of at least 1. */
|
|
234
|
+
"Retry-After"?: number;
|
|
235
|
+
[name: string]: unknown;
|
|
236
|
+
};
|
|
237
|
+
content: {
|
|
238
|
+
"application/json": {
|
|
239
|
+
/** @description The sentence the caller is shown. */
|
|
240
|
+
error: string;
|
|
241
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
242
|
+
code?: string;
|
|
243
|
+
/**
|
|
244
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
245
|
+
* @enum {string}
|
|
246
|
+
*/
|
|
247
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
248
|
+
/** @description MeshKit's probable causes of the error. */
|
|
249
|
+
probableCause?: string[];
|
|
250
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
251
|
+
suggestedRemediation?: string[];
|
|
252
|
+
};
|
|
253
|
+
};
|
|
254
|
+
};
|
|
255
|
+
};
|
|
256
|
+
parameters: never;
|
|
257
|
+
requestBodies: never;
|
|
258
|
+
headers: never;
|
|
259
|
+
pathItems: never;
|
|
260
|
+
}
|
|
261
|
+
export type $defs = Record<string, never>;
|
|
262
|
+
export interface operations {
|
|
263
|
+
submitFailureDiagnostic: {
|
|
264
|
+
parameters: {
|
|
265
|
+
query?: never;
|
|
266
|
+
header?: never;
|
|
267
|
+
path?: never;
|
|
268
|
+
cookie?: never;
|
|
269
|
+
};
|
|
270
|
+
requestBody: {
|
|
271
|
+
content: {
|
|
272
|
+
"application/json": {
|
|
273
|
+
/**
|
|
274
|
+
* Diagnostic ID
|
|
275
|
+
* Format: uuid
|
|
276
|
+
* @description Id generated by the client for this report. A human support request links back to it through AnonymousSupportRequest.diagnosticId.
|
|
277
|
+
*/
|
|
278
|
+
diagnosticId: string;
|
|
279
|
+
/**
|
|
280
|
+
* Occurred At
|
|
281
|
+
* Format: date-time
|
|
282
|
+
* @description When this occurrence of the failure happened.
|
|
283
|
+
*/
|
|
284
|
+
occurredAt: string;
|
|
285
|
+
/**
|
|
286
|
+
* First Seen At
|
|
287
|
+
* Format: date-time
|
|
288
|
+
* @description When this failure was first seen on this install, for the deduplication window the count covers.
|
|
289
|
+
*/
|
|
290
|
+
firstSeenAt: string;
|
|
291
|
+
/**
|
|
292
|
+
* Count
|
|
293
|
+
* @description How many times the same failure has occurred on this install within the deduplication window (per install per day).
|
|
294
|
+
*/
|
|
295
|
+
count: number;
|
|
296
|
+
/** Client */
|
|
297
|
+
client: {
|
|
298
|
+
/**
|
|
299
|
+
* Kind
|
|
300
|
+
* @description The client that produced this report.
|
|
301
|
+
* @enum {string}
|
|
302
|
+
*/
|
|
303
|
+
kind: "blowhorn-desktop";
|
|
304
|
+
/**
|
|
305
|
+
* Version
|
|
306
|
+
* @description Client version, for example the app release version.
|
|
307
|
+
*/
|
|
308
|
+
version: string;
|
|
309
|
+
/**
|
|
310
|
+
* Build SHA
|
|
311
|
+
* @description Source revision the client build came from.
|
|
312
|
+
*/
|
|
313
|
+
buildSha: string;
|
|
314
|
+
/**
|
|
315
|
+
* Channel
|
|
316
|
+
* @description Release channel the client build belongs to. Kept a free string rather than an enum: channel names are release-process values, and a new channel must not make older clients' reports undecodable.
|
|
317
|
+
*/
|
|
318
|
+
channel: string;
|
|
319
|
+
};
|
|
320
|
+
/** Operating System */
|
|
321
|
+
os: {
|
|
322
|
+
/**
|
|
323
|
+
* Name
|
|
324
|
+
* @description Operating system name.
|
|
325
|
+
*/
|
|
326
|
+
name: string;
|
|
327
|
+
/**
|
|
328
|
+
* Version
|
|
329
|
+
* @description Operating system version.
|
|
330
|
+
*/
|
|
331
|
+
version: string;
|
|
332
|
+
/**
|
|
333
|
+
* Architecture
|
|
334
|
+
* @description Operating system architecture.
|
|
335
|
+
*/
|
|
336
|
+
arch: string;
|
|
337
|
+
};
|
|
338
|
+
/** Failure */
|
|
339
|
+
failure: {
|
|
340
|
+
/**
|
|
341
|
+
* Surface
|
|
342
|
+
* @description Where the failure first became visible to the person.
|
|
343
|
+
* @enum {string}
|
|
344
|
+
*/
|
|
345
|
+
surface: "tray" | "popover" | "console" | "service";
|
|
346
|
+
/**
|
|
347
|
+
* Cause
|
|
348
|
+
* @description Stable machine-readable name for the cause. Deliberately a patterned string, not a closed enum: new failure causes are named by the client over time, and a closed enum would make the server reject reports carrying a cause it does not know yet. Consumers must treat an unknown cause as opaque, never as an error. Known causes today are the Blowhorn engine's StoreUnavailable.cause names: unavailable, not_configured, incomplete, bad_setting, config_unreadable, tunnel_refused, tunnel_silent, tunnel_off, not_postgres, auth_rejected, host_not_permitted, database_missing, timeout, version_unreadable, ledger_unreadable, schema_behind, schema_ahead, schema_edited, no_organization, unknown_organization, plus other named causes as clients add them.
|
|
349
|
+
*/
|
|
350
|
+
cause: string;
|
|
351
|
+
/**
|
|
352
|
+
* Code
|
|
353
|
+
* @description Machine-readable code for the failure, when the failure carries one beyond its cause (for example an exit or provider code). Kept a string so numeric and symbolic codes both fit; empty when the failure carries no code.
|
|
354
|
+
*/
|
|
355
|
+
code: string;
|
|
356
|
+
/**
|
|
357
|
+
* Message
|
|
358
|
+
* @description Redacted human-readable sentence for the failure: only the cause sentence survives, with paths, usernames, emails, profile names, post text, and tokens removed.
|
|
359
|
+
*/
|
|
360
|
+
message: string;
|
|
361
|
+
/**
|
|
362
|
+
* Ticks Skipped
|
|
363
|
+
* @description How many scheduled ticks the failure skipped, when the failure interrupted scheduled work.
|
|
364
|
+
*/
|
|
365
|
+
ticksSkipped: number;
|
|
366
|
+
};
|
|
367
|
+
/** Compatibility */
|
|
368
|
+
compat: {
|
|
369
|
+
/**
|
|
370
|
+
* Requires Schema
|
|
371
|
+
* @description Schema version the client requires the server to speak for this report to be understood.
|
|
372
|
+
*/
|
|
373
|
+
requiresSchema: string;
|
|
374
|
+
/**
|
|
375
|
+
* Contract Version
|
|
376
|
+
* @description Version of the client-server contract this report was built against. Kept a string so dotted versions and plain numbers both fit.
|
|
377
|
+
*/
|
|
378
|
+
contractVersion: string;
|
|
379
|
+
};
|
|
380
|
+
/**
|
|
381
|
+
* Install ID
|
|
382
|
+
* Format: uuid
|
|
383
|
+
* @description Optional per-install id, present only when the person has not opted out of failure reports. A random uuid4 minted once per install (Blowhorn's installationId, written beside cloud.yaml and reused), never a hardware id. Omitted entirely when opted out.
|
|
384
|
+
*/
|
|
385
|
+
installId?: string;
|
|
386
|
+
};
|
|
387
|
+
};
|
|
388
|
+
};
|
|
389
|
+
responses: {
|
|
390
|
+
/** @description Failure diagnostic stored */
|
|
391
|
+
201: {
|
|
392
|
+
headers: {
|
|
393
|
+
[name: string]: unknown;
|
|
394
|
+
};
|
|
395
|
+
content: {
|
|
396
|
+
"application/json": {
|
|
397
|
+
/**
|
|
398
|
+
* Format: uuid
|
|
399
|
+
* @description The stored diagnostic's id: the client's own when it sent one, otherwise generated by the server. Send it as AnonymousSupportRequest.diagnosticId to link a human report to this diagnostic.
|
|
400
|
+
*/
|
|
401
|
+
diagnosticId: string;
|
|
402
|
+
};
|
|
403
|
+
};
|
|
404
|
+
};
|
|
405
|
+
/** @description Invalid request body or request param */
|
|
406
|
+
400: {
|
|
407
|
+
headers: {
|
|
408
|
+
[name: string]: unknown;
|
|
409
|
+
};
|
|
410
|
+
content: {
|
|
411
|
+
"application/json": {
|
|
412
|
+
/** @description The sentence the caller is shown. */
|
|
413
|
+
error: string;
|
|
414
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
415
|
+
code?: string;
|
|
416
|
+
/**
|
|
417
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
418
|
+
* @enum {string}
|
|
419
|
+
*/
|
|
420
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
421
|
+
/** @description MeshKit's probable causes of the error. */
|
|
422
|
+
probableCause?: string[];
|
|
423
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
424
|
+
suggestedRemediation?: string[];
|
|
425
|
+
};
|
|
426
|
+
};
|
|
427
|
+
};
|
|
428
|
+
/** @description Neither a signed-in session nor a valid X-Client-Key. A missing, revoked, expired, not-yet-valid or unknown key all answer alike, so key existence is not an oracle. Rotate the client key; this is not an expired session. */
|
|
429
|
+
401: {
|
|
430
|
+
headers: {
|
|
431
|
+
[name: string]: unknown;
|
|
432
|
+
};
|
|
433
|
+
content: {
|
|
434
|
+
"application/json": {
|
|
435
|
+
/** @description The refusal, for example "Client key required for operation is invalid or missing". */
|
|
436
|
+
message: string;
|
|
437
|
+
};
|
|
438
|
+
};
|
|
439
|
+
};
|
|
440
|
+
/** @description The request body exceeds the 16 KB cap. Do not retry the same body. */
|
|
441
|
+
413: {
|
|
442
|
+
headers: {
|
|
443
|
+
[name: string]: unknown;
|
|
444
|
+
};
|
|
445
|
+
content: {
|
|
446
|
+
"application/json": {
|
|
447
|
+
/** @description The sentence the caller is shown. */
|
|
448
|
+
error: string;
|
|
449
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
450
|
+
code?: string;
|
|
451
|
+
/**
|
|
452
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
453
|
+
* @enum {string}
|
|
454
|
+
*/
|
|
455
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
456
|
+
/** @description MeshKit's probable causes of the error. */
|
|
457
|
+
probableCause?: string[];
|
|
458
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
459
|
+
suggestedRemediation?: string[];
|
|
460
|
+
};
|
|
461
|
+
};
|
|
462
|
+
};
|
|
463
|
+
/** @description Rate limit exceeded; retry after the Retry-After interval. */
|
|
464
|
+
429: {
|
|
465
|
+
headers: {
|
|
466
|
+
/** @description Seconds to wait before retrying; always a whole number of at least 1. */
|
|
467
|
+
"Retry-After"?: number;
|
|
468
|
+
[name: string]: unknown;
|
|
469
|
+
};
|
|
470
|
+
content: {
|
|
471
|
+
"application/json": {
|
|
472
|
+
/** @description The sentence the caller is shown. */
|
|
473
|
+
error: string;
|
|
474
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
475
|
+
code?: string;
|
|
476
|
+
/**
|
|
477
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
478
|
+
* @enum {string}
|
|
479
|
+
*/
|
|
480
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
481
|
+
/** @description MeshKit's probable causes of the error. */
|
|
482
|
+
probableCause?: string[];
|
|
483
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
484
|
+
suggestedRemediation?: string[];
|
|
485
|
+
};
|
|
486
|
+
};
|
|
487
|
+
};
|
|
488
|
+
/** @description Internal server error */
|
|
489
|
+
500: {
|
|
490
|
+
headers: {
|
|
491
|
+
[name: string]: unknown;
|
|
492
|
+
};
|
|
493
|
+
content: {
|
|
494
|
+
"application/json": {
|
|
495
|
+
/** @description The sentence the caller is shown. */
|
|
496
|
+
error: string;
|
|
497
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
498
|
+
code?: string;
|
|
499
|
+
/**
|
|
500
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
501
|
+
* @enum {string}
|
|
502
|
+
*/
|
|
503
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
504
|
+
/** @description MeshKit's probable causes of the error. */
|
|
505
|
+
probableCause?: string[];
|
|
506
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
507
|
+
suggestedRemediation?: string[];
|
|
508
|
+
};
|
|
509
|
+
};
|
|
510
|
+
};
|
|
511
|
+
/** @description The diagnostics store is not configured on this server; retry later. */
|
|
512
|
+
503: {
|
|
513
|
+
headers: {
|
|
514
|
+
[name: string]: unknown;
|
|
515
|
+
};
|
|
516
|
+
content: {
|
|
517
|
+
"application/json": {
|
|
518
|
+
/** @description The sentence the caller is shown. */
|
|
519
|
+
error: string;
|
|
520
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
521
|
+
code?: string;
|
|
522
|
+
/**
|
|
523
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
524
|
+
* @enum {string}
|
|
525
|
+
*/
|
|
526
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
527
|
+
/** @description MeshKit's probable causes of the error. */
|
|
528
|
+
probableCause?: string[];
|
|
529
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
530
|
+
suggestedRemediation?: string[];
|
|
531
|
+
};
|
|
532
|
+
};
|
|
533
|
+
};
|
|
534
|
+
};
|
|
535
|
+
};
|
|
536
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
'use strict';
|
|
File without changes
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"Diagnostics",description:"OpenAPI schema for anonymous, redacted failure diagnostics submitted by desktop clients.",version:"v1beta1",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},tags:[{name:"Diagnostics",description:"Operations related to failure diagnostics"}],paths:{"/api/diagnostics/failures":{post:{"x-internal":["cloud"],tags:["Diagnostics"],summary:"Submit a failure diagnostic",description:"Accepts a small, anonymous, redacted diagnostic of a client-side failure, so maintainers learn about it before anyone writes in. Authentication is a per-client-kind, per-release-channel pre-shared key in the X-Client-Key header (a speed bump plus a revocation handle, not a strong secret: the key ships in the app and can be extracted). A signed-in caller may use its bearer token instead; then the organization is attached, and only then. The server enforces a body cap, strict decoding (unknown fields are rejected), rate limits, server-side re-redaction, and a 90-day retention on stored rows. Served by Layer5 Cloud (meshery-cloud #6330); see Blowhorn issue #771.",operationId:"submitFailureDiagnostic",security:[{clientKey:[]},{jwt:[]}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"A single anonymous, redacted report of a client-side failure. The same failure is deduplicated per install per day: one report carries the first time it was seen and how many times it has occurred since. Nothing in this report identifies a person: no config files, logs, account names, post text, or tokens, and the failure message keeps only the redacted cause sentence. Every object in this schema is closed (additionalProperties: false), so a client sending an unknown field gets a 400 rather than a silently widened report.",additionalProperties:false,required:["diagnosticId","occurredAt","firstSeenAt","count","client","os","failure","compat"],properties:{diagnosticId:{type:"string",title:"Diagnostic ID",format:"uuid",description:"Id generated by the client for this report. A human support request links back to it through AnonymousSupportRequest.diagnosticId."},occurredAt:{type:"string",title:"Occurred At",format:"date-time",description:"When this occurrence of the failure happened."},firstSeenAt:{type:"string",title:"First Seen At",format:"date-time",description:"When this failure was first seen on this install, for the deduplication window the count covers."},count:{type:"integer",title:"Count",minimum:1,description:"How many times the same failure has occurred on this install within the deduplication window (per install per day)."},client:{type:"object",title:"Client",additionalProperties:false,required:["kind","version","buildSha","channel"],properties:{kind:{type:"string",title:"Kind",enum:["blowhorn-desktop"],description:"The client that produced this report."},version:{type:"string",title:"Version",minLength:1,maxLength:64,description:"Client version, for example the app release version."},buildSha:{type:"string",title:"Build SHA",minLength:1,maxLength:128,description:"Source revision the client build came from."},channel:{type:"string",title:"Channel",minLength:1,maxLength:64,description:"Release channel the client build belongs to. Kept a free string rather than an enum: channel names are release-process values, and a new channel must not make older clients' reports undecodable."}}},os:{type:"object",title:"Operating System",additionalProperties:false,required:["name","version","arch"],properties:{name:{type:"string",title:"Name",minLength:1,maxLength:128,description:"Operating system name."},version:{type:"string",title:"Version",minLength:1,maxLength:128,description:"Operating system version."},arch:{type:"string",title:"Architecture",minLength:1,maxLength:64,description:"Operating system architecture."}}},failure:{type:"object",title:"Failure",additionalProperties:false,required:["surface","cause","code","message","ticksSkipped"],properties:{surface:{type:"string",title:"Surface",enum:["tray","popover","console","service"],description:"Where the failure first became visible to the person."},cause:{type:"string",title:"Cause",pattern:"^[a-z][a-z0-9_]*$",maxLength:64,description:"Stable machine-readable name for the cause. Deliberately a patterned string, not a closed enum: new failure causes are named by the client over time, and a closed enum would make the server reject reports carrying a cause it does not know yet. Consumers must treat an unknown cause as opaque, never as an error. Known causes today are the Blowhorn engine's StoreUnavailable.cause names: unavailable, not_configured, incomplete, bad_setting, config_unreadable, tunnel_refused, tunnel_silent, tunnel_off, not_postgres, auth_rejected, host_not_permitted, database_missing, timeout, version_unreadable, ledger_unreadable, schema_behind, schema_ahead, schema_edited, no_organization, unknown_organization, plus other named causes as clients add them."},code:{type:"string",title:"Code",maxLength:128,description:"Machine-readable code for the failure, when the failure carries one beyond its cause (for example an exit or provider code). Kept a string so numeric and symbolic codes both fit; empty when the failure carries no code."},message:{type:"string",title:"Message",maxLength:500,description:"Redacted human-readable sentence for the failure: only the cause sentence survives, with paths, usernames, emails, profile names, post text, and tokens removed."},ticksSkipped:{type:"integer",title:"Ticks Skipped",minimum:0,description:"How many scheduled ticks the failure skipped, when the failure interrupted scheduled work."}}},compat:{type:"object",title:"Compatibility",additionalProperties:false,required:["requiresSchema","contractVersion"],properties:{requiresSchema:{type:"string",title:"Requires Schema",minLength:1,maxLength:128,description:"Schema version the client requires the server to speak for this report to be understood."},contractVersion:{type:"string",title:"Contract Version",minLength:1,maxLength:64,description:"Version of the client-server contract this report was built against. Kept a string so dotted versions and plain numbers both fit."}}},installId:{type:"string",title:"Install ID",format:"uuid",maxLength:128,description:"Optional per-install id, present only when the person has not opted out of failure reports. A random uuid4 minted once per install (Blowhorn's installationId, written beside cloud.yaml and reused), never a hardware id. Omitted entirely when opted out."}}}}}},responses:{201:{description:"Failure diagnostic stored",content:{"application/json":{schema:{type:"object",additionalProperties:false,required:["diagnosticId"],properties:{diagnosticId:{type:"string",format:"uuid",description:"The stored diagnostic's id: the client's own when it sent one, otherwise generated by the server. Send it as AnonymousSupportRequest.diagnosticId to link a human report to this diagnostic."}}}}}},400:{description:"Invalid request body or request param",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},401:{description:"Neither a signed-in session nor a valid X-Client-Key. A missing, revoked, expired, not-yet-valid or unknown key all answer alike, so key existence is not an oracle. Rotate the client key; this is not an expired session.",content:{"application/json":{schema:{type:"object",required:["message"],properties:{message:{type:"string",description:'The refusal, for example "Client key required for operation is invalid or missing".'}}}}}},413:{description:"The request body exceeds the 16 KB cap. Do not retry the same body.",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},429:{description:"Rate limit exceeded; retry after the Retry-After interval.",headers:{"Retry-After":{description:"Seconds to wait before retrying; always a whole number of at least 1.",schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},503:{description:"The diagnostics store is not configured on this server; retry later.",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}}}}}},components:{responses:{MeshkitError400:{description:"Invalid request body or request param",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},MeshkitError500:{description:"Internal server error",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},ClientKeyUnauthorized:{description:"Neither a signed-in session nor a valid X-Client-Key. A missing, revoked, expired, not-yet-valid or unknown key all answer alike, so key existence is not an oracle. Rotate the client key; this is not an expired session.",content:{"application/json":{schema:{type:"object",required:["message"],properties:{message:{type:"string",description:'The refusal, for example "Client key required for operation is invalid or missing".'}}}}}},PayloadTooLarge:{description:"The request body exceeds the 16 KB cap. Do not retry the same body.",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},RateLimited:{description:"Rate limit exceeded; retry after the Retry-After interval.",headers:{"Retry-After":{description:"Seconds to wait before retrying; always a whole number of at least 1.",schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}}},securitySchemes:{clientKey:{type:"apiKey",in:"header",name:"X-Client-Key",description:"Per-client-kind, per-release-channel pre-shared key, of the form `<key id>.<secret>`. At least two keys are valid at any time so rotation never breaks old builds."},jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{FailureDiagnostic:{type:"object",description:"A single anonymous, redacted report of a client-side failure. The same failure is deduplicated per install per day: one report carries the first time it was seen and how many times it has occurred since. Nothing in this report identifies a person: no config files, logs, account names, post text, or tokens, and the failure message keeps only the redacted cause sentence. Every object in this schema is closed (additionalProperties: false), so a client sending an unknown field gets a 400 rather than a silently widened report.",additionalProperties:false,required:["diagnosticId","occurredAt","firstSeenAt","count","client","os","failure","compat"],properties:{diagnosticId:{type:"string",title:"Diagnostic ID",format:"uuid",description:"Id generated by the client for this report. A human support request links back to it through AnonymousSupportRequest.diagnosticId."},occurredAt:{type:"string",title:"Occurred At",format:"date-time",description:"When this occurrence of the failure happened."},firstSeenAt:{type:"string",title:"First Seen At",format:"date-time",description:"When this failure was first seen on this install, for the deduplication window the count covers."},count:{type:"integer",title:"Count",minimum:1,description:"How many times the same failure has occurred on this install within the deduplication window (per install per day)."},client:{type:"object",title:"Client",additionalProperties:false,required:["kind","version","buildSha","channel"],properties:{kind:{type:"string",title:"Kind",enum:["blowhorn-desktop"],description:"The client that produced this report."},version:{type:"string",title:"Version",minLength:1,maxLength:64,description:"Client version, for example the app release version."},buildSha:{type:"string",title:"Build SHA",minLength:1,maxLength:128,description:"Source revision the client build came from."},channel:{type:"string",title:"Channel",minLength:1,maxLength:64,description:"Release channel the client build belongs to. Kept a free string rather than an enum: channel names are release-process values, and a new channel must not make older clients' reports undecodable."}}},os:{type:"object",title:"Operating System",additionalProperties:false,required:["name","version","arch"],properties:{name:{type:"string",title:"Name",minLength:1,maxLength:128,description:"Operating system name."},version:{type:"string",title:"Version",minLength:1,maxLength:128,description:"Operating system version."},arch:{type:"string",title:"Architecture",minLength:1,maxLength:64,description:"Operating system architecture."}}},failure:{type:"object",title:"Failure",additionalProperties:false,required:["surface","cause","code","message","ticksSkipped"],properties:{surface:{type:"string",title:"Surface",enum:["tray","popover","console","service"],description:"Where the failure first became visible to the person."},cause:{type:"string",title:"Cause",pattern:"^[a-z][a-z0-9_]*$",maxLength:64,description:"Stable machine-readable name for the cause. Deliberately a patterned string, not a closed enum: new failure causes are named by the client over time, and a closed enum would make the server reject reports carrying a cause it does not know yet. Consumers must treat an unknown cause as opaque, never as an error. Known causes today are the Blowhorn engine's StoreUnavailable.cause names: unavailable, not_configured, incomplete, bad_setting, config_unreadable, tunnel_refused, tunnel_silent, tunnel_off, not_postgres, auth_rejected, host_not_permitted, database_missing, timeout, version_unreadable, ledger_unreadable, schema_behind, schema_ahead, schema_edited, no_organization, unknown_organization, plus other named causes as clients add them."},code:{type:"string",title:"Code",maxLength:128,description:"Machine-readable code for the failure, when the failure carries one beyond its cause (for example an exit or provider code). Kept a string so numeric and symbolic codes both fit; empty when the failure carries no code."},message:{type:"string",title:"Message",maxLength:500,description:"Redacted human-readable sentence for the failure: only the cause sentence survives, with paths, usernames, emails, profile names, post text, and tokens removed."},ticksSkipped:{type:"integer",title:"Ticks Skipped",minimum:0,description:"How many scheduled ticks the failure skipped, when the failure interrupted scheduled work."}}},compat:{type:"object",title:"Compatibility",additionalProperties:false,required:["requiresSchema","contractVersion"],properties:{requiresSchema:{type:"string",title:"Requires Schema",minLength:1,maxLength:128,description:"Schema version the client requires the server to speak for this report to be understood."},contractVersion:{type:"string",title:"Contract Version",minLength:1,maxLength:64,description:"Version of the client-server contract this report was built against. Kept a string so dotted versions and plain numbers both fit."}}},installId:{type:"string",title:"Install ID",format:"uuid",maxLength:128,description:"Optional per-install id, present only when the person has not opted out of failure reports. A random uuid4 minted once per install (Blowhorn's installationId, written beside cloud.yaml and reused), never a hardware id. Omitted entirely when opted out."}}}}}},t=e;
|
|
2
|
+
module.exports=t;
|