@meshery/schemas 1.3.76 → 1.3.78
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 +242 -1358
- package/dist/cloudApi.d.ts +242 -1358
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtp.d.ts +3 -3
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.js +1 -1
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.mjs +1 -1
- package/dist/constructs/v1beta1/registry/Registry.d.ts +9 -9
- package/dist/constructs/v1beta1/registry/RegistrySchema.js +3 -3
- package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +3 -3
- package/dist/constructs/v1beta2/organization/Organization.d.ts +334 -2
- package/dist/constructs/v1beta2/organization/OrganizationSchema.js +1 -1
- package/dist/constructs/v1beta2/organization/OrganizationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/connection/Connection.d.ts +21 -21
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/content_piece/ContentPiece.d.ts +77 -6
- package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.js +16 -13
- package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.mjs +16 -13
- package/dist/constructs/v1beta3/environment/Environment.d.ts +62 -19
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +334 -1038
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +12 -36
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +12 -36
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +3 -3
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +1 -1
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +1 -1
- package/dist/index.d.mts +224 -0
- package/dist/index.d.ts +224 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/mesheryApi.d.mts +137 -36
- package/dist/mesheryApi.d.ts +137 -36
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/dist/permissions.d.mts +57 -1
- package/dist/permissions.d.ts +57 -1
- package/dist/permissions.js +1 -1
- package/dist/permissions.mjs +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -32115,6 +32115,160 @@ interface components$6 {
|
|
|
32115
32115
|
* @default true
|
|
32116
32116
|
*/
|
|
32117
32117
|
showAuthCarousel: boolean;
|
|
32118
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
32119
|
+
schedulePause?: {
|
|
32120
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32121
|
+
paused?: boolean;
|
|
32122
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32123
|
+
reason?: string;
|
|
32124
|
+
/**
|
|
32125
|
+
* Format: date-time
|
|
32126
|
+
* @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
|
|
32127
|
+
*/
|
|
32128
|
+
pausedAt?: string;
|
|
32129
|
+
/** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
32130
|
+
pausedBy?: string;
|
|
32131
|
+
};
|
|
32132
|
+
};
|
|
32133
|
+
/** @description Organization-wide pause of scheduled work, stored in organization.metadata.preferences. While `paused` is true no schedule in the organization is claimed unless the claim carries the operator override `ignorePause` (v1beta3 schedule). Set or lift it by updating the organization's preferences; there is no pause route. Unset is treated as not paused. Lifting the pause (`paused` false) clears `reason`, `pausedAt` and `pausedBy` on the server, so a stored `paused` false never carries a stale pause time or identity. */
|
|
32134
|
+
SchedulePause: {
|
|
32135
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32136
|
+
paused?: boolean;
|
|
32137
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32138
|
+
reason?: string;
|
|
32139
|
+
/**
|
|
32140
|
+
* Format: date-time
|
|
32141
|
+
* @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
|
|
32142
|
+
*/
|
|
32143
|
+
pausedAt?: string;
|
|
32144
|
+
/** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
32145
|
+
pausedBy?: string;
|
|
32146
|
+
};
|
|
32147
|
+
/** @description Client-settable organization pause. Carries only `paused` and `reason`; `pausedAt` and `pausedBy` are recorded by the server and refused here. `paused` is required whenever `schedulePause` is sent, so a write can never lift the pause by omission. */
|
|
32148
|
+
SchedulePausePayload: {
|
|
32149
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32150
|
+
paused: boolean;
|
|
32151
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32152
|
+
reason?: string;
|
|
32153
|
+
};
|
|
32154
|
+
/** @description Client-settable organization preferences. Identical to Preferences except that schedulePause is SchedulePausePayload. */
|
|
32155
|
+
PreferencesPayload: {
|
|
32156
|
+
/** @description UI theme configured for an organization. */
|
|
32157
|
+
theme: {
|
|
32158
|
+
/**
|
|
32159
|
+
* Format: uuid
|
|
32160
|
+
* @description Theme identifier.
|
|
32161
|
+
*/
|
|
32162
|
+
id: string;
|
|
32163
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
32164
|
+
logo: {
|
|
32165
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32166
|
+
desktopView: {
|
|
32167
|
+
/** @description SVG markup for the asset. */
|
|
32168
|
+
svg: string;
|
|
32169
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32170
|
+
location: string;
|
|
32171
|
+
};
|
|
32172
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32173
|
+
mobileView: {
|
|
32174
|
+
/** @description SVG markup for the asset. */
|
|
32175
|
+
svg: string;
|
|
32176
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32177
|
+
location: string;
|
|
32178
|
+
};
|
|
32179
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32180
|
+
darkDesktopView: {
|
|
32181
|
+
/** @description SVG markup for the asset. */
|
|
32182
|
+
svg: string;
|
|
32183
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32184
|
+
location: string;
|
|
32185
|
+
};
|
|
32186
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32187
|
+
darkMobileView: {
|
|
32188
|
+
/** @description SVG markup for the asset. */
|
|
32189
|
+
svg: string;
|
|
32190
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32191
|
+
location: string;
|
|
32192
|
+
};
|
|
32193
|
+
};
|
|
32194
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
32195
|
+
vars?: {
|
|
32196
|
+
[key: string]: unknown;
|
|
32197
|
+
};
|
|
32198
|
+
};
|
|
32199
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
32200
|
+
dashboard: {
|
|
32201
|
+
[key: string]: unknown;
|
|
32202
|
+
};
|
|
32203
|
+
/** @description Optional per-organization branding overrides for the auth pages: carousel slides and FAQ entries. Stored as JSON inside organization.metadata.preferences, so no dedicated column backs it. Empty or omitted fields fall back to the platform defaults. */
|
|
32204
|
+
authBranding?: {
|
|
32205
|
+
/** @description Ordered slides rendered in the auth-page feature carousel. */
|
|
32206
|
+
carousel?: {
|
|
32207
|
+
/**
|
|
32208
|
+
* Format: uri
|
|
32209
|
+
* @description URL of the slide image asset.
|
|
32210
|
+
*/
|
|
32211
|
+
imageUrl: string;
|
|
32212
|
+
/** @description Slide title. */
|
|
32213
|
+
title: string;
|
|
32214
|
+
/** @description Slide description text. */
|
|
32215
|
+
description: string;
|
|
32216
|
+
}[];
|
|
32217
|
+
/** @description FAQ entries rendered on the auth pages. */
|
|
32218
|
+
faqs?: {
|
|
32219
|
+
/** @description The question text. */
|
|
32220
|
+
question: string;
|
|
32221
|
+
/** @description The answer text. */
|
|
32222
|
+
answer: string;
|
|
32223
|
+
}[];
|
|
32224
|
+
};
|
|
32225
|
+
/** @description Per-organization overrides for the legal, support, and social links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links; social carries the organization's brand profiles. Empty or omitted fields fall back to the platform defaults. */
|
|
32226
|
+
links?: {
|
|
32227
|
+
/**
|
|
32228
|
+
* Format: uri
|
|
32229
|
+
* @description URL of the organization's Terms of Service page.
|
|
32230
|
+
*/
|
|
32231
|
+
termsOfService?: string;
|
|
32232
|
+
/**
|
|
32233
|
+
* Format: uri
|
|
32234
|
+
* @description URL of the organization's Privacy Policy page.
|
|
32235
|
+
*/
|
|
32236
|
+
privacy?: string;
|
|
32237
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
32238
|
+
support?: {
|
|
32239
|
+
[key: string]: string;
|
|
32240
|
+
};
|
|
32241
|
+
/** @description The organization's social brand profiles. Deliberately a sibling of support rather than an entry in it: support renders as support contacts on the auth and error pages, where a brand profile does not belong. Each platform is a named, individually validated URL so consumers can render the matching platform icon. Empty or omitted fields fall back to the platform defaults. */
|
|
32242
|
+
social?: {
|
|
32243
|
+
/**
|
|
32244
|
+
* Format: uri
|
|
32245
|
+
* @description URL of the organization's LinkedIn profile.
|
|
32246
|
+
*/
|
|
32247
|
+
linkedin?: string;
|
|
32248
|
+
/**
|
|
32249
|
+
* Format: uri
|
|
32250
|
+
* @description URL of the organization's X (formerly Twitter) profile.
|
|
32251
|
+
*/
|
|
32252
|
+
x?: string;
|
|
32253
|
+
/**
|
|
32254
|
+
* Format: uri
|
|
32255
|
+
* @description URL of the organization's YouTube channel.
|
|
32256
|
+
*/
|
|
32257
|
+
youtube?: string;
|
|
32258
|
+
};
|
|
32259
|
+
};
|
|
32260
|
+
/**
|
|
32261
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
32262
|
+
* @default true
|
|
32263
|
+
*/
|
|
32264
|
+
showAuthCarousel: boolean;
|
|
32265
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
32266
|
+
schedulePause?: {
|
|
32267
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32268
|
+
paused: boolean;
|
|
32269
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32270
|
+
reason?: string;
|
|
32271
|
+
};
|
|
32118
32272
|
};
|
|
32119
32273
|
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
32120
32274
|
OrgMetadata: {
|
|
@@ -32229,6 +32383,20 @@ interface components$6 {
|
|
|
32229
32383
|
* @default true
|
|
32230
32384
|
*/
|
|
32231
32385
|
showAuthCarousel: boolean;
|
|
32386
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
32387
|
+
schedulePause?: {
|
|
32388
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32389
|
+
paused?: boolean;
|
|
32390
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32391
|
+
reason?: string;
|
|
32392
|
+
/**
|
|
32393
|
+
* Format: date-time
|
|
32394
|
+
* @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
|
|
32395
|
+
*/
|
|
32396
|
+
pausedAt?: string;
|
|
32397
|
+
/** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
32398
|
+
pausedBy?: string;
|
|
32399
|
+
};
|
|
32232
32400
|
};
|
|
32233
32401
|
};
|
|
32234
32402
|
/** @description An organization in Meshery Cloud. Organizations are the top-level tenancy boundary and own teams, workspaces, environments, designs, and other resources. Learn more at https://docs.meshery.io/concepts/logical/organizations */
|
|
@@ -32403,6 +32571,20 @@ interface components$6 {
|
|
|
32403
32571
|
* @default true
|
|
32404
32572
|
*/
|
|
32405
32573
|
showAuthCarousel: boolean;
|
|
32574
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
32575
|
+
schedulePause?: {
|
|
32576
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32577
|
+
paused?: boolean;
|
|
32578
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32579
|
+
reason?: string;
|
|
32580
|
+
/**
|
|
32581
|
+
* Format: date-time
|
|
32582
|
+
* @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
|
|
32583
|
+
*/
|
|
32584
|
+
pausedAt?: string;
|
|
32585
|
+
/** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
32586
|
+
pausedBy?: string;
|
|
32587
|
+
};
|
|
32406
32588
|
};
|
|
32407
32589
|
};
|
|
32408
32590
|
/**
|
|
@@ -32561,6 +32743,20 @@ interface components$6 {
|
|
|
32561
32743
|
* @default true
|
|
32562
32744
|
*/
|
|
32563
32745
|
showAuthCarousel: boolean;
|
|
32746
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
32747
|
+
schedulePause?: {
|
|
32748
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32749
|
+
paused?: boolean;
|
|
32750
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32751
|
+
reason?: string;
|
|
32752
|
+
/**
|
|
32753
|
+
* Format: date-time
|
|
32754
|
+
* @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
|
|
32755
|
+
*/
|
|
32756
|
+
pausedAt?: string;
|
|
32757
|
+
/** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
32758
|
+
pausedBy?: string;
|
|
32759
|
+
};
|
|
32564
32760
|
};
|
|
32565
32761
|
};
|
|
32566
32762
|
/**
|
|
@@ -32720,6 +32916,20 @@ interface components$6 {
|
|
|
32720
32916
|
* @default true
|
|
32721
32917
|
*/
|
|
32722
32918
|
showAuthCarousel: boolean;
|
|
32919
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
32920
|
+
schedulePause?: {
|
|
32921
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32922
|
+
paused?: boolean;
|
|
32923
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32924
|
+
reason?: string;
|
|
32925
|
+
/**
|
|
32926
|
+
* Format: date-time
|
|
32927
|
+
* @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
|
|
32928
|
+
*/
|
|
32929
|
+
pausedAt?: string;
|
|
32930
|
+
/** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
32931
|
+
pausedBy?: string;
|
|
32932
|
+
};
|
|
32723
32933
|
};
|
|
32724
32934
|
};
|
|
32725
32935
|
/**
|
|
@@ -32933,6 +33143,13 @@ interface components$6 {
|
|
|
32933
33143
|
* @default true
|
|
32934
33144
|
*/
|
|
32935
33145
|
showAuthCarousel: boolean;
|
|
33146
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
33147
|
+
schedulePause?: {
|
|
33148
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
33149
|
+
paused: boolean;
|
|
33150
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
33151
|
+
reason?: string;
|
|
33152
|
+
};
|
|
32936
33153
|
};
|
|
32937
33154
|
};
|
|
32938
33155
|
/** @description Team listing record used in team listings associated with an organization. */
|
|
@@ -33362,6 +33579,13 @@ interface components$6 {
|
|
|
33362
33579
|
* @default true
|
|
33363
33580
|
*/
|
|
33364
33581
|
showAuthCarousel?: boolean;
|
|
33582
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
33583
|
+
schedulePause?: {
|
|
33584
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
33585
|
+
paused: boolean;
|
|
33586
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
33587
|
+
reason?: string;
|
|
33588
|
+
};
|
|
33365
33589
|
};
|
|
33366
33590
|
};
|
|
33367
33591
|
};
|
package/dist/index.d.ts
CHANGED
|
@@ -32115,6 +32115,160 @@ interface components$6 {
|
|
|
32115
32115
|
* @default true
|
|
32116
32116
|
*/
|
|
32117
32117
|
showAuthCarousel: boolean;
|
|
32118
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
32119
|
+
schedulePause?: {
|
|
32120
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32121
|
+
paused?: boolean;
|
|
32122
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32123
|
+
reason?: string;
|
|
32124
|
+
/**
|
|
32125
|
+
* Format: date-time
|
|
32126
|
+
* @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
|
|
32127
|
+
*/
|
|
32128
|
+
pausedAt?: string;
|
|
32129
|
+
/** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
32130
|
+
pausedBy?: string;
|
|
32131
|
+
};
|
|
32132
|
+
};
|
|
32133
|
+
/** @description Organization-wide pause of scheduled work, stored in organization.metadata.preferences. While `paused` is true no schedule in the organization is claimed unless the claim carries the operator override `ignorePause` (v1beta3 schedule). Set or lift it by updating the organization's preferences; there is no pause route. Unset is treated as not paused. Lifting the pause (`paused` false) clears `reason`, `pausedAt` and `pausedBy` on the server, so a stored `paused` false never carries a stale pause time or identity. */
|
|
32134
|
+
SchedulePause: {
|
|
32135
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32136
|
+
paused?: boolean;
|
|
32137
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32138
|
+
reason?: string;
|
|
32139
|
+
/**
|
|
32140
|
+
* Format: date-time
|
|
32141
|
+
* @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
|
|
32142
|
+
*/
|
|
32143
|
+
pausedAt?: string;
|
|
32144
|
+
/** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
32145
|
+
pausedBy?: string;
|
|
32146
|
+
};
|
|
32147
|
+
/** @description Client-settable organization pause. Carries only `paused` and `reason`; `pausedAt` and `pausedBy` are recorded by the server and refused here. `paused` is required whenever `schedulePause` is sent, so a write can never lift the pause by omission. */
|
|
32148
|
+
SchedulePausePayload: {
|
|
32149
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32150
|
+
paused: boolean;
|
|
32151
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32152
|
+
reason?: string;
|
|
32153
|
+
};
|
|
32154
|
+
/** @description Client-settable organization preferences. Identical to Preferences except that schedulePause is SchedulePausePayload. */
|
|
32155
|
+
PreferencesPayload: {
|
|
32156
|
+
/** @description UI theme configured for an organization. */
|
|
32157
|
+
theme: {
|
|
32158
|
+
/**
|
|
32159
|
+
* Format: uuid
|
|
32160
|
+
* @description Theme identifier.
|
|
32161
|
+
*/
|
|
32162
|
+
id: string;
|
|
32163
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
32164
|
+
logo: {
|
|
32165
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32166
|
+
desktopView: {
|
|
32167
|
+
/** @description SVG markup for the asset. */
|
|
32168
|
+
svg: string;
|
|
32169
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32170
|
+
location: string;
|
|
32171
|
+
};
|
|
32172
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32173
|
+
mobileView: {
|
|
32174
|
+
/** @description SVG markup for the asset. */
|
|
32175
|
+
svg: string;
|
|
32176
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32177
|
+
location: string;
|
|
32178
|
+
};
|
|
32179
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32180
|
+
darkDesktopView: {
|
|
32181
|
+
/** @description SVG markup for the asset. */
|
|
32182
|
+
svg: string;
|
|
32183
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32184
|
+
location: string;
|
|
32185
|
+
};
|
|
32186
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32187
|
+
darkMobileView: {
|
|
32188
|
+
/** @description SVG markup for the asset. */
|
|
32189
|
+
svg: string;
|
|
32190
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32191
|
+
location: string;
|
|
32192
|
+
};
|
|
32193
|
+
};
|
|
32194
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
32195
|
+
vars?: {
|
|
32196
|
+
[key: string]: unknown;
|
|
32197
|
+
};
|
|
32198
|
+
};
|
|
32199
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
32200
|
+
dashboard: {
|
|
32201
|
+
[key: string]: unknown;
|
|
32202
|
+
};
|
|
32203
|
+
/** @description Optional per-organization branding overrides for the auth pages: carousel slides and FAQ entries. Stored as JSON inside organization.metadata.preferences, so no dedicated column backs it. Empty or omitted fields fall back to the platform defaults. */
|
|
32204
|
+
authBranding?: {
|
|
32205
|
+
/** @description Ordered slides rendered in the auth-page feature carousel. */
|
|
32206
|
+
carousel?: {
|
|
32207
|
+
/**
|
|
32208
|
+
* Format: uri
|
|
32209
|
+
* @description URL of the slide image asset.
|
|
32210
|
+
*/
|
|
32211
|
+
imageUrl: string;
|
|
32212
|
+
/** @description Slide title. */
|
|
32213
|
+
title: string;
|
|
32214
|
+
/** @description Slide description text. */
|
|
32215
|
+
description: string;
|
|
32216
|
+
}[];
|
|
32217
|
+
/** @description FAQ entries rendered on the auth pages. */
|
|
32218
|
+
faqs?: {
|
|
32219
|
+
/** @description The question text. */
|
|
32220
|
+
question: string;
|
|
32221
|
+
/** @description The answer text. */
|
|
32222
|
+
answer: string;
|
|
32223
|
+
}[];
|
|
32224
|
+
};
|
|
32225
|
+
/** @description Per-organization overrides for the legal, support, and social links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links; social carries the organization's brand profiles. Empty or omitted fields fall back to the platform defaults. */
|
|
32226
|
+
links?: {
|
|
32227
|
+
/**
|
|
32228
|
+
* Format: uri
|
|
32229
|
+
* @description URL of the organization's Terms of Service page.
|
|
32230
|
+
*/
|
|
32231
|
+
termsOfService?: string;
|
|
32232
|
+
/**
|
|
32233
|
+
* Format: uri
|
|
32234
|
+
* @description URL of the organization's Privacy Policy page.
|
|
32235
|
+
*/
|
|
32236
|
+
privacy?: string;
|
|
32237
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
32238
|
+
support?: {
|
|
32239
|
+
[key: string]: string;
|
|
32240
|
+
};
|
|
32241
|
+
/** @description The organization's social brand profiles. Deliberately a sibling of support rather than an entry in it: support renders as support contacts on the auth and error pages, where a brand profile does not belong. Each platform is a named, individually validated URL so consumers can render the matching platform icon. Empty or omitted fields fall back to the platform defaults. */
|
|
32242
|
+
social?: {
|
|
32243
|
+
/**
|
|
32244
|
+
* Format: uri
|
|
32245
|
+
* @description URL of the organization's LinkedIn profile.
|
|
32246
|
+
*/
|
|
32247
|
+
linkedin?: string;
|
|
32248
|
+
/**
|
|
32249
|
+
* Format: uri
|
|
32250
|
+
* @description URL of the organization's X (formerly Twitter) profile.
|
|
32251
|
+
*/
|
|
32252
|
+
x?: string;
|
|
32253
|
+
/**
|
|
32254
|
+
* Format: uri
|
|
32255
|
+
* @description URL of the organization's YouTube channel.
|
|
32256
|
+
*/
|
|
32257
|
+
youtube?: string;
|
|
32258
|
+
};
|
|
32259
|
+
};
|
|
32260
|
+
/**
|
|
32261
|
+
* @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
|
|
32262
|
+
* @default true
|
|
32263
|
+
*/
|
|
32264
|
+
showAuthCarousel: boolean;
|
|
32265
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
32266
|
+
schedulePause?: {
|
|
32267
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32268
|
+
paused: boolean;
|
|
32269
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32270
|
+
reason?: string;
|
|
32271
|
+
};
|
|
32118
32272
|
};
|
|
32119
32273
|
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
32120
32274
|
OrgMetadata: {
|
|
@@ -32229,6 +32383,20 @@ interface components$6 {
|
|
|
32229
32383
|
* @default true
|
|
32230
32384
|
*/
|
|
32231
32385
|
showAuthCarousel: boolean;
|
|
32386
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
32387
|
+
schedulePause?: {
|
|
32388
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32389
|
+
paused?: boolean;
|
|
32390
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32391
|
+
reason?: string;
|
|
32392
|
+
/**
|
|
32393
|
+
* Format: date-time
|
|
32394
|
+
* @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
|
|
32395
|
+
*/
|
|
32396
|
+
pausedAt?: string;
|
|
32397
|
+
/** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
32398
|
+
pausedBy?: string;
|
|
32399
|
+
};
|
|
32232
32400
|
};
|
|
32233
32401
|
};
|
|
32234
32402
|
/** @description An organization in Meshery Cloud. Organizations are the top-level tenancy boundary and own teams, workspaces, environments, designs, and other resources. Learn more at https://docs.meshery.io/concepts/logical/organizations */
|
|
@@ -32403,6 +32571,20 @@ interface components$6 {
|
|
|
32403
32571
|
* @default true
|
|
32404
32572
|
*/
|
|
32405
32573
|
showAuthCarousel: boolean;
|
|
32574
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
32575
|
+
schedulePause?: {
|
|
32576
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32577
|
+
paused?: boolean;
|
|
32578
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32579
|
+
reason?: string;
|
|
32580
|
+
/**
|
|
32581
|
+
* Format: date-time
|
|
32582
|
+
* @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
|
|
32583
|
+
*/
|
|
32584
|
+
pausedAt?: string;
|
|
32585
|
+
/** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
32586
|
+
pausedBy?: string;
|
|
32587
|
+
};
|
|
32406
32588
|
};
|
|
32407
32589
|
};
|
|
32408
32590
|
/**
|
|
@@ -32561,6 +32743,20 @@ interface components$6 {
|
|
|
32561
32743
|
* @default true
|
|
32562
32744
|
*/
|
|
32563
32745
|
showAuthCarousel: boolean;
|
|
32746
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
32747
|
+
schedulePause?: {
|
|
32748
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32749
|
+
paused?: boolean;
|
|
32750
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32751
|
+
reason?: string;
|
|
32752
|
+
/**
|
|
32753
|
+
* Format: date-time
|
|
32754
|
+
* @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
|
|
32755
|
+
*/
|
|
32756
|
+
pausedAt?: string;
|
|
32757
|
+
/** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
32758
|
+
pausedBy?: string;
|
|
32759
|
+
};
|
|
32564
32760
|
};
|
|
32565
32761
|
};
|
|
32566
32762
|
/**
|
|
@@ -32720,6 +32916,20 @@ interface components$6 {
|
|
|
32720
32916
|
* @default true
|
|
32721
32917
|
*/
|
|
32722
32918
|
showAuthCarousel: boolean;
|
|
32919
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
32920
|
+
schedulePause?: {
|
|
32921
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32922
|
+
paused?: boolean;
|
|
32923
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32924
|
+
reason?: string;
|
|
32925
|
+
/**
|
|
32926
|
+
* Format: date-time
|
|
32927
|
+
* @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
|
|
32928
|
+
*/
|
|
32929
|
+
pausedAt?: string;
|
|
32930
|
+
/** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
32931
|
+
pausedBy?: string;
|
|
32932
|
+
};
|
|
32723
32933
|
};
|
|
32724
32934
|
};
|
|
32725
32935
|
/**
|
|
@@ -32933,6 +33143,13 @@ interface components$6 {
|
|
|
32933
33143
|
* @default true
|
|
32934
33144
|
*/
|
|
32935
33145
|
showAuthCarousel: boolean;
|
|
33146
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
33147
|
+
schedulePause?: {
|
|
33148
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
33149
|
+
paused: boolean;
|
|
33150
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
33151
|
+
reason?: string;
|
|
33152
|
+
};
|
|
32936
33153
|
};
|
|
32937
33154
|
};
|
|
32938
33155
|
/** @description Team listing record used in team listings associated with an organization. */
|
|
@@ -33362,6 +33579,13 @@ interface components$6 {
|
|
|
33362
33579
|
* @default true
|
|
33363
33580
|
*/
|
|
33364
33581
|
showAuthCarousel?: boolean;
|
|
33582
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
33583
|
+
schedulePause?: {
|
|
33584
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
33585
|
+
paused: boolean;
|
|
33586
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
33587
|
+
reason?: string;
|
|
33588
|
+
};
|
|
33365
33589
|
};
|
|
33366
33590
|
};
|
|
33367
33591
|
};
|