@meshery/schemas 1.3.105 → 1.3.107

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 (47) hide show
  1. package/dist/cloudApi.d.mts +490 -79
  2. package/dist/cloudApi.d.ts +490 -79
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +3 -3
  6. package/dist/constructs/v1alpha2/catalog/CatalogSchema.js +1 -1
  7. package/dist/constructs/v1alpha2/catalog/CatalogSchema.mjs +1 -1
  8. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +5 -5
  9. package/dist/constructs/v1beta1/catalog/CatalogSchema.js +1 -1
  10. package/dist/constructs/v1beta1/catalog/CatalogSchema.mjs +1 -1
  11. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +55 -55
  12. package/dist/constructs/v1beta1/pattern/PatternSchema.js +11 -11
  13. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +11 -11
  14. package/dist/constructs/v1beta1/registry/Registry.d.ts +6 -6
  15. package/dist/constructs/v1beta1/registry/RegistrySchema.js +3 -3
  16. package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +3 -3
  17. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +10 -10
  18. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +2 -2
  19. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +2 -2
  20. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +3 -3
  21. package/dist/constructs/v1beta2/catalog/CatalogSchema.js +1 -1
  22. package/dist/constructs/v1beta2/catalog/CatalogSchema.mjs +1 -1
  23. package/dist/constructs/v1beta2/design/Design.d.ts +33 -33
  24. package/dist/constructs/v1beta2/design/DesignSchema.js +11 -11
  25. package/dist/constructs/v1beta2/design/DesignSchema.mjs +11 -11
  26. package/dist/constructs/v1beta3/connection/Connection.d.ts +19 -19
  27. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
  28. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
  29. package/dist/constructs/v1beta3/design/Design.d.ts +70 -58
  30. package/dist/constructs/v1beta3/design/DesignSchema.js +19 -17
  31. package/dist/constructs/v1beta3/design/DesignSchema.mjs +19 -17
  32. package/dist/constructs/v1beta3/filter/Filter.d.ts +33 -33
  33. package/dist/constructs/v1beta3/filter/FilterSchema.js +11 -11
  34. package/dist/constructs/v1beta3/filter/FilterSchema.mjs +11 -11
  35. package/dist/constructs/v1beta3/profile/Profile.d.ts +230 -13
  36. package/dist/constructs/v1beta3/profile/ProfileSchema.js +7 -2
  37. package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +7 -2
  38. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +10 -10
  39. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
  40. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
  41. package/dist/index.d.mts +43 -43
  42. package/dist/index.d.ts +43 -43
  43. package/dist/index.js +26 -26
  44. package/dist/index.mjs +26 -26
  45. package/dist/mesheryApi.d.mts +24 -24
  46. package/dist/mesheryApi.d.ts +24 -24
  47. package/package.json +1 -1
@@ -13,7 +13,7 @@ export interface paths {
13
13
  };
14
14
  /**
15
15
  * Get all profiles
16
- * @description Gets the live profiles the caller can see: those the caller owns (including profiles assigned to no workspace), those assigned to a workspace the caller is a member of, and, for organization admins, every profile of the organization. Provider admins are not granted visibility automatically. `search` matches the name or description case-insensitively.
16
+ * @description Gets the live profiles the caller can see: those the caller owns (including profiles assigned to no workspace), those that represent the caller (`userId`), those assigned to a workspace the caller is a member of, and, for organization admins, every profile of the organization. Provider admins are not granted visibility automatically. `search` matches the name or description case-insensitively; `name` matches the name exactly, ignoring case.
17
17
  */
18
18
  get: operations["getProfiles"];
19
19
  put?: never;
@@ -28,6 +28,26 @@ export interface paths {
28
28
  patch?: never;
29
29
  trace?: never;
30
30
  };
