@meshery/schemas 1.3.81 → 1.3.82

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.
@@ -117,7 +117,11 @@ export interface paths {
117
117
  delete?: never;
118
118
  options?: never;
119
119
  head?: never;
120
- patch?: never;
120
+ /**
121
+ * Partially update organization preferences
122
+ * @description Merges the body into the organization's stored preferences. Every member of the body is optional: a member that is present replaces that member of the stored preferences as a whole, and a member that is omitted stays unchanged. An empty body changes nothing and returns the current preferences. Members may not be null. Authorization is the same as updating the organization (updateOrg) for every member, and changing `schedulePause` is additionally restricted to organization admins (otherwise 403, and nothing is written). Lifting the pause clears its reason and server-recorded fields exactly as updateOrg does. The optional `If-Match` header makes the write conditional on the entity tag the preferences carried when they were read (see the `ETag` header of getOrgPreferences and of this response): when it no longer matches, the request is refused with 412 and nothing is written. Without `If-Match` the write is unconditional.
123
+ */
124
+ patch: operations["patchOrgPreferences"];
121
125
  trace?: never;
122
126
  };
123
127
  "/api/identity/orgs/{orgId}/teams/{teamId}": {
@@ -648,6 +652,122 @@ export interface components {
648
652
  reason?: string;
649
653
  };
650
654
  };
655
+ /** @description Partial update of organization preferences (patchOrgPreferences). Every member is optional: a present member replaces that member of the stored preferences as a whole, and an omitted member stays unchanged. Members are those of PreferencesPayload, with the same schemas, and may not be null. */
656
+ PreferencesPatchPayload: {
657
+ /** @description UI theme configured for an organization. */
658
+ theme?: {
659
+ /**
660
+ * Format: uuid
661
+ * @description Theme identifier.
662
+ */
663
+ id: string;
664
+ /** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
665
+ logo: {
666
+ /** @description Image asset anchored to a named location within an organization theme. */
667
+ desktopView: {
668
+ /** @description SVG markup for the asset. */
669
+ svg: string;
670
+ /** @description Named location of the asset (e.g. header, footer). */
671
+ location: string;
672
+ };
673
+ /** @description Image asset anchored to a named location within an organization theme. */
674
+ mobileView: {
675
+ /** @description SVG markup for the asset. */
676
+ svg: string;
677
+ /** @description Named location of the asset (e.g. header, footer). */
678
+ location: string;
679
+ };
680
+ /** @description Image asset anchored to a named location within an organization theme. */
681
+ darkDesktopView: {
682
+ /** @description SVG markup for the asset. */
683
+ svg: string;
684
+ /** @description Named location of the asset (e.g. header, footer). */
685
+ location: string;
686
+ };
687
+ /** @description Image asset anchored to a named location within an organization theme. */
688
+ darkMobileView: {
689
+ /** @description SVG markup for the asset. */
690
+ svg: string;
691
+ /** @description Named location of the asset (e.g. header, footer). */
692
+ location: string;
693
+ };
694
+ };
695
+ /** @description Arbitrary theme variables keyed by name. */
696
+ vars?: {
697
+ [key: string]: unknown;
698
+ };
699
+ };
700
+ /** @description Preferences specific to dashboard behavior. */
701
+ dashboard?: {
702
+ [key: string]: unknown;
703
+ };
704
+ /** @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. */
705
+ authBranding?: {
706
+ /** @description Ordered slides rendered in the auth-page feature carousel. */
707
+ carousel?: {
708
+ /**
709
+ * Format: uri
710
+ * @description URL of the slide image asset.
711
+ */
712
+ imageUrl: string;
713
+ /** @description Slide title. */
714
+ title: string;
715
+ /** @description Slide description text. */
716
+ description: string;
717
+ }[];
718
+ /** @description FAQ entries rendered on the auth pages. */
719
+ faqs?: {
720
+ /** @description The question text. */
721
+ question: string;
722
+ /** @description The answer text. */
723
+ answer: string;
724
+ }[];
725
+ };
726
+ /** @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. */
727
+ links?: {
728
+ /**
729
+ * Format: uri
730
+ * @description URL of the organization's Terms of Service page.
731
+ */
732
+ termsOfService?: string;
733
+ /**
734
+ * Format: uri
735
+ * @description URL of the organization's Privacy Policy page.
736
+ */
737
+ privacy?: string;
738
+ /** @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. */
739
+ support?: {
740
+ [key: string]: string;
741
+ };
742
+ /** @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. */
743
+ social?: {
744
+ /**
745
+ * Format: uri
746
+ * @description URL of the organization's LinkedIn profile.
747
+ */
748
+ linkedin?: string;
749
+ /**
750
+ * Format: uri
751
+ * @description URL of the organization's X (formerly Twitter) profile.
752
+ */
753
+ x?: string;
754
+ /**
755
+ * Format: uri
756
+ * @description URL of the organization's YouTube channel.
757
+ */
758
+ youtube?: string;
759
+ };
760
+ };
761
+ /** @description Whether the feature carousel renders on the organization's auth pages. Omitted keeps the stored value. */
762
+ showAuthCarousel?: boolean;
763
+ /** @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. Omitted keeps the current pause unchanged; it does not lift the pause. */
764
+ schedulePause?: {
765
+ /** @description Whether every schedule in the organization is paused. */
766
+ paused: boolean;
767
+ /** @description Reason given for the pause. Cleared when the pause is lifted. */
768
+ reason?: string;
769
+ };
770
+ };
651
771
  /** @description Free-form metadata associated with an organization, including preferences. */
