@meshery/schemas 1.3.87 → 1.3.89

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.
Files changed (38) hide show
  1. package/dist/cloudApi.d.mts +9634 -6383
  2. package/dist/cloudApi.d.ts +9634 -6383
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtp.d.ts +1 -1
  6. package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.js +1 -1
  7. package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.mjs +1 -1
  8. package/dist/constructs/v1beta1/registry/Registry.d.ts +3 -3
  9. package/dist/constructs/v1beta1/registry/RegistrySchema.js +3 -3
  10. package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +3 -3
  11. package/dist/constructs/v1beta3/connection/Connection.d.ts +83 -16
  12. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +10 -2
  13. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +10 -2
  14. package/dist/constructs/v1beta3/environment/Environment.d.ts +15 -15
  15. package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
  16. package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
  17. package/dist/constructs/v1beta3/profile/Profile.d.ts +1639 -0
  18. package/dist/constructs/v1beta3/profile/Profile.js +1 -0
  19. package/dist/constructs/v1beta3/profile/Profile.mjs +0 -0
  20. package/dist/constructs/v1beta3/profile/ProfileSchema.d.ts +2 -0
  21. package/dist/constructs/v1beta3/profile/ProfileSchema.js +22 -0
  22. package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +22 -0
  23. package/dist/constructs/v1beta3/provider_capability/ProviderCapability.d.ts +468 -5
  24. package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.js +25 -4
  25. package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.mjs +25 -4
  26. package/dist/constructs/v1beta3/token/Token.d.ts +18 -1
  27. package/dist/constructs/v1beta3/token/TokenSchema.js +3 -1
  28. package/dist/constructs/v1beta3/token/TokenSchema.mjs +3 -1
  29. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +421 -1
  30. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
  31. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
  32. package/dist/mesheryApi.d.mts +17 -17
  33. package/dist/mesheryApi.d.ts +17 -17
  34. package/dist/permissions.d.mts +85 -1
  35. package/dist/permissions.d.ts +85 -1
  36. package/dist/permissions.js +1 -1
  37. package/dist/permissions.mjs +1 -1
  38. package/package.json +1 -1
@@ -188,6 +188,50 @@ export interface paths {
188
188
  patch?: never;
189
189
  trace?: never;
190
190
  };