31
+ "/api/profiles/connections": {
32
+ parameters: {
33
+ query?: never;
34
+ header?: never;
35
+ path?: never;
36
+ cookie?: never;
37
+ };
38
+ /**
39
+ * Get the connection links of every visible profile
40
+ * @description Gets, in one paged read, the live profile-to-connection links of every live profile of the organization whose connections the caller may list under getProfileConnections' rules: the profiles the caller can see, with View Profiles; without it, only the profiles the caller owns. A profile that only represents the caller (`userId`) contributes no links, as its read-only grant does not cover its connections. A client learns which connections each profile acts through without one getProfileConnections call per profile. Items are ProfileConnectionMapping records; they carry ids only, and the connections themselves keep their own access rules. Ordered by profile, then connection.
41
+ */
42
+ get: operations["getProfileConnectionMappings"];
43
+ put?: never;
44
+ post?: never;
45
+ delete?: never;
46
+ options?: never;
47
+ head?: never;
48
+ patch?: never;
49
+ trace?: never;
50
+ };
31
51
  "/api/profiles/{profileId}": {
32
52
  parameters: {
33
53
  query?: never;
@@ -37,12 +57,12 @@ export interface paths {
37
57
  };
38
58
  /**
39
59
  * Get profile by ID
40
- * @description Gets a profile visible to the caller: its owner (whether or not the profile is assigned to any workspace), an organization admin, or a member of a workspace it is assigned to. Provider admins are not granted visibility automatically. A profile the caller cannot see returns 404. Seeing the profile does not grant access to its linked connections.
60
+ * @description Gets a profile visible to the caller: its owner (whether or not the profile is assigned to any workspace), the user it represents (`userId`, read only), an organization admin, or a member of a workspace it is assigned to. Provider admins are not granted visibility automatically. A profile the caller cannot see returns 404. Seeing the profile does not grant access to its linked connections. The response carries the profile's entity tag in the `ETag` header.
41
61
  */
42
62
  get: operations["getProfileById"];
43
63
  /**
44
64
  * Update a profile
45
- * @description Replaces the client-settable fields of the profile. `organizationId` cannot change after creation; a different value is refused with 400. Changing `owner` transfers the profile; the new owner must be a member of the organization.
65
+ * @description Replaces the client-settable fields of the profile. `organizationId` cannot change after creation; a different value is refused with 400. Changing `owner` transfers the profile; the new owner must be a member of the organization. The optional `If-Match` header makes the write conditional on the entity tag the profile carried when it was read: when it no longer matches, the request is refused with 412 and nothing is written. Without `If-Match` the write is unconditional.
46
66
  */
47
67
  put: operations["updateProfile"];
48
68
  post?: never;
@@ -65,7 +85,7 @@ export interface paths {
65
85
  };
66
86
  /**
67
87
  * Get profile connections
68
- * @description Gets the connections linked to a profile visible to the caller: its owner (whether or not the profile is assigned to any workspace), an organization admin, or a member of a workspace it is assigned to. The owner needs no permission key; organization admins and workspace members also need View Profiles. Provider admins are not granted visibility automatically. A profile the caller cannot see returns 404. Seeing the profile does not grant access to its linked connections, which follow their own access rules.
88
+ * @description Gets the connections linked to a profile visible to the caller: its owner (whether or not the profile is assigned to any workspace), an organization admin, or a member of a workspace it is assigned to. The owner needs no permission key; organization admins and workspace members also need View Profiles. Provider admins are not granted visibility automatically. A profile the caller cannot see returns 404. Seeing the profile does not grant access to its linked connections, which follow their own access rules. `kind` narrows the page to connections of the given kinds.
69
89
  */
70
90
  get: operations["getProfileConnections"];
71
91
  put?: never;
@@ -273,17 +293,17 @@ export interface components {
273
293
  ProfileConnectionMapping: {
274
294
  /**
275
295
  * Format: uuid
276
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
296
+ * @description Mapping record ID.
277
297
  */
278
298
  id: string;
279
299
  /**
280
300
  * Format: uuid
281
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
301
+ * @description ID of the linked profile.
282
302
  */
283
303
  profileId: string;
284
304
  /**
285
305
  * Format: uuid
286
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
306
+ * @description ID of the linked connection.
287
307
  */
288
308
  connectionId: string;
289
309
  /**
@@ -302,6 +322,48 @@ export interface components {
302
322
  */
303
323
  deletedAt?: string | null;
304
324
  };
325
+ /** @description Paginated list of profile-to-connection links. */
326
+ ProfileConnectionMappingPage: {
327
+ /** @description Zero-based page index returned in this response. */
328
+ page: number;
329
+ /** @description Maximum number of items returned on each page. */
330
+ pageSize: number;
331
+ /** @description Total number of items across all pages. */
332
+ totalCount: number;
333
+ /** @description Profile-to-connection links in this page. */
334
+ mappings: {
335
+ /**
336
+ * Format: uuid
337
+ * @description Mapping record ID.
338
+ */
339
+ id: string;
340
+ /**
341
+ * Format: uuid
342
+ * @description ID of the linked profile.
343
+ */
344
+ profileId: string;
345
+ /**
346
+ * Format: uuid
347
+ * @description ID of the linked connection.
348
+ */
349
+ connectionId: string;
350
+ /**
351
+ * Format: date-time
352
+ * @description Timestamp when the mapping was created.
353
+ */
354
+ createdAt?: string;
355
+ /**
356
+ * Format: date-time
357
+ * @description Timestamp when the mapping was last updated.
358
+ */
359
+ updatedAt?: string;
360
+ /**
361
+ * Format: date-time
362
+ * @description Timestamp when the mapping was soft-deleted. Null while the mapping remains active.
363
+ */
364
+ deletedAt?: string | null;
365
+ }[];
366
+ };
305
367
  };
306
368
  responses: {
307
369
  /** @description Invalid request body or request param */
@@ -376,6 +438,12 @@ export interface components {
376
438
  };
377
439
  };
378
440
  parameters: {
441
+ /** @description Entity tag of the profile as last read, from the `ETag` header of getProfileById or updateProfile. When present the write applies only if it still matches; otherwise 412. */
442
+ ifMatch: string;
443
+ /** @description Return only live profiles whose name equals this value, ignoring case. */
444
+ nameQuery: string;
445
+ /** @description Return only connections of these kinds (repeatable), as getConnections does. */
446
+ connectionKindQuery: string[];
379
447
  /** @description Profile ID */
380
448
  profileId: string;
381
449
  /** @description Connection ID */
@@ -430,7 +498,10 @@ export interface components {
430
498
  };
431
499
  };
432
500
  };
433
- headers: never;
501
+ headers: {
502
+ /** @description Strong entity tag of the profile. It changes whenever the profile changes; send it back as `If-Match` to make updateProfile conditional. */
503
+ ProfileETag: string;
504
+ };
434
505
  pathItems: never;
435
506
  }