652
772
  OrgMetadata: {
653
773
  /** @description Organization-level user experience preferences. */
@@ -1830,6 +1950,8 @@ export interface components {
1830
1950
  order: string;
1831
1951
  /** @description Get all possible entries */
1832
1952
  all: boolean;
1953
+ /** @description Entity tag of the organization's preferences as last read, from the `ETag` header of getOrgPreferences or patchOrgPreferences. When present the write applies only if it still matches; otherwise 412. */
1954
+ ifMatch: string;
1833
1955
  };
1834
1956
  requestBodies: {
1835
1957
  /** @description Body for creating or updating an organization */
@@ -1969,7 +2091,10 @@ export interface components {
1969
2091
  };
1970
2092
  };
1971
2093
  };
1972
- headers: never;
2094
+ headers: {
2095
+ /** @description Strong entity tag of the organization's stored preferences. It changes whenever the preferences change; send it back as `If-Match` to make a patchOrgPreferences write conditional. */
2096
+ PreferencesETag: string;
2097
+ };
1973
2098
  pathItems: never;
1974
2099
  }
1975
2100
  export type $defs = Record<string, never>;
@@ -3813,6 +3938,8 @@ export interface operations {
3813
3938
  /** @description Organization metadata, including preferences */
3814
3939
  200: {
3815
3940
  headers: {
3941
+ /** @description Strong entity tag of the organization's stored preferences. It changes whenever the preferences change; send it back as `If-Match` to make a patchOrgPreferences write conditional. */
3942
+ ETag?: string;
3816
3943
  [name: string]: unknown;
3817
3944
  };
3818
3945
  content: {
@@ -3984,6 +4111,331 @@ export interface operations {
3984
4111
  };
3985
4112
  };
3986
4113
  };
4114
+ patchOrgPreferences: {
4115
+ parameters: {
4116
+ query?: never;
4117
+ header?: {
4118
+ /** @description Entity tag of the organization's preferences as last read, from the `ETag` header of getOrgPreferences or patchOrgPreferences. When present the write applies only if it still matches; otherwise 412. */
4119
+ "If-Match"?: string;
4120
+ };
4121
+ path: {
4122
+ /** @description Organization ID. */
4123
+ orgId: string;
4124
+ };
4125
+ cookie?: never;
4126
+ };
4127
+ requestBody: {
4128
+ content: {
4129
+ "application/json": {
4130
+ /** @description UI theme configured for an organization. */
4131
+ theme?: {
4132
+ /**
4133
+ * Format: uuid
4134
+ * @description Theme identifier.
4135
+ */
4136
+ id: string;
4137
+ /** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
4138
+ logo: {
4139
+ /** @description Image asset anchored to a named location within an organization theme. */
4140
+ desktopView: {
4141
+ /** @description SVG markup for the asset. */
4142
+ svg: string;
4143
+ /** @description Named location of the asset (e.g. header, footer). */
4144
+ location: string;
4145
+ };
4146
+ /** @description Image asset anchored to a named location within an organization theme. */
4147
+ mobileView: {
4148
+ /** @description SVG markup for the asset. */
4149
+ svg: string;
4150
+ /** @description Named location of the asset (e.g. header, footer). */
4151
+ location: string;
4152
+ };
4153
+ /** @description Image asset anchored to a named location within an organization theme. */
4154
+ darkDesktopView: {
4155
+ /** @description SVG markup for the asset. */
4156
+ svg: string;
4157
+ /** @description Named location of the asset (e.g. header, footer). */
4158
+ location: string;
4159
+ };
4160
+ /** @description Image asset anchored to a named location within an organization theme. */
4161
+ darkMobileView: {
4162
+ /** @description SVG markup for the asset. */
4163
+ svg: string;
4164
+ /** @description Named location of the asset (e.g. header, footer). */
4165
+ location: string;
4166
+ };
4167
+ };
4168
+ /** @description Arbitrary theme variables keyed by name. */
4169
+ vars?: {
4170
+ [key: string]: unknown;
4171
+ };
4172
+ };
4173
+ /** @description Preferences specific to dashboard behavior. */
4174
+ dashboard?: {
4175
+ [key: string]: unknown;
4176
+ };
4177
+ /** @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. */
4178
+ authBranding?: {
4179
+ /** @description Ordered slides rendered in the auth-page feature carousel. */
4180
+ carousel?: {
4181
+ /**
4182
+ * Format: uri
4183
+ * @description URL of the slide image asset.
4184
+ */
4185
+ imageUrl: string;
4186
+ /** @description Slide title. */
4187
+ title: string;
4188
+ /** @description Slide description text. */
4189
+ description: string;
4190
+ }[];
4191
+ /** @description FAQ entries rendered on the auth pages. */
4192
+ faqs?: {
4193
+ /** @description The question text. */
4194
+ question: string;
4195
+ /** @description The answer text. */
4196
+ answer: string;
4197
+ }[];
4198
+ };
4199
+ /** @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. */
4200
+ links?: {
4201
+ /**
4202
+ * Format: uri
4203
+ * @description URL of the organization's Terms of Service page.
4204
+ */
4205
+ termsOfService?: string;
4206
+ /**
4207
+ * Format: uri
4208
+ * @description URL of the organization's Privacy Policy page.
4209
+ */
4210
+ privacy?: string;
4211
+ /** @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. */
4212
+ support?: {
4213
+ [key: string]: string;
4214
+ };
4215
+ /** @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. */
4216
+ social?: {
4217
+ /**
4218
+ * Format: uri
4219
+ * @description URL of the organization's LinkedIn profile.
4220
+ */
4221
+ linkedin?: string;
4222
+ /**
4223
+ * Format: uri
4224
+ * @description URL of the organization's X (formerly Twitter) profile.
4225
+ */
4226
+ x?: string;
4227
+ /**
4228
+ * Format: uri
4229
+ * @description URL of the organization's YouTube channel.
4230
+ */
4231
+ youtube?: string;
4232
+ };
4233
+ };
4234
+ /** @description Whether the feature carousel renders on the organization's auth pages. Omitted keeps the stored value. */
4235
+ showAuthCarousel?: boolean;
4236
+ /** @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. Omitted keeps the current pause unchanged; it does not lift the pause. */
4237
+ schedulePause?: {
4238
+ /** @description Whether every schedule in the organization is paused. */
4239
+ paused: boolean;
4240
+ /** @description Reason given for the pause. Cleared when the pause is lifted. */
4241
+ reason?: string;
4242
+ };
4243
+ };
4244
+ };
4245
+ };
4246
+ responses: {
4247
+ /** @description Organization metadata with the merged preferences */
4248
+ 200: {
4249
+ headers: {
4250
+ /** @description Strong entity tag of the organization's stored preferences. It changes whenever the preferences change; send it back as `If-Match` to make a patchOrgPreferences write conditional. */
4251
+ ETag?: string;
4252
+ [name: string]: unknown;
4253
+ };
4254
+ content: {
4255
+ "application/json": {
4256
+ /** @description Organization-level user experience preferences. */
4257
+ preferences: {
4258
+ /** @description UI theme configured for an organization. */
4259
+ theme: {
4260
+ /**
4261
+ * Format: uuid
4262
+ * @description Theme identifier.
4263
+ */
4264
+ id: string;
4265
+ /** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
4266
+ logo: {
4267
+ /** @description Image asset anchored to a named location within an organization theme. */
4268
+ desktopView: {
4269
+ /** @description SVG markup for the asset. */
4270
+ svg: string;
4271
+ /** @description Named location of the asset (e.g. header, footer). */
4272
+ location: string;
4273
+ };
4274
+ /** @description Image asset anchored to a named location within an organization theme. */
4275
+ mobileView: {
4276
+ /** @description SVG markup for the asset. */
4277
+ svg: string;
4278
+ /** @description Named location of the asset (e.g. header, footer). */
4279
+ location: string;
4280
+ };
4281
+ /** @description Image asset anchored to a named location within an organization theme. */
4282
+ darkDesktopView: {
4283
+ /** @description SVG markup for the asset. */
4284
+ svg: string;
4285
+ /** @description Named location of the asset (e.g. header, footer). */
4286
+ location: string;
4287
+ };
4288
+ /** @description Image asset anchored to a named location within an organization theme. */
4289
+ darkMobileView: {
4290
+ /** @description SVG markup for the asset. */
4291
+ svg: string;
4292
+ /** @description Named location of the asset (e.g. header, footer). */
4293
+ location: string;
4294
+ };
4295
+ };
4296
+ /** @description Arbitrary theme variables keyed by name. */
4297
+ vars?: {
4298
+ [key: string]: unknown;
4299
+ };
4300
+ };
4301
+ /** @description Preferences specific to dashboard behavior. */
4302
+ dashboard: {
4303
+ [key: string]: unknown;
4304
+ };
4305
+ /** @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. */
4306
+ authBranding?: {
4307
+ /** @description Ordered slides rendered in the auth-page feature carousel. */
4308
+ carousel?: {
4309
+ /**
4310
+ * Format: uri
4311
+ * @description URL of the slide image asset.
4312
+ */
4313
+ imageUrl: string;
4314
+ /** @description Slide title. */
4315
+ title: string;
4316
+ /** @description Slide description text. */
4317
+ description: string;
4318
+ }[];
4319
+ /** @description FAQ entries rendered on the auth pages. */
4320
+ faqs?: {
4321
+ /** @description The question text. */
4322
+ question: string;
4323
+ /** @description The answer text. */
4324
+ answer: string;
4325
+ }[];
4326
+ };
4327
+ /** @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. */
4328
+ links?: {
4329
+ /**
4330
+ * Format: uri
4331
+ * @description URL of the organization's Terms of Service page.
4332
+ */
4333
+ termsOfService?: string;
4334
+ /**
4335
+ * Format: uri
4336
+ * @description URL of the organization's Privacy Policy page.
4337
+ */
4338
+ privacy?: string;
4339
+ /** @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. */
4340
+ support?: {
4341
+ [key: string]: string;
4342
+ };
4343
+ /** @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. */
4344
+ social?: {
4345
+ /**
4346
+ * Format: uri
4347
+ * @description URL of the organization's LinkedIn profile.
4348
+ */
4349
+ linkedin?: string;
4350
+ /**
4351
+ * Format: uri
4352
+ * @description URL of the organization's X (formerly Twitter) profile.
4353
+ */
4354
+ x?: string;
4355
+ /**
4356
+ * Format: uri
4357
+ * @description URL of the organization's YouTube channel.
4358
+ */
4359
+ youtube?: string;
4360
+ };
4361
+ };
4362
+ /**
4363
+ * @description Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it.
4364
+ * @default true
4365
+ */
4366
+ showAuthCarousel: boolean;
4367
+ /** @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. */
4368
+ schedulePause?: {
4369
+ /** @description Whether every schedule in the organization is paused. */
4370
+ paused?: boolean;
4371
+ /** @description Reason given for the pause. Cleared when the pause is lifted. */
4372
+ reason?: string;
4373
+ /**
4374
+ * Format: date-time
4375
+ * @description Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted.
4376
+ */
4377
+ pausedAt?: string;
4378
+ /** @description Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
4379
+ pausedBy?: string;
4380
+ };
4381
+ };
4382
+ };
4383
+ };
4384
+ };
4385
+ /** @description Invalid request body or request param */
4386
+ 400: {
4387
+ headers: {
4388
+ [name: string]: unknown;
4389
+ };
4390
+ content: {
4391
+ "text/plain": string;
4392
+ };
4393
+ };
4394
+ /** @description Expired JWT token used or insufficient privilege */
4395
+ 401: {
4396
+ headers: {
4397
+ [name: string]: unknown;
4398
+ };
4399
+ content: {
4400
+ "text/plain": string;
4401
+ };
4402
+ };
4403
+ /** @description Forbidden */
4404
+ 403: {
4405
+ headers: {
4406
+ [name: string]: unknown;
4407
+ };
4408
+ content: {
4409
+ "text/plain": string;
4410
+ };
4411
+ };
4412
+ /** @description Result not found */
4413
+ 404: {
4414
+ headers: {
4415
+ [name: string]: unknown;
4416
+ };
4417
+ content: {
4418
+ "text/plain": string;
4419
+ };
4420
+ };
4421
+ /** @description Precondition failed - `If-Match` does not match the current entity tag of the organization's preferences, so nothing was written. Read the preferences again and reapply the change. */
4422
+ 412: {
4423
+ headers: {
4424
+ [name: string]: unknown;
4425
+ };
4426
+ content?: never;
4427
+ };
4428
+ /** @description Internal server error */
4429
+ 500: {
4430
+ headers: {
4431
+ [name: string]: unknown;
4432
+ };
4433
+ content: {
4434
+ "text/plain": string;
4435
+ };
4436
+ };
4437
+ };
4438
+ };
3987
4439
  addTeamToOrg: {
3988
4440
  parameters: {
3989
4441
  query?: never;