@meshery/schemas 1.3.87 → 1.3.88
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 +93 -1
- package/dist/cloudApi.d.ts +93 -1
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta3/connection/Connection.d.ts +74 -7
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +10 -2
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +10 -2
- package/dist/constructs/v1beta3/provider_capability/ProviderCapability.d.ts +468 -5
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.js +25 -4
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.mjs +25 -4
- package/dist/constructs/v1beta3/token/Token.d.ts +18 -1
- package/dist/constructs/v1beta3/token/TokenSchema.js +3 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +3 -1
- package/package.json +1 -1
|
@@ -18,7 +18,12 @@ export interface paths {
|
|
|
18
18
|
* the caller's roles, and with a valid token plus `X-Current-Orgid` it
|
|
19
19
|
* also carries `membership`. An invalid or absent token is not an error;
|
|
20
20
|
* the document is returned without `membership`. A malformed
|
|
21
|
-
* `X-Current-Orgid` is a client error and returns 400.
|
|
21
|
+
* `X-Current-Orgid` is a client error and returns 400. With `client`,
|
|
22
|
+
* the document carries `compatibility` for that client at `{version}`;
|
|
23
|
+
* an outdated client still receives 200 with `compatible` false. With a
|
|
24
|
+
* valid token the document carries `session`; for a live member of the
|
|
25
|
+
* `X-Current-Orgid` organization it includes that organization's plan,
|
|
26
|
+
* entitlements and device usage.
|
|
22
27
|
*/
|
|
23
28
|
get: operations["getProviderCapabilities"];
|
|
24
29
|
put?: never;
|
|
@@ -38,8 +43,11 @@ export interface components {
|
|
|
38
43
|
* @description The remote provider's capabilities document. Existing fields describe the
|
|
39
44
|
* provider and its extensions; `contractVersion` and `membership` let a
|
|
40
45
|
* native client gate on the provider's contract and on its organization
|
|
41
|
-
* membership after authenticating
|
|
42
|
-
* `
|
|
46
|
+
* membership after authenticating; `compatibility` tells a client that
|
|
47
|
+
* named itself whether its version is still accepted, and `session`
|
|
48
|
+
* describes the authenticated caller's roles, plan and entitlements. New
|
|
49
|
+
* fields arrive only with a new `contractVersion` (1.1 added
|
|
50
|
+
* `compatibility` and `session`).
|
|
43
51
|
*/
|
|
44
52
|
ProviderCapability: {
|
|
45
53
|
/** @description Provider type, for example `remote`. */
|
|
@@ -79,11 +87,142 @@ export interface components {
|
|
|
79
87
|
/** @description True when the caller is a live member of the organization. */
|
|
80
88
|
bound: boolean;
|
|
81
89
|
};
|
|
90
|
+
/** @description Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`. */
|
|
91
|
+
compatibility?: {
|
|
92
|
+
/** @description Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it. */
|
|
93
|
+
clientName: string;
|
|
94
|
+
/** @description The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`. */
|
|
95
|
+
clientVersion: string;
|
|
96
|
+
/** @description Oldest client version the provider accepts for this client. Absent when the provider sets no minimum. */
|
|
97
|
+
minimumVersion?: string;
|
|
98
|
+
/** @description True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum. */
|
|
99
|
+
compatible: boolean;
|
|
100
|
+
/** @description Where the client can get an update, when the provider knows one. */
|
|
101
|
+
upgradeUrl?: string;
|
|
102
|
+
};
|
|
103
|
+
/** @description The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request. */
|
|
104
|
+
session?: {
|
|
105
|
+
/**
|
|
106
|
+
* Format: uuid
|
|
107
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
108
|
+
*/
|
|
109
|
+
userId: string;
|
|
110
|
+
/** @description The caller's provider-wide role names. */
|
|
111
|
+
providerRoles: string[];
|
|
112
|
+
/** @description The caller's role names in the organization. */
|
|
113
|
+
organizationRoles?: string[];
|
|
114
|
+
/** @description The plan of the organization's active subscription, when it has one. */
|
|
115
|
+
plan?: {
|
|
116
|
+
/**
|
|
117
|
+
* Format: uuid
|
|
118
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
119
|
+
*/
|
|
120
|
+
id: string;
|
|
121
|
+
/**
|
|
122
|
+
* @description Display name of the plan.
|
|
123
|
+
* @enum {string}
|
|
124
|
+
*/
|
|
125
|
+
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
126
|
+
/**
|
|
127
|
+
* @description Billing cadence for the plan (monthly, annually, or none).
|
|
128
|
+
* @enum {string}
|
|
129
|
+
*/
|
|
130
|
+
cadence: "none" | "monthly" | "annually";
|
|
131
|
+
/**
|
|
132
|
+
* @description Unit of consumption this plan charges against (e.g. user).
|
|
133
|
+
* @enum {string}
|
|
134
|
+
*/
|
|
135
|
+
unit: "user" | "free";
|
|
136
|
+
/** @description Minimum number of units required for the plan. */
|
|
137
|
+
minimumUnits: number;
|
|
138
|
+
/** @description Price per unit of the plan. */
|
|
139
|
+
pricePerUnit: number;
|
|
140
|
+
/**
|
|
141
|
+
* @description Currency in which the plan is priced.
|
|
142
|
+
* @enum {string}
|
|
143
|
+
*/
|
|
144
|
+
currency: "usd";
|
|
145
|
+
};
|
|
146
|
+
/** @description The features the organization's active subscriptions entitle it to. */
|
|
147
|
+
entitlements?: {
|
|
148
|
+
/**
|
|
149
|
+
* Format: uuid
|
|
150
|
+
* @description Unique identifier for the feature.
|
|
151
|
+
*/
|
|
152
|
+
id: string;
|
|
153
|
+
/**
|
|
154
|
+
* Format: uuid
|
|
155
|
+
* @description Identifier of the plan granting this feature.
|
|
156
|
+
*/
|
|
157
|
+
plan_id: string;
|
|
158
|
+
/** @description The plan granting this feature. Populated only when the association is explicitly loaded. */
|
|
159
|
+
plan?: {
|
|
160
|
+
/**
|
|
161
|
+
* Format: uuid
|
|
162
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
163
|
+
*/
|
|
164
|
+
id: string;
|
|
165
|
+
/**
|
|
166
|
+
* @description Display name of the plan.
|
|
167
|
+
* @enum {string}
|
|
168
|
+
*/
|
|
169
|
+
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
170
|
+
/**
|
|
171
|
+
* @description Billing cadence for the plan (monthly, annually, or none).
|
|
172
|
+
* @enum {string}
|
|
173
|
+
*/
|
|
174
|
+
cadence: "none" | "monthly" | "annually";
|
|
175
|
+
/**
|
|
176
|
+
* @description Unit of consumption this plan charges against (e.g. user).
|
|
177
|
+
* @enum {string}
|
|
178
|
+
*/
|
|
179
|
+
unit: "user" | "free";
|
|
180
|
+
/** @description Minimum number of units required for the plan. */
|
|
181
|
+
minimumUnits: number;
|
|
182
|
+
/** @description Price per unit of the plan. */
|
|
183
|
+
pricePerUnit: number;
|
|
184
|
+
/**
|
|
185
|
+
* @description Currency in which the plan is priced.
|
|
186
|
+
* @enum {string}
|
|
187
|
+
*/
|
|
188
|
+
currency: "usd";
|
|
189
|
+
};
|
|
190
|
+
/**
|
|
191
|
+
* @description Name of the entitled feature.
|
|
192
|
+
* @enum {string}
|
|
193
|
+
*/
|
|
194
|
+
name: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign" | "BlowhornProfiles" | "BlowhornBrowserAutomation" | "BlowhornScheduler" | "BlowhornDevicesPerSeat" | "BlowhornPlatformLinkedIn" | "BlowhornPlatformX" | "BlowhornPlatformReddit" | "BlowhornPlatformHackerNews" | "BlowhornPlatformSlack" | "BlowhornPlatformBluesky" | "BlowhornPlatformGitHub" | "BlowhornPlatformBlog";
|
|
195
|
+
/**
|
|
196
|
+
* Format: double
|
|
197
|
+
* @description Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.
|
|
198
|
+
*/
|
|
199
|
+
quantity: number;
|
|
200
|
+
/**
|
|
201
|
+
* Format: date-time
|
|
202
|
+
* @description Timestamp when the resource was created.
|
|
203
|
+
*/
|
|
204
|
+
created_at: string;
|
|
205
|
+
/**
|
|
206
|
+
* Format: date-time
|
|
207
|
+
* @description Timestamp when the resource was updated.
|
|
208
|
+
*/
|
|
209
|
+
updated_at: string;
|
|
210
|
+
}[];
|
|
211
|
+
/** @description Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead. */
|
|
212
|
+
deviceUsage?: {
|
|
213
|
+
/** @description Live `desktop` connections registered in the organization. */
|
|
214
|
+
registered: number;
|
|
215
|
+
/** @description Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit. */
|
|
216
|
+
limit?: number;
|
|
217
|
+
/** @description True when `limit` is present and `registered` exceeds it. */
|
|
218
|
+
overLimit: boolean;
|
|
219
|
+
};
|
|
220
|
+
};
|
|
82
221
|
/** @description Extension points; shape owned by the provider. */
|
|
83
222
|
extensions?: {
|
|
84
223
|
[key: string]: unknown;
|
|
85
224
|
};
|
|
86
|
-
/** @description Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. */
|
|
225
|
+
/** @description Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{machineId}` placeholders. */
|
|
87
226
|
capabilities?: {
|
|
88
227
|
/** @description Feature name, for example `persist-connection`. */
|
|
89
228
|
feature: string;
|
|
@@ -116,6 +255,168 @@ export interface components {
|
|
|
116
255
|
/** @description True when the caller is a live member of the organization. */
|
|
117
256
|
bound: boolean;
|
|
118
257
|
};
|
|
258
|
+
/** @description Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it. */
|
|
259
|
+
ClientName: string;
|
|
260
|
+
/** @description Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`. */
|
|
261
|
+
ClientCompatibility: {
|
|
262
|
+
/** @description Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it. */
|
|
263
|
+
clientName: string;
|
|
264
|
+
/** @description The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`. */
|
|
265
|
+
clientVersion: string;
|
|
266
|
+
/** @description Oldest client version the provider accepts for this client. Absent when the provider sets no minimum. */
|
|
267
|
+
minimumVersion?: string;
|
|
268
|
+
/** @description True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum. */
|
|
269
|
+
compatible: boolean;
|
|
270
|
+
/** @description Where the client can get an update, when the provider knows one. */
|
|
271
|
+
upgradeUrl?: string;
|
|
272
|
+
};
|
|
273
|
+
/** @description Body of a 426 answer: a MeshKit error sentence plus the client's compatibility, so the client can show the minimum and where to update. */
|
|
274
|
+
ClientUpgradeRequiredError: {
|
|
275
|
+
/** @description The sentence the caller is shown. */
|
|
276
|
+
error: string;
|
|
277
|
+
/** @description MeshKit error code allocated by the emitting service; not a stable part of this contract. */
|
|
278
|
+
code?: string;
|
|
279
|
+
/** @description Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`. */
|
|
280
|
+
compatibility: {
|
|
281
|
+
/** @description Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it. */
|
|
282
|
+
clientName: string;
|
|
283
|
+
/** @description The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`. */
|
|
284
|
+
clientVersion: string;
|
|
285
|
+
/** @description Oldest client version the provider accepts for this client. Absent when the provider sets no minimum. */
|
|
286
|
+
minimumVersion?: string;
|
|
287
|
+
/** @description True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum. */
|
|
288
|
+
compatible: boolean;
|
|
289
|
+
/** @description Where the client can get an update, when the provider knows one. */
|
|
290
|
+
upgradeUrl?: string;
|
|
291
|
+
};
|
|
292
|
+
};
|
|
293
|
+
/** @description Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead. */
|
|
294
|
+
ProviderDeviceUsage: {
|
|
295
|
+
/** @description Live `desktop` connections registered in the organization. */
|
|
296
|
+
registered: number;
|
|
297
|
+
/** @description Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit. */
|
|
298
|
+
limit?: number;
|
|
299
|
+
/** @description True when `limit` is present and `registered` exceeds it. */
|
|
300
|
+
overLimit: boolean;
|
|
301
|
+
};
|
|
302
|
+
/** @description The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request. */
|
|
303
|
+
ProviderSession: {
|
|
304
|
+
/**
|
|
305
|
+
* Format: uuid
|
|
306
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
307
|
+
*/
|
|
308
|
+
userId: string;
|
|
309
|
+
/** @description The caller's provider-wide role names. */
|
|
310
|
+
providerRoles: string[];
|
|
311
|
+
/** @description The caller's role names in the organization. */
|
|
312
|
+
organizationRoles?: string[];
|
|
313
|
+
/** @description The plan of the organization's active subscription, when it has one. */
|
|
314
|
+
plan?: {
|
|
315
|
+
/**
|
|
316
|
+
* Format: uuid
|
|
317
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
318
|
+
*/
|
|
319
|
+
id: string;
|
|
320
|
+
/**
|
|
321
|
+
* @description Display name of the plan.
|
|
322
|
+
* @enum {string}
|
|
323
|
+
*/
|
|
324
|
+
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
325
|
+
/**
|
|
326
|
+
* @description Billing cadence for the plan (monthly, annually, or none).
|
|
327
|
+
* @enum {string}
|
|
328
|
+
*/
|
|
329
|
+
cadence: "none" | "monthly" | "annually";
|
|
330
|
+
/**
|
|
331
|
+
* @description Unit of consumption this plan charges against (e.g. user).
|
|
332
|
+
* @enum {string}
|
|
333
|
+
*/
|
|
334
|
+
unit: "user" | "free";
|
|
335
|
+
/** @description Minimum number of units required for the plan. */
|
|
336
|
+
minimumUnits: number;
|
|
337
|
+
/** @description Price per unit of the plan. */
|
|
338
|
+
pricePerUnit: number;
|
|
339
|
+
/**
|
|
340
|
+
* @description Currency in which the plan is priced.
|
|
341
|
+
* @enum {string}
|
|
342
|
+
*/
|
|
343
|
+
currency: "usd";
|
|
344
|
+
};
|
|
345
|
+
/** @description The features the organization's active subscriptions entitle it to. */
|
|
346
|
+
entitlements?: {
|
|
347
|
+
/**
|
|
348
|
+
* Format: uuid
|
|
349
|
+
* @description Unique identifier for the feature.
|
|
350
|
+
*/
|
|
351
|
+
id: string;
|
|
352
|
+
/**
|
|
353
|
+
* Format: uuid
|
|
354
|
+
* @description Identifier of the plan granting this feature.
|
|
355
|
+
*/
|
|
356
|
+
plan_id: string;
|
|
357
|
+
/** @description The plan granting this feature. Populated only when the association is explicitly loaded. */
|
|
358
|
+
plan?: {
|
|
359
|
+
/**
|
|
360
|
+
* Format: uuid
|
|
361
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
362
|
+
*/
|
|
363
|
+
id: string;
|
|
364
|
+
/**
|
|
365
|
+
* @description Display name of the plan.
|
|
366
|
+
* @enum {string}
|
|
367
|
+
*/
|
|
368
|
+
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
369
|
+
/**
|
|
370
|
+
* @description Billing cadence for the plan (monthly, annually, or none).
|
|
371
|
+
* @enum {string}
|
|
372
|
+
*/
|
|
373
|
+
cadence: "none" | "monthly" | "annually";
|
|
374
|
+
/**
|
|
375
|
+
* @description Unit of consumption this plan charges against (e.g. user).
|
|
376
|
+
* @enum {string}
|
|
377
|
+
*/
|
|
378
|
+
unit: "user" | "free";
|
|
379
|
+
/** @description Minimum number of units required for the plan. */
|
|
380
|
+
minimumUnits: number;
|
|
381
|
+
/** @description Price per unit of the plan. */
|
|
382
|
+
pricePerUnit: number;
|
|
383
|
+
/**
|
|
384
|
+
* @description Currency in which the plan is priced.
|
|
385
|
+
* @enum {string}
|
|
386
|
+
*/
|
|
387
|
+
currency: "usd";
|
|
388
|
+
};
|
|
389
|
+
/**
|
|
390
|
+
* @description Name of the entitled feature.
|
|
391
|
+
* @enum {string}
|
|
392
|
+
*/
|
|
393
|
+
name: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign" | "BlowhornProfiles" | "BlowhornBrowserAutomation" | "BlowhornScheduler" | "BlowhornDevicesPerSeat" | "BlowhornPlatformLinkedIn" | "BlowhornPlatformX" | "BlowhornPlatformReddit" | "BlowhornPlatformHackerNews" | "BlowhornPlatformSlack" | "BlowhornPlatformBluesky" | "BlowhornPlatformGitHub" | "BlowhornPlatformBlog";
|
|
394
|
+
/**
|
|
395
|
+
* Format: double
|
|
396
|
+
* @description Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.
|
|
397
|
+
*/
|
|
398
|
+
quantity: number;
|
|
399
|
+
/**
|
|
400
|
+
* Format: date-time
|
|
401
|
+
* @description Timestamp when the resource was created.
|
|
402
|
+
*/
|
|
403
|
+
created_at: string;
|
|
404
|
+
/**
|
|
405
|
+
* Format: date-time
|
|
406
|
+
* @description Timestamp when the resource was updated.
|
|
407
|
+
*/
|
|
408
|
+
updated_at: string;
|
|
409
|
+
}[];
|
|
410
|
+
/** @description Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead. */
|
|
411
|
+
deviceUsage?: {
|
|
412
|
+
/** @description Live `desktop` connections registered in the organization. */
|
|
413
|
+
registered: number;
|
|
414
|
+
/** @description Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit. */
|
|
415
|
+
limit?: number;
|
|
416
|
+
/** @description True when `limit` is present and `registered` exceeds it. */
|
|
417
|
+
overLimit: boolean;
|
|
418
|
+
};
|
|
419
|
+
};
|
|
119
420
|
};
|
|
120
421
|
responses: {
|
|
121
422
|
/** @description Internal server error */
|
|
@@ -127,10 +428,39 @@ export interface components {
|
|
|
127
428
|
"text/plain": string;
|
|
128
429
|
};
|
|
129
430
|
};
|
|
431
|
+
/** @description The client's version is below the provider's minimum for that client. The client must update before it can register or keep a connection alive; the body names the minimum and where to get an update. */
|
|
432
|
+
ClientUpgradeRequired: {
|
|
433
|
+
headers: {
|
|
434
|
+
[name: string]: unknown;
|
|
435
|
+
};
|
|
436
|
+
content: {
|
|
437
|
+
"application/json": {
|
|
438
|
+
/** @description The sentence the caller is shown. */
|
|
439
|
+
error: string;
|
|
440
|
+
/** @description MeshKit error code allocated by the emitting service; not a stable part of this contract. */
|
|
441
|
+
code?: string;
|
|
442
|
+
/** @description Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`. */
|
|
443
|
+
compatibility: {
|
|
444
|
+
/** @description Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it. */
|
|
445
|
+
clientName: string;
|
|
446
|
+
/** @description The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`. */
|
|
447
|
+
clientVersion: string;
|
|
448
|
+
/** @description Oldest client version the provider accepts for this client. Absent when the provider sets no minimum. */
|
|
449
|
+
minimumVersion?: string;
|
|
450
|
+
/** @description True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum. */
|
|
451
|
+
compatible: boolean;
|
|
452
|
+
/** @description Where the client can get an update, when the provider knows one. */
|
|
453
|
+
upgradeUrl?: string;
|
|
454
|
+
};
|
|
455
|
+
};
|
|
456
|
+
};
|
|
457
|
+
};
|
|
130
458
|
};
|
|
131
459
|
parameters: {
|
|
132
460
|
/** @description Version of the requesting client, for example `v0.8.0`. */
|
|
133
461
|
version: string;
|
|
462
|
+
/** @description Identifier of the requesting client application, for example the product name of a desktop app. When present, the document carries `compatibility` for this client at the `{version}` path parameter. */
|
|
463
|
+
client: string;
|
|
134
464
|
/** @description Organization whose membership the caller wants reported. */
|
|
135
465
|
currentOrgId: string;
|
|
136
466
|
};
|
|
@@ -143,6 +473,8 @@ export interface operations {
|
|
|
143
473
|
getProviderCapabilities: {
|
|
144
474
|
parameters: {
|
|
145
475
|
query?: {
|
|
476
|
+
/** @description Identifier of the requesting client application, for example the product name of a desktop app. When present, the document carries `compatibility` for this client at the `{version}` path parameter. */
|
|
477
|
+
client?: string;
|
|
146
478
|
/** @description Operating system of the client, used to select packages. */
|
|
147
479
|
os?: string;
|
|
148
480
|
};
|
|
@@ -202,11 +534,142 @@ export interface operations {
|
|
|
202
534
|
/** @description True when the caller is a live member of the organization. */
|
|
203
535
|
bound: boolean;
|
|
204
536
|
};
|
|
537
|
+
/** @description Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`. */
|
|
538
|
+
compatibility?: {
|
|
539
|
+
/** @description Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it. */
|
|
540
|
+
clientName: string;
|
|
541
|
+
/** @description The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`. */
|
|
542
|
+
clientVersion: string;
|
|
543
|
+
/** @description Oldest client version the provider accepts for this client. Absent when the provider sets no minimum. */
|
|
544
|
+
minimumVersion?: string;
|
|
545
|
+
/** @description True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum. */
|
|
546
|
+
compatible: boolean;
|
|
547
|
+
/** @description Where the client can get an update, when the provider knows one. */
|
|
548
|
+
upgradeUrl?: string;
|
|
549
|
+
};
|
|
550
|
+
/** @description The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request. */
|
|
551
|
+
session?: {
|
|
552
|
+
/**
|
|
553
|
+
* Format: uuid
|
|
554
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
555
|
+
*/
|
|
556
|
+
userId: string;
|
|
557
|
+
/** @description The caller's provider-wide role names. */
|
|
558
|
+
providerRoles: string[];
|
|
559
|
+
/** @description The caller's role names in the organization. */
|
|
560
|
+
organizationRoles?: string[];
|
|
561
|
+
/** @description The plan of the organization's active subscription, when it has one. */
|
|
562
|
+
plan?: {
|
|
563
|
+
/**
|
|
564
|
+
* Format: uuid
|
|
565
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
566
|
+
*/
|
|
567
|
+
id: string;
|
|
568
|
+
/**
|
|
569
|
+
* @description Display name of the plan.
|
|
570
|
+
* @enum {string}
|
|
571
|
+
*/
|
|
572
|
+
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
573
|
+
/**
|
|
574
|
+
* @description Billing cadence for the plan (monthly, annually, or none).
|
|
575
|
+
* @enum {string}
|
|
576
|
+
*/
|
|
577
|
+
cadence: "none" | "monthly" | "annually";
|
|
578
|
+
/**
|
|
579
|
+
* @description Unit of consumption this plan charges against (e.g. user).
|
|
580
|
+
* @enum {string}
|
|
581
|
+
*/
|
|
582
|
+
unit: "user" | "free";
|
|
583
|
+
/** @description Minimum number of units required for the plan. */
|
|
584
|
+
minimumUnits: number;
|
|
585
|
+
/** @description Price per unit of the plan. */
|
|
586
|
+
pricePerUnit: number;
|
|
587
|
+
/**
|
|
588
|
+
* @description Currency in which the plan is priced.
|
|
589
|
+
* @enum {string}
|
|
590
|
+
*/
|
|
591
|
+
currency: "usd";
|
|
592
|
+
};
|
|
593
|
+
/** @description The features the organization's active subscriptions entitle it to. */
|
|
594
|
+
entitlements?: {
|
|
595
|
+
/**
|
|
596
|
+
* Format: uuid
|
|
597
|
+
* @description Unique identifier for the feature.
|
|
598
|
+
*/
|
|
599
|
+
id: string;
|
|
600
|
+
/**
|
|
601
|
+
* Format: uuid
|
|
602
|
+
* @description Identifier of the plan granting this feature.
|
|
603
|
+
*/
|
|
604
|
+
plan_id: string;
|
|
605
|
+
/** @description The plan granting this feature. Populated only when the association is explicitly loaded. */
|
|
606
|
+
plan?: {
|
|
607
|
+
/**
|
|
608
|
+
* Format: uuid
|
|
609
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
610
|
+
*/
|
|
611
|
+
id: string;
|
|
612
|
+
/**
|
|
613
|
+
* @description Display name of the plan.
|
|
614
|
+
* @enum {string}
|
|
615
|
+
*/
|
|
616
|
+
name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
|
|
617
|
+
/**
|
|
618
|
+
* @description Billing cadence for the plan (monthly, annually, or none).
|
|
619
|
+
* @enum {string}
|
|
620
|
+
*/
|
|
621
|
+
cadence: "none" | "monthly" | "annually";
|
|
622
|
+
/**
|
|
623
|
+
* @description Unit of consumption this plan charges against (e.g. user).
|
|
624
|
+
* @enum {string}
|
|
625
|
+
*/
|
|
626
|
+
unit: "user" | "free";
|
|
627
|
+
/** @description Minimum number of units required for the plan. */
|
|
628
|
+
minimumUnits: number;
|
|
629
|
+
/** @description Price per unit of the plan. */
|
|
630
|
+
pricePerUnit: number;
|
|
631
|
+
/**
|
|
632
|
+
* @description Currency in which the plan is priced.
|
|
633
|
+
* @enum {string}
|
|
634
|
+
*/
|
|
635
|
+
currency: "usd";
|
|
636
|
+
};
|
|
637
|
+
/**
|
|
638
|
+
* @description Name of the entitled feature.
|
|
639
|
+
* @enum {string}
|
|
640
|
+
*/
|
|
641
|
+
name: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign" | "BlowhornProfiles" | "BlowhornBrowserAutomation" | "BlowhornScheduler" | "BlowhornDevicesPerSeat" | "BlowhornPlatformLinkedIn" | "BlowhornPlatformX" | "BlowhornPlatformReddit" | "BlowhornPlatformHackerNews" | "BlowhornPlatformSlack" | "BlowhornPlatformBluesky" | "BlowhornPlatformGitHub" | "BlowhornPlatformBlog";
|
|
642
|
+
/**
|
|
643
|
+
* Format: double
|
|
644
|
+
* @description Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.
|
|
645
|
+
*/
|
|
646
|
+
quantity: number;
|
|
647
|
+
/**
|
|
648
|
+
* Format: date-time
|
|
649
|
+
* @description Timestamp when the resource was created.
|
|
650
|
+
*/
|
|
651
|
+
created_at: string;
|
|
652
|
+
/**
|
|
653
|
+
* Format: date-time
|
|
654
|
+
* @description Timestamp when the resource was updated.
|
|
655
|
+
*/
|
|
656
|
+
updated_at: string;
|
|
657
|
+
}[];
|
|
658
|
+
/** @description Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead. */
|
|
659
|
+
deviceUsage?: {
|
|
660
|
+
/** @description Live `desktop` connections registered in the organization. */
|
|
661
|
+
registered: number;
|
|
662
|
+
/** @description Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit. */
|
|
663
|
+
limit?: number;
|
|
664
|
+
/** @description True when `limit` is present and `registered` exceeds it. */
|
|
665
|
+
overLimit: boolean;
|
|
666
|
+
};
|
|
667
|
+
};
|
|
205
668
|
/** @description Extension points; shape owned by the provider. */
|
|
206
669
|
extensions?: {
|
|
207
670
|
[key: string]: unknown;
|
|
208
671
|
};
|
|
209
|
-
/** @description Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. */
|
|
672
|
+
/** @description Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{machineId}` placeholders. */
|
|
210
673
|
capabilities?: {
|
|
211
674
|
/** @description Feature name, for example `persist-connection`. */
|
|
212
675
|
feature: string;
|