436
507
  export type $defs = Record<string, never>;
@@ -440,6 +511,8 @@ export interface operations {
440
511
  query?: {
441
512
  /** @description Get responses that match search param value */
442
513
  search?: string;
514
+ /** @description Return only live profiles whose name equals this value, ignoring case. */
515
+ name?: string;
443
516
  /** @description Get ordered responses */
444
517
  order?: string;
445
518
  /** @description Get responses by page */
@@ -754,6 +827,134 @@ export interface operations {
754
827
  };
755
828
  };
756
829
  };
830
+ getProfileConnectionMappings: {
831
+ parameters: {
832
+ query?: {
833
+ /** @description Organization ID used to scope the listing. Defaults to the organization the session resolved to. */
834
+ orgId?: string;
835
+ /** @description Get responses by page */
836
+ page?: number;
837
+ /** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
838
+ pageSize?: number;
839
+ };
840
+ header?: never;
841
+ path?: never;
842
+ cookie?: never;
843
+ };
844
+ requestBody?: never;
845
+ responses: {
846
+ /** @description Profile connection links */
847
+ 200: {
848
+ headers: {
849
+ [name: string]: unknown;
850
+ };
851
+ content: {
852
+ "application/json": {
853
+ /** @description Zero-based page index returned in this response. */
854
+ page: number;
855
+ /** @description Maximum number of items returned on each page. */
856
+ pageSize: number;
857
+ /** @description Total number of items across all pages. */
858
+ totalCount: number;
859
+ /** @description Profile-to-connection links in this page. */
860
+ mappings: {
861
+ /**
862
+ * Format: uuid
863
+ * @description Mapping record ID.
864
+ */
865
+ id: string;
866
+ /**
867
+ * Format: uuid
868
+ * @description ID of the linked profile.
869
+ */
870
+ profileId: string;
871
+ /**
872
+ * Format: uuid
873
+ * @description ID of the linked connection.
874
+ */
875
+ connectionId: string;
876
+ /**
877
+ * Format: date-time
878
+ * @description Timestamp when the mapping was created.
879
+ */
880
+ createdAt?: string;
881
+ /**
882
+ * Format: date-time
883
+ * @description Timestamp when the mapping was last updated.
884
+ */
885
+ updatedAt?: string;
886
+ /**
887
+ * Format: date-time
888
+ * @description Timestamp when the mapping was soft-deleted. Null while the mapping remains active.
889
+ */
890
+ deletedAt?: string | null;
891
+ }[];
892
+ };
893
+ };
894
+ };
895
+ /** @description Invalid request body or request param */
896
+ 400: {
897
+ headers: {
898
+ [name: string]: unknown;
899
+ };
900
+ content: {
901
+ "text/plain": string;
902
+ };
903
+ };
904
+ /** @description Expired JWT token used or insufficient privilege */
905
+ 401: {
906
+ headers: {
907
+ [name: string]: unknown;
908
+ };
909
+ content: {
910
+ "text/plain": string;
911
+ };
912
+ };
913
+ /** @description Forbidden */
914
+ 403: {
915
+ headers: {
916
+ [name: string]: unknown;
917
+ };
918
+ content: {
919
+ "text/plain": string;
920
+ };
921
+ };
922
+ /** @description Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying. */
923
+ 429: {
924
+ headers: {
925
+ /** @description Number of seconds the caller must wait before retrying. */
926
+ "Retry-After": number;
927
+ [name: string]: unknown;
928
+ };
929
+ content: {
930
+ "application/json": {
931
+ /** @description The sentence the caller is shown. */
932
+ error: string;
933
+ /** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
934
+ code?: string;
935
+ /**
936
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
937
+ * @enum {string}
938
+ */
939
+ severity?: "emergency" | "alert" | "critical" | "fatal";
940
+ /** @description MeshKit's probable causes of the error. */
941
+ probableCause?: string[];
942
+ /** @description MeshKit's suggested remediations for the error. */
943
+ suggestedRemediation?: string[];
944
+ };
945
+ };
946
+ };
947
+ /** @description Internal server error */
948
+ 500: {
949
+ headers: {
950
+ [name: string]: unknown;
951
+ };
952
+ content: {
953
+ "text/plain": string;
954
+ };
955
+ };
956
+ };
957
+ };
757
958
  getProfileById: {
758
959
  parameters: {
759
960
  query?: never;
@@ -769,6 +970,8 @@ export interface operations {
769
970
  /** @description Profile */
770
971
  200: {
771
972
  headers: {
973
+ /** @description Strong entity tag of the profile. It changes whenever the profile changes; send it back as `If-Match` to make updateProfile conditional. */
974
+ ETag: string;
772
975
  [name: string]: unknown;
773
976
  };
774
977
  content: {
@@ -905,7 +1108,10 @@ export interface operations {
905
1108
  updateProfile: {
906
1109
  parameters: {
907
1110
  query?: never;
908
- header?: never;
1111
+ header?: {
1112
+ /** @description Entity tag of the profile as last read, from the `ETag` header of getProfileById or updateProfile. When present the write applies only if it still matches; otherwise 412. */
1113
+ "If-Match"?: string;
1114
+ };
909
1115
  path: {
910
1116
  /** @description Profile ID */
911
1117
  profileId: string;
@@ -946,6 +1152,8 @@ export interface operations {
946
1152
  /** @description Updated profile */
947
1153
  200: {
948
1154
  headers: {
1155
+ /** @description Strong entity tag of the profile. It changes whenever the profile changes; send it back as `If-Match` to make updateProfile conditional. */
1156
+ ETag: string;
949
1157
  [name: string]: unknown;
950
1158
  };
951
1159
  content: {
@@ -1043,6 +1251,13 @@ export interface operations {
1043
1251
  "text/plain": string;
1044
1252
  };
1045
1253
  };
1254
+ /** @description Precondition failed - `If-Match` does not match the profile's current entity tag, so nothing was written. Read the profile again and reapply the change. */
1255
+ 412: {
1256
+ headers: {
1257
+ [name: string]: unknown;
1258
+ };
1259
+ content?: never;
1260
+ };
1046
1261
  /** @description Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying. */
1047
1262
  429: {
1048
1263
  headers: {
@@ -1173,6 +1388,8 @@ export interface operations {
1173
1388
  getProfileConnections: {
1174
1389
  parameters: {
1175
1390
  query?: {
1391
+ /** @description Return only connections of these kinds (repeatable), as getConnections does. */
1392
+ kind?: string[];
1176
1393
  /** @description Get responses that match search param value */
1177
1394
  search?: string;
1178
1395
  /** @description Get ordered responses */
@@ -1480,7 +1697,7 @@ export interface operations {
1480
1697
  * Format: uuid
1481
1698
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1482
1699
  */
1483
- organizationId?: string | null;
1700
+ organizationId: string;
1484
1701
  /** @description Associated environments for this connection */
1485
1702
  environments?: {
1486
1703
  /**
@@ -1668,17 +1885,17 @@ export interface operations {
1668
1885
  "application/json": {
1669
1886
  /**
1670
1887
  * Format: uuid
1671
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1888
+ * @description Mapping record ID.
1672
1889
  */
1673
1890
  id: string;
1674
1891
  /**
1675
1892
  * Format: uuid
1676
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1893
+ * @description ID of the linked profile.
1677
1894
  */
1678
1895
  profileId: string;
1679
1896
  /**
1680
1897
  * Format: uuid
1681
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1898
+ * @description ID of the linked connection.
1682
1899
  */
1683
1900
  connectionId: string;
1684
1901
  /**