@meshery/schemas 1.3.68 → 1.3.69

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.
@@ -13202,20 +13202,20 @@ type UpdateInvitationApiArg = {
13202
13202
  isDefault?: boolean;
13203
13203
  /** Name of the invitation. */
13204
13204
  name: string;
13205
- /** Description of the invitation. */
13206
- description: string;
13207
- /** Email addresses or patterns this invitation is valid for. */
13208
- emails: string[];
13205
+ /** Description of the invitation. Optional; omitting it stores an empty description. */
13206
+ description?: string;
13207
+ /** Email addresses or patterns this invitation is valid for. Optional; omitting it or sending an empty list means any email address may accept the invitation. */
13208
+ emails?: string[];
13209
13209
  /** ID of the organization to which the user is invited. */
13210
13210
  orgId: string;
13211
13211
  /** Timestamp when the invitation expires, if applicable. */
13212
13212
  expiresAt?: string;
13213
13213
  /** Quota for the invitation; limits the number of users that can accept it. */
13214
13214
  quota?: number;
13215
- /** Roles that the user will have when accepting the invitation. */
13216
- roles: string[];
13217
- /** Teams that the user will be added to when accepting the invitation. */
13218
- teams: string[];
13215
+ /** Roles that the user will have when accepting the invitation. Optional; omitting it or sending an empty list grants no roles. */
13216
+ roles?: string[];
13217
+ /** Teams that the user will be added to when accepting the invitation. Optional; omitting it or sending an empty list adds the user to no teams. */
13218
+ teams?: string[];
13219
13219
  /** Determines what accepting this invitation does for the accepting user, for new and existing accounts alike. direct_membership (the default, and the behavior of every invitation that omits this property) adds the user to the inviting organization. child_organization creates a new child organization for the user whose parent is always the inviting organization; the child is named "My Organization" and follows the standard organization-creation procedure (a My Team team, a My Workspace workspace, and the accepting user as its owner with organization administrator privileges). With child_organization the invitation's roles and teams apply in the child organization, not in the inviting organization. */
13220
13220
  acceptanceOutcome?: "direct_membership" | "child_organization";
13221
13221
  /** Activation status of the invitation. */
@@ -13325,20 +13325,20 @@ type CreateInvitationApiArg = {
13325
13325
  isDefault?: boolean;
13326
13326
  /** Name of the invitation. */
13327
13327
  name: string;
13328
- /** Description of the invitation. */
13329
- description: string;
13330
- /** Email addresses or patterns this invitation is valid for. */
13331
- emails: string[];
13328
+ /** Description of the invitation. Optional; omitting it stores an empty description. */
13329
+ description?: string;
13330
+ /** Email addresses or patterns this invitation is valid for. Optional; omitting it or sending an empty list means any email address may accept the invitation. */
13331
+ emails?: string[];
13332
13332
  /** ID of the organization to which the user is invited. */
13333
13333
  orgId: string;
13334
13334
  /** Timestamp when the invitation expires, if applicable. */
13335
13335
  expiresAt?: string;
13336
13336
  /** Quota for the invitation; limits the number of users that can accept it. */
13337
13337
  quota?: number;
13338
- /** Roles that the user will have when accepting the invitation. */
13339
- roles: string[];
13340
- /** Teams that the user will be added to when accepting the invitation. */
13341
- teams: string[];
13338
+ /** Roles that the user will have when accepting the invitation. Optional; omitting it or sending an empty list grants no roles. */
13339
+ roles?: string[];
13340
+ /** Teams that the user will be added to when accepting the invitation. Optional; omitting it or sending an empty list adds the user to no teams. */
13341
+ teams?: string[];
13342
13342
  /** Determines what accepting this invitation does for the accepting user, for new and existing accounts alike. direct_membership (the default, and the behavior of every invitation that omits this property) adds the user to the inviting organization. child_organization creates a new child organization for the user whose parent is always the inviting organization; the child is named "My Organization" and follows the standard organization-creation procedure (a My Team team, a My Workspace workspace, and the accepting user as its owner with organization administrator privileges). With child_organization the invitation's roles and teams apply in the child organization, not in the inviting organization. */
13343
13343
  acceptanceOutcome?: "direct_membership" | "child_organization";
13344
13344
  /** Activation status of the invitation. */
@@ -13202,20 +13202,20 @@ type UpdateInvitationApiArg = {
13202
13202
  isDefault?: boolean;
13203
13203
  /** Name of the invitation. */
13204
13204
  name: string;
13205
- /** Description of the invitation. */
13206
- description: string;
13207
- /** Email addresses or patterns this invitation is valid for. */
13208
- emails: string[];
13205
+ /** Description of the invitation. Optional; omitting it stores an empty description. */
13206
+ description?: string;
13207
+ /** Email addresses or patterns this invitation is valid for. Optional; omitting it or sending an empty list means any email address may accept the invitation. */
13208
+ emails?: string[];
13209
13209
  /** ID of the organization to which the user is invited. */
13210
13210
  orgId: string;
13211
13211
  /** Timestamp when the invitation expires, if applicable. */
13212
13212
  expiresAt?: string;
13213
13213
  /** Quota for the invitation; limits the number of users that can accept it. */
13214
13214
  quota?: number;
13215
- /** Roles that the user will have when accepting the invitation. */
13216
- roles: string[];
13217
- /** Teams that the user will be added to when accepting the invitation. */
13218
- teams: string[];
13215
+ /** Roles that the user will have when accepting the invitation. Optional; omitting it or sending an empty list grants no roles. */
13216
+ roles?: string[];
13217
+ /** Teams that the user will be added to when accepting the invitation. Optional; omitting it or sending an empty list adds the user to no teams. */
13218
+ teams?: string[];
13219
13219
  /** Determines what accepting this invitation does for the accepting user, for new and existing accounts alike. direct_membership (the default, and the behavior of every invitation that omits this property) adds the user to the inviting organization. child_organization creates a new child organization for the user whose parent is always the inviting organization; the child is named "My Organization" and follows the standard organization-creation procedure (a My Team team, a My Workspace workspace, and the accepting user as its owner with organization administrator privileges). With child_organization the invitation's roles and teams apply in the child organization, not in the inviting organization. */
13220
13220
  acceptanceOutcome?: "direct_membership" | "child_organization";
13221
13221
  /** Activation status of the invitation. */
@@ -13325,20 +13325,20 @@ type CreateInvitationApiArg = {
13325
13325
  isDefault?: boolean;
13326
13326
  /** Name of the invitation. */
13327
13327
  name: string;
13328
- /** Description of the invitation. */
13329
- description: string;
13330
- /** Email addresses or patterns this invitation is valid for. */
13331
- emails: string[];
13328
+ /** Description of the invitation. Optional; omitting it stores an empty description. */
13329
+ description?: string;
13330
+ /** Email addresses or patterns this invitation is valid for. Optional; omitting it or sending an empty list means any email address may accept the invitation. */
13331
+ emails?: string[];
13332
13332
  /** ID of the organization to which the user is invited. */
13333
13333
  orgId: string;
13334
13334
  /** Timestamp when the invitation expires, if applicable. */
13335
13335
  expiresAt?: string;
13336
13336
  /** Quota for the invitation; limits the number of users that can accept it. */
13337
13337
  quota?: number;
13338
- /** Roles that the user will have when accepting the invitation. */
13339
- roles: string[];
13340
- /** Teams that the user will be added to when accepting the invitation. */
13341
- teams: string[];
13338
+ /** Roles that the user will have when accepting the invitation. Optional; omitting it or sending an empty list grants no roles. */
13339
+ roles?: string[];
13340
+ /** Teams that the user will be added to when accepting the invitation. Optional; omitting it or sending an empty list adds the user to no teams. */
13341
+ teams?: string[];
13342
13342
  /** Determines what accepting this invitation does for the accepting user, for new and existing accounts alike. direct_membership (the default, and the behavior of every invitation that omits this property) adds the user to the inviting organization. child_organization creates a new child organization for the user whose parent is always the inviting organization; the child is named "My Organization" and follows the standard organization-creation procedure (a My Team team, a My Workspace workspace, and the accepting user as its owner with organization administrator privileges). With child_organization the invitation's roles and teams apply in the child organization, not in the inviting organization. */
13343
13343
  acceptanceOutcome?: "direct_membership" | "child_organization";
13344
13344
  /** Activation status of the invitation. */
@@ -402,10 +402,10 @@ export interface components {
402
402
  isDefault?: boolean;
403
403
  /** @description Name of the invitation. */
404
404
  name: string;
405
- /** @description Description of the invitation. */
406
- description: string;
407
- /** @description Email addresses or patterns this invitation is valid for. */
408
- emails: string[];
405
+ /** @description Description of the invitation. Optional; omitting it stores an empty description. */
406
+ description?: string;
407
+ /** @description Email addresses or patterns this invitation is valid for. Optional; omitting it or sending an empty list means any email address may accept the invitation. */
408
+ emails?: string[];
409
409
  /**
410
410
  * Format: uuid
411
411
  * @description ID of the organization to which the user is invited.
@@ -418,10 +418,10 @@ export interface components {
418
418
  expiresAt?: string;
419
419
  /** @description Quota for the invitation; limits the number of users that can accept it. */
420
420
  quota?: number;
421
- /** @description Roles that the user will have when accepting the invitation. */
422
- roles: string[];
423
- /** @description Teams that the user will be added to when accepting the invitation. */
424
- teams: string[];
421
+ /** @description Roles that the user will have when accepting the invitation. Optional; omitting it or sending an empty list grants no roles. */
422
+ roles?: string[];
423
+ /** @description Teams that the user will be added to when accepting the invitation. Optional; omitting it or sending an empty list adds the user to no teams. */
424
+ teams?: string[];
425
425
  /**
426
426
  * @description Determines what accepting this invitation does for the accepting user, for new and existing accounts alike. direct_membership (the default, and the behavior of every invitation that omits this property) adds the user to the inviting organization. child_organization creates a new child organization for the user whose parent is always the inviting organization; the child is named "My Organization" and follows the standard organization-creation procedure (a My Team team, a My Workspace workspace, and the accepting user as its owner with organization administrator privileges). With child_organization the invitation's roles and teams apply in the child organization, not in the inviting organization.
427
427
  * @default direct_membership
@@ -833,10 +833,10 @@ export interface operations {
833
833
  isDefault?: boolean;
834
834
  /** @description Name of the invitation. */
835
835
  name: string;
836
- /** @description Description of the invitation. */
837
- description: string;
838
- /** @description Email addresses or patterns this invitation is valid for. */
839
- emails: string[];
836
+ /** @description Description of the invitation. Optional; omitting it stores an empty description. */
837
+ description?: string;
838
+ /** @description Email addresses or patterns this invitation is valid for. Optional; omitting it or sending an empty list means any email address may accept the invitation. */
839
+ emails?: string[];
840
840
  /**
841
841
  * Format: uuid
842
842
  * @description ID of the organization to which the user is invited.
@@ -849,10 +849,10 @@ export interface operations {
849
849
  expiresAt?: string;
850
850
  /** @description Quota for the invitation; limits the number of users that can accept it. */
851
851
  quota?: number;
852
- /** @description Roles that the user will have when accepting the invitation. */
853
- roles: string[];
854
- /** @description Teams that the user will be added to when accepting the invitation. */
855
- teams: string[];
852
+ /** @description Roles that the user will have when accepting the invitation. Optional; omitting it or sending an empty list grants no roles. */
853
+ roles?: string[];
854
+ /** @description Teams that the user will be added to when accepting the invitation. Optional; omitting it or sending an empty list adds the user to no teams. */
855
+ teams?: string[];
856
856
  /**
857
857
  * @description Determines what accepting this invitation does for the accepting user, for new and existing accounts alike. direct_membership (the default, and the behavior of every invitation that omits this property) adds the user to the inviting organization. child_organization creates a new child organization for the user whose parent is always the inviting organization; the child is named "My Organization" and follows the standard organization-creation procedure (a My Team team, a My Workspace workspace, and the accepting user as its owner with organization administrator privileges). With child_organization the invitation's roles and teams apply in the child organization, not in the inviting organization.
858
858
  * @default direct_membership
@@ -1254,10 +1254,10 @@ export interface operations {
1254
1254
  isDefault?: boolean;
1255
1255
  /** @description Name of the invitation. */
1256
1256
  name: string;
1257
- /** @description Description of the invitation. */
1258
- description: string;
1259
- /** @description Email addresses or patterns this invitation is valid for. */
1260
- emails: string[];
1257
+ /** @description Description of the invitation. Optional; omitting it stores an empty description. */
1258
+ description?: string;
1259
+ /** @description Email addresses or patterns this invitation is valid for. Optional; omitting it or sending an empty list means any email address may accept the invitation. */
1260
+ emails?: string[];
1261
1261
  /**
1262
1262
  * Format: uuid
1263
1263
  * @description ID of the organization to which the user is invited.
@@ -1270,10 +1270,10 @@ export interface operations {
1270
1270
  expiresAt?: string;
1271
1271
  /** @description Quota for the invitation; limits the number of users that can accept it. */
1272
1272
  quota?: number;
1273
- /** @description Roles that the user will have when accepting the invitation. */
1274
- roles: string[];
1275
- /** @description Teams that the user will be added to when accepting the invitation. */
1276
- teams: string[];
1273
+ /** @description Roles that the user will have when accepting the invitation. Optional; omitting it or sending an empty list grants no roles. */
1274
+ roles?: string[];
1275
+ /** @description Teams that the user will be added to when accepting the invitation. Optional; omitting it or sending an empty list adds the user to no teams. */
1276
+ teams?: string[];
1277
1277
  /**
1278
1278
  * @description Determines what accepting this invitation does for the accepting user, for new and existing accounts alike. direct_membership (the default, and the behavior of every invitation that omits this property) adds the user to the inviting organization. child_organization creates a new child organization for the user whose parent is always the inviting organization; the child is named "My Organization" and follows the standard organization-creation procedure (a My Team team, a My Workspace workspace, and the accepting user as its owner with organization administrator privileges). With child_organization the invitation's roles and teams apply in the child organization, not in the inviting organization.
1279
1279
  * @default direct_membership