191
+ "/api/workspaces/{workspaceId}/profiles": {
192
+ parameters: {
193
+ query?: never;
194
+ header?: never;
195
+ path?: never;
196
+ cookie?: never;
197
+ };
198
+ /**
199
+ * Get profiles assigned to a workspace
200
+ * @description Gets profiles assigned to or available for a workspace depending on the filter. A profile can be assigned to many workspaces; members of each one can read it.
201
+ */
202
+ get: operations["getProfilesOfWorkspace"];
203
+ put?: never;
204
+ post?: never;
205
+ delete?: never;
206
+ options?: never;
207
+ head?: never;
208
+ patch?: never;
209
+ trace?: never;
210
+ };
211
+ "/api/workspaces/{workspaceId}/profiles/{profileId}": {
212
+ parameters: {
213
+ query?: never;
214
+ header?: never;
215
+ path?: never;
216
+ cookie?: never;
217
+ };
218
+ get?: never;
219
+ put?: never;
220
+ /**
221
+ * Assign a profile to a workspace
222
+ * @description Assigns a profile to a workspace, granting the workspace's members read access to it. The profile and the workspace must belong to the same organization, and a profile can be assigned to many workspaces.
223
+ */
224
+ post: operations["assignProfileToWorkspace"];
225
+ /**
226
+ * Unassign a profile from a workspace
227
+ * @description Removes a profile from a workspace. The profile itself is left intact.
228
+ */
229
+ delete: operations["unassignProfileFromWorkspace"];
230
+ options?: never;
231
+ head?: never;
232
+ patch?: never;
233
+ trace?: never;
234
+ };
191
235
  "/api/workspaces/{workspaceId}/views": {
192
236
  parameters: {
193
237
  query?: never;
@@ -616,6 +660,81 @@ export interface components {
616
660
  deletedAt?: string;
617
661
  }[];
618
662
  };
663
+ /** @description Junction record linking a workspace to a profile. */
664
+ WorkspacesProfilesMapping: {
665
+ /**
666
+ * Format: uuid
667
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
668
+ */
669
+ id: string;
670
+ /**
671
+ * Format: uuid
672
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
673
+ */
674
+ workspaceId: string;
675
+ /**
676
+ * Format: uuid
677
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
678
+ */
679
+ profileId: string;
680
+ /**
681
+ * Format: date-time
682
+ * @description Timestamp when the mapping was created.
683
+ */
684
+ createdAt?: string;
685
+ /**
686
+ * Format: date-time
687
+ * @description Timestamp when the mapping was last updated.
688
+ */
689
+ updatedAt?: string;
690
+ /**
691
+ * Format: date-time
692
+ * @description Timestamp when the mapping was soft-deleted.
693
+ */
694
+ deletedAt?: string | null;
695
+ };
696
+ /** @description Paginated list of workspace-profile mappings. */
697
+ WorkspacesProfilesMappingPage: {
698
+ /** @description Zero-based page index returned in this response. */
699
+ page?: number;
700
+ /** @description Maximum number of items returned on each page. */
701
+ pageSize?: number;
702
+ /** @description Total number of items across all pages. */
703
+ totalCount?: number;
704
+ /** @description Workspace-profile mapping entries. */
705
+ workspacesProfilesMapping?: {
706
+ /**
707
+ * Format: uuid
708
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
709
+ */
710
+ id: string;
711
+ /**
712
+ * Format: uuid
713
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
714
+ */
715
+ workspaceId: string;
716
+ /**
717
+ * Format: uuid
718
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
719
+ */
720
+ profileId: string;
721
+ /**
722
+ * Format: date-time
723
+ * @description Timestamp when the mapping was created.
724
+ */
725
+ createdAt?: string;
726
+ /**
727
+ * Format: date-time
728
+ * @description Timestamp when the mapping was last updated.
729
+ */
730
+ updatedAt?: string;
731
+ /**
732
+ * Format: date-time
733
+ * @description Timestamp when the mapping was soft-deleted.
734
+ */
735
+ deletedAt?: string | null;
736
+ }[];
737
+ };
619
738
  /** @description Junction record linking a workspace to a view. */
620
739
  WorkspacesViewsMapping: {
621
740
  /** Format: uuid */
@@ -2276,6 +2395,8 @@ export interface components {
2276
2395
  environmentId: string;
2277
2396
  /** @description Design ID */
2278
2397
  designId: string;
2398
+ /** @description Profile ID */
2399
+ profileId: string;
2279
2400
  /** @description View ID */
2280
2401
  viewId: string;
2281
2402
  /** @description Organization ID used to scope the workspace listing. */
@@ -3185,7 +3306,7 @@ export interface operations {
3185
3306
  */
3186
3307
  deletedAt?: string | null;
3187
3308
  /**
3188
- * @description What the environment exists for. `user` is an ordinary environment that people create to logically group Connections and their Credentials. `administrative` designates an environment the platform itself provisions to hold organization-level configuration, and which resolvers of that configuration therefore trust. `profile` is an ordinary, non-privileged environment that holds one profile, by convention one per profile: `name` is the profile's short name, `owner` is the profile's user, `metadata` holds the profile's settings, and the profile's accounts are linked as Connections. Like `user`, it carries no authority and a client may choose it.
3309
+ * @description What the environment exists for. `user` is an ordinary environment that people create to logically group Connections and their Credentials. `administrative` designates an environment the platform itself provisions to hold organization-level configuration, and which resolvers of that configuration therefore trust. `profile` is deprecated: profiles are their own construct (`schemas/constructs/v1beta3/profile`, served at `/api/profiles` and assigned to workspaces under `/api/workspaces/{workspaceId}/profiles`), so new profiles must not be stored as environments. The value stays in the enum only so environments written with it before the profile construct existed still read back; it is an ordinary, non-privileged environment, carries no authority, and will be removed once no consumer stores it. Consumers should move those environments to profiles.
3189
3310
  *
3190
3311
  * Absent means `user`. Nothing may read an unset or unrecognised value as administrative: test for the administrative value explicitly rather than for "not user", so the property fails closed.
3191
3312
  *
@@ -5060,6 +5181,305 @@ export interface operations {
5060
5181
  };
5061
5182
  };
5062
5183
  };
5184
+ getProfilesOfWorkspace: {
5185
+ parameters: {
5186
+ query?: {
5187
+ /** @description Get responses that match search param value */
5188
+ search?: string;
5189
+ /** @description Get ordered responses */
5190
+ order?: string;
5191
+ /** @description Get responses by page */
5192
+ page?: number;
5193
+ /** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
5194
+ pageSize?: number;
5195
+ /**
5196
+ * @deprecated
5197
+ * @description Get responses by pagesize. Deprecated alias of pageSize.
5198
+ */
5199
+ pagesize?: number;
5200
+ /** @description JSON-encoded filter string used for assignment and soft-delete filters. */
5201
+ filter?: string;
5202
+ };
5203
+ header?: never;
5204
+ path: {
5205
+ /** @description Workspace ID */
5206
+ workspaceId: string;
5207
+ };
5208
+ cookie?: never;
5209
+ };
5210
+ requestBody?: never;
5211
+ responses: {
5212
+ /** @description Profiles */
5213
+ 200: {
5214
+ headers: {
5215
+ [name: string]: unknown;
5216
+ };
5217
+ content: {
5218
+ "application/json": {
5219
+ /** @description Zero-based page index returned in this response. */
5220
+ page: number;
5221
+ /** @description Maximum number of items returned on each page. */
5222
+ pageSize: number;
5223
+ /** @description Total number of items across all pages. */
5224
+ totalCount: number;
5225
+ /** @description Profiles in this page. */
5226
+ profiles: {
5227
+ /**
5228
+ * Format: uuid
5229
+ * @description Server-generated profile ID.
5230
+ */
5231
+ id: string;
5232
+ /**
5233
+ * @description Specifies the version of the schema to which the profile conforms.
5234
+ * @default profiles.meshery.io/v1beta3
5235
+ * @example [
5236
+ * "v1",
5237
+ * "v1alpha1",
5238
+ * "v2beta3",
5239
+ * "v1.custom-suffix",
5240
+ * "models.meshery.io/v1beta1",
5241
+ * "capability.meshery.io/v1alpha1"
5242
+ * ]
5243
+ */
5244
+ schemaVersion: string;
5245
+ /** @description Name of the profile, typically its short handle. Not unique; like environment names, two profiles may share one. */
5246
+ name: string;
5247
+ /** @description Description of the profile. */
5248
+ description?: string;
5249
+ /**
5250
+ * Format: uuid
5251
+ * @description Owning organization ID. Fixed at creation.
5252
+ */
5253
+ organizationId: string;
5254
+ /**
5255
+ * Format: uuid
5256
+ * @description ID of the user who owns the profile. Defaults to the creating user. The owner, or a holder of the Edit Profile key in a workspace the profile is assigned to, may transfer it. When the owner's account is deleted, ownership passes on by the same succession rule that applies to designs.
5257
+ */
5258
+ owner: string;
5259
+ /**
5260
+ * Format: uuid
5261
+ * @description ID of the user this profile represents, when it represents a user. Absent for a profile that represents no user account, such as a brand. Not unique: a user may be represented by more than one profile.
5262
+ */
5263
+ userId?: string;
5264
+ /** @description Free-form settings of the profile, stored as a JSON blob. */
5265
+ metadata?: Record<string, never>;
5266
+ /**
5267
+ * Format: date-time
5268
+ * @description Timestamp when the profile was created.
5269
+ */
5270
+ createdAt: string;
5271
+ /**
5272
+ * Format: date-time
5273
+ * @description Timestamp when the profile was last updated.
5274
+ */
5275
+ updatedAt: string;
5276
+ /**
5277
+ * Format: date-time
5278
+ * @description Timestamp when the profile was soft-deleted. Null while the profile remains active.
5279
+ */
5280
+ deletedAt?: string | null;
5281
+ }[];
5282
+ };
5283
+ };
5284
+ };
5285
+ /** @description Invalid request body or request param */
5286
+ 400: {
5287
+ headers: {
5288
+ [name: string]: unknown;
5289
+ };
5290
+ content: {
5291
+ "text/plain": string;
5292
+ };
5293
+ };
5294
+ /** @description Expired JWT token used or insufficient privilege */
5295
+ 401: {
5296
+ headers: {
5297
+ [name: string]: unknown;
5298
+ };
5299
+ content: {
5300
+ "text/plain": string;
5301
+ };
5302
+ };
5303
+ /** @description Result not found */
5304
+ 404: {
5305
+ headers: {
5306
+ [name: string]: unknown;
5307
+ };
5308
+ content: {
5309
+ "text/plain": string;
5310
+ };
5311
+ };
5312
+ /** @description Internal server error */
5313
+ 500: {
5314
+ headers: {
5315
+ [name: string]: unknown;
5316
+ };
5317
+ content: {
5318
+ "text/plain": string;
5319
+ };
5320
+ };
5321
+ };
5322
+ };
5323
+ assignProfileToWorkspace: {
5324
+ parameters: {
5325
+ query?: never;
5326
+ header?: never;
5327
+ path: {
5328
+ /** @description Workspace ID */
5329
+ workspaceId: string;
5330
+ /** @description Profile ID */
5331
+ profileId: string;
5332
+ };
5333
+ cookie?: never;
5334
+ };
5335
+ requestBody?: never;
5336
+ responses: {
5337
+ /** @description Workspace profile mappings */
5338
+ 200: {
5339
+ headers: {
5340
+ [name: string]: unknown;
5341
+ };
5342
+ content: {
5343
+ "application/json": {
5344
+ /** @description Zero-based page index returned in this response. */
5345
+ page?: number;
5346
+ /** @description Maximum number of items returned on each page. */
5347
+ pageSize?: number;
5348
+ /** @description Total number of items across all pages. */
5349
+ totalCount?: number;
5350
+ /** @description Workspace-profile mapping entries. */
5351
+ workspacesProfilesMapping?: {
5352
+ /**
5353
+ * Format: uuid
5354
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5355
+ */
5356
+ id: string;
5357
+ /**
5358
+ * Format: uuid
5359
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5360
+ */
5361
+ workspaceId: string;
5362
+ /**
5363
+ * Format: uuid
5364
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5365
+ */
5366
+ profileId: string;
5367
+ /**
5368
+ * Format: date-time
5369
+ * @description Timestamp when the mapping was created.
5370
+ */
5371
+ createdAt?: string;
5372
+ /**
5373
+ * Format: date-time
5374
+ * @description Timestamp when the mapping was last updated.
5375
+ */
5376
+ updatedAt?: string;
5377
+ /**
5378
+ * Format: date-time
5379
+ * @description Timestamp when the mapping was soft-deleted.
5380
+ */
5381
+ deletedAt?: string | null;
5382
+ }[];
5383
+ };
5384
+ };
5385
+ };
5386
+ /** @description Invalid request body or request param */
5387
+ 400: {
5388
+ headers: {
5389
+ [name: string]: unknown;
5390
+ };
5391
+ content: {
5392
+ "text/plain": string;
5393
+ };
5394
+ };
5395
+ /** @description Expired JWT token used or insufficient privilege */
5396
+ 401: {
5397
+ headers: {
5398
+ [name: string]: unknown;
5399
+ };
5400
+ content: {
5401
+ "text/plain": string;
5402
+ };
5403
+ };
5404
+ /** @description Result not found */
5405
+ 404: {
5406
+ headers: {
5407
+ [name: string]: unknown;
5408
+ };
5409
+ content: {
5410
+ "text/plain": string;
5411
+ };
5412
+ };
5413
+ /** @description Internal server error */
5414
+ 500: {
5415
+ headers: {
5416
+ [name: string]: unknown;
5417
+ };
5418
+ content: {
5419
+ "text/plain": string;
5420
+ };
5421
+ };
5422
+ };
5423
+ };
5424
+ unassignProfileFromWorkspace: {
5425
+ parameters: {
5426
+ query?: never;
5427
+ header?: never;
5428
+ path: {
5429
+ /** @description Workspace ID */
5430
+ workspaceId: string;
5431
+ /** @description Profile ID */
5432
+ profileId: string;
5433
+ };
5434
+ cookie?: never;
5435
+ };
5436
+ requestBody?: never;
5437
+ responses: {
5438
+ /** @description Workspace profile mapping removed */
5439
+ 204: {
5440
+ headers: {
5441
+ [name: string]: unknown;
5442
+ };
5443
+ content?: never;
5444
+ };
5445
+ /** @description Invalid request body or request param */
5446
+ 400: {
5447
+ headers: {
5448
+ [name: string]: unknown;
5449
+ };
5450
+ content: {
5451
+ "text/plain": string;
5452
+ };
5453
+ };
5454
+ /** @description Expired JWT token used or insufficient privilege */
5455
+ 401: {
5456
+ headers: {
5457
+ [name: string]: unknown;
5458
+ };
5459
+ content: {
5460
+ "text/plain": string;
5461
+ };
5462
+ };
5463
+ /** @description Result not found */
5464
+ 404: {
5465
+ headers: {
5466
+ [name: string]: unknown;
5467
+ };
5468
+ content: {
5469
+ "text/plain": string;
5470
+ };
5471
+ };
5472
+ /** @description Internal server error */
5473
+ 500: {
5474
+ headers: {
5475
+ [name: string]: unknown;
5476
+ };
5477
+ content: {
5478
+ "text/plain": string;
5479
+ };
5480
+ };
5481
+ };
5482
+ };
5063
5483
  getViewsOfWorkspace: {
5064
5484
  parameters: {
5065
5485
  query?: {