@meshery/schemas 1.3.111 → 1.3.112
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 +5024 -4404
- package/dist/cloudApi.d.ts +5024 -4404
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta3/oauth_consent/OauthConsent.d.ts +466 -0
- package/dist/constructs/v1beta3/oauth_consent/OauthConsent.js +1 -0
- package/dist/constructs/v1beta3/oauth_consent/OauthConsent.mjs +0 -0
- package/dist/constructs/v1beta3/oauth_consent/OauthConsentSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/oauth_consent/OauthConsentSchema.js +199 -0
- package/dist/constructs/v1beta3/oauth_consent/OauthConsentSchema.mjs +199 -0
- package/dist/constructs/v1beta3/token/Token.d.ts +131 -5
- package/dist/constructs/v1beta3/token/TokenSchema.js +3 -3
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +3 -3
- package/dist/constructs/v1beta3/user/User.d.ts +222 -2
- package/dist/constructs/v1beta3/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta3/user/UserSchema.mjs +1 -1
- package/dist/index.d.mts +85 -2
- package/dist/index.d.ts +85 -2
- package/dist/mesheryApi.d.mts +1 -1
- package/dist/mesheryApi.d.ts +1 -1
- package/package.json +1 -1
|
@@ -64,6 +64,26 @@ export interface paths {
|
|
|
64
64
|
patch?: never;
|
|
65
65
|
trace?: never;
|
|
66
66
|
};
|
|
67
|
+
"/api/identity/users/preferences": {
|
|
68
|
+
parameters: {
|
|
69
|
+
query?: never;
|
|
70
|
+
header?: never;
|
|
71
|
+
path?: never;
|
|
72
|
+
cookie?: never;
|
|
73
|
+
};
|
|
74
|
+
get?: never;
|
|
75
|
+
/**
|
|
76
|
+
* Update the current user's preferences
|
|
77
|
+
* @description Merges the payload onto the signed-in user's stored preferences. A key the payload names replaces the stored value; a key it leaves out keeps the stored value. Setting selectedOrganizationId switches the organization the user's session has selected, as Meshery Cloud's and Meshery's organization switchers do. Badges are server-owned and are never changed through this operation. Only the signed-in session can set agentsActWithoutApproval: a token-authenticated request that names it, with any value including null, or that changes a remoteProviderPreferences.<provider>.agentsActWithoutApproval entry, is answered 403 and no part of the payload is applied.
|
|
78
|
+
*/
|
|
79
|
+
put: operations["updateUserPreferences"];
|
|
80
|
+
post?: never;
|
|
81
|
+
delete?: never;
|
|
82
|
+
options?: never;
|
|
83
|
+
head?: never;
|
|
84
|
+
patch?: never;
|
|
85
|
+
trace?: never;
|
|
86
|
+
};
|
|
67
87
|
}
|
|
68
88
|
export type webhooks = Record<string, never>;
|
|
69
89
|
export interface components {
|
|
@@ -185,10 +205,12 @@ export interface components {
|
|
|
185
205
|
usersExtensionPreferences: {
|
|
186
206
|
[key: string]: unknown;
|
|
187
207
|
};
|
|
188
|
-
/** @description The remote provider preferences of the preference. */
|
|
208
|
+
/** @description The remote provider preferences of the preference. Free-form, keyed by provider. A provider's `agentsActWithoutApproval` entry is deprecated in favor of the typed `agentsActWithoutApproval` field, and it is never read once the typed field has been written (see Preference.agentsActWithoutApproval). A token-authenticated request that would change the stored state of that entry (a different value, adding it where absent, or removing it where present) is answered 403, as for the typed field. Writing back the stored entry unchanged is accepted. See docs/agent-approval-preference.md (Migration from the free-form value). */
|
|
189
209
|
remoteProviderPreferences: {
|
|
190
210
|
[key: string]: unknown;
|
|
191
211
|
};
|
|
212
|
+
/** @description Interim rule (temporary): until the upstream platform, workspace and profile policies exist, inherit (including absent) resolves to required. During the interim this field is stored and writable but is not consulted by approval resolution; it becomes the profile-level source once the hierarchy places that level (the hierarchy proposal is https://github.com/layer5io/meshery-cloud/issues/6365, and the interim does not wait on it). Target model, once the hierarchy places the profile level: one profile-level source in the approval hierarchy (platform, workspace, profile; hierarchy defined in https://github.com/layer5io/meshery-cloud/issues/6365). Each activity carries an approvalPolicy (required, not_required or inherit; no schema default, and absent behaves like inherit). An explicit required or not_required on the activity always wins and never consults this field. This field is consulted only for an activity whose approvalPolicy is inherit or absent, only when it was written by an AI app, and only if no level that the hierarchy places ahead of the profile has already decided. For such an activity: true means not_required, false means required, and absent sets nothing. If nothing sets a value, approval is required (fail closed; this fallback is open for confirmation in https://github.com/layer5io/meshery-cloud/issues/6365). AI apps never set approved; approvalPolicy only says whether approval is needed. No schema default is declared, so absence stays distinguishable from false. Typed replacement for the free-form remoteProviderPreferences.<provider>.agentsActWithoutApproval. The server keeps a write-once marker per preference, which is not part of this schema: the first accepted write that names this field (true, false, or null) sets the marker, and nothing clears it. Only a write from the signed-in session can set the marker; a token-authenticated write that names this field never sets it. Once the marker is set, the free-form value is never read again, and null means inherit, not the free-form value. While the marker is unset, the free-form value is not shown as the preference and never changes approval resolution: during the interim inherit resolves to required whatever it says, as the migration section of docs/agent-approval-preference.md describes. On read, absent means not set (inherit); the stored value is never null. An API token, of any kind, cannot change this field: a token-authenticated request that names it, with any value including null, is answered 403. Only a request authenticated by the signed-in session can set it. See PreferencePayload.agentsActWithoutApproval and docs/agent-approval-preference.md. */
|
|
213
|
+
agentsActWithoutApproval?: boolean;
|
|
192
214
|
};
|
|
193
215
|
/**
|
|
194
216
|
* Format: date-time
|
|
@@ -640,10 +662,82 @@ export interface components {
|
|
|
640
662
|
usersExtensionPreferences: {
|
|
641
663
|
[key: string]: unknown;
|
|
642
664
|
};
|
|
643
|
-
/** @description The remote provider preferences of the preference. */
|
|
665
|
+
/** @description The remote provider preferences of the preference. Free-form, keyed by provider. A provider's `agentsActWithoutApproval` entry is deprecated in favor of the typed `agentsActWithoutApproval` field, and it is never read once the typed field has been written (see Preference.agentsActWithoutApproval). A token-authenticated request that would change the stored state of that entry (a different value, adding it where absent, or removing it where present) is answered 403, as for the typed field. Writing back the stored entry unchanged is accepted. See docs/agent-approval-preference.md (Migration from the free-form value). */
|
|
644
666
|
remoteProviderPreferences: {
|
|
645
667
|
[key: string]: unknown;
|
|
646
668
|
};
|
|
669
|
+
/** @description Interim rule (temporary): until the upstream platform, workspace and profile policies exist, inherit (including absent) resolves to required. During the interim this field is stored and writable but is not consulted by approval resolution; it becomes the profile-level source once the hierarchy places that level (the hierarchy proposal is https://github.com/layer5io/meshery-cloud/issues/6365, and the interim does not wait on it). Target model, once the hierarchy places the profile level: one profile-level source in the approval hierarchy (platform, workspace, profile; hierarchy defined in https://github.com/layer5io/meshery-cloud/issues/6365). Each activity carries an approvalPolicy (required, not_required or inherit; no schema default, and absent behaves like inherit). An explicit required or not_required on the activity always wins and never consults this field. This field is consulted only for an activity whose approvalPolicy is inherit or absent, only when it was written by an AI app, and only if no level that the hierarchy places ahead of the profile has already decided. For such an activity: true means not_required, false means required, and absent sets nothing. If nothing sets a value, approval is required (fail closed; this fallback is open for confirmation in https://github.com/layer5io/meshery-cloud/issues/6365). AI apps never set approved; approvalPolicy only says whether approval is needed. No schema default is declared, so absence stays distinguishable from false. Typed replacement for the free-form remoteProviderPreferences.<provider>.agentsActWithoutApproval. The server keeps a write-once marker per preference, which is not part of this schema: the first accepted write that names this field (true, false, or null) sets the marker, and nothing clears it. Only a write from the signed-in session can set the marker; a token-authenticated write that names this field never sets it. Once the marker is set, the free-form value is never read again, and null means inherit, not the free-form value. While the marker is unset, the free-form value is not shown as the preference and never changes approval resolution: during the interim inherit resolves to required whatever it says, as the migration section of docs/agent-approval-preference.md describes. On read, absent means not set (inherit); the stored value is never null. An API token, of any kind, cannot change this field: a token-authenticated request that names it, with any value including null, is answered 403. Only a request authenticated by the signed-in session can set it. See PreferencePayload.agentsActWithoutApproval and docs/agent-approval-preference.md. */
|
|
670
|
+
agentsActWithoutApproval?: boolean;
|
|
671
|
+
};
|
|
672
|
+
/** @description The v1beta3 request body of updateUserPreferences (PUT /api/identity/users/preferences), and the client-settable fields of Preference. Every field is optional: the server merges the ones present onto the stored preferences and keeps the rest. Setting selectedOrganizationId switches the organization the user's session has selected. Badges are server-owned and are never changed through this body. updatedAt is server-recorded and is not settable. See docs/agent-approval-preference.md for who may write agentsActWithoutApproval. */
|
|
673
|
+
PreferencePayload: {
|
|
674
|
+
/** @description The mesh adapters of the preference. */
|
|
675
|
+
meshAdapters?: Record<string, never>[];
|
|
676
|
+
grafana?: {
|
|
677
|
+
/** @description Grafana URL for the user configuration. */
|
|
678
|
+
grafanaUrl?: string;
|
|
679
|
+
/** @description Grafana API key for the user configuration. */
|
|
680
|
+
grafanaApiKey?: string;
|
|
681
|
+
/** @description Selected Grafana board configurations for the user. */
|
|
682
|
+
selectedBoardsConfigs?: {
|
|
683
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
684
|
+
board?: Record<string, never>;
|
|
685
|
+
/** @description Panels selected for the Grafana board configuration. */
|
|
686
|
+
panels?: Record<string, never>[];
|
|
687
|
+
/** @description Template variables applied to the selected Grafana board configuration. */
|
|
688
|
+
templateVars?: string[];
|
|
689
|
+
}[];
|
|
690
|
+
};
|
|
691
|
+
prometheus?: {
|
|
692
|
+
/** @description The prometheus URL of the prometheus. */
|
|
693
|
+
prometheusUrl?: string;
|
|
694
|
+
/** @description The selected prometheus boards configs of the prometheus. */
|
|
695
|
+
selectedPrometheusBoardsConfigs?: {
|
|
696
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
697
|
+
board?: Record<string, never>;
|
|
698
|
+
/** @description Panels selected for the Grafana board configuration. */
|
|
699
|
+
panels?: Record<string, never>[];
|
|
700
|
+
/** @description Template variables applied to the selected Grafana board configuration. */
|
|
701
|
+
templateVars?: string[];
|
|
702
|
+
}[];
|
|
703
|
+
};
|
|
704
|
+
loadTestPrefs?: {
|
|
705
|
+
/** @description Concurrent requests */
|
|
706
|
+
c?: number;
|
|
707
|
+
/** @description Queries per second */
|
|
708
|
+
qps?: number;
|
|
709
|
+
/** @description Duration */
|
|
710
|
+
t?: string;
|
|
711
|
+
/** @description Load generator */
|
|
712
|
+
gen?: string;
|
|
713
|
+
};
|
|
714
|
+
/** @description The anonymous usage stats of the preference. */
|
|
715
|
+
anonymousUsageStats?: boolean;
|
|
716
|
+
/** @description The anonymous perf results of the preference. */
|
|
717
|
+
anonymousPerfResults?: boolean;
|
|
718
|
+
/** @description The dashboard preferences of the preference. */
|
|
719
|
+
dashboardPreferences?: {
|
|
720
|
+
[key: string]: unknown;
|
|
721
|
+
};
|
|
722
|
+
/**
|
|
723
|
+
* Format: uuid
|
|
724
|
+
* @description ID of the organization to make the session's selected organization.
|
|
725
|
+
*/
|
|
726
|
+
selectedOrganizationId?: string;
|
|
727
|
+
/** @description The selected workspace for organizations of the preference. */
|
|
728
|
+
selectedWorkspaceForOrganizations?: {
|
|
729
|
+
[key: string]: string;
|
|
730
|
+
};
|
|
731
|
+
/** @description The users extension preferences of the preference. */
|
|
732
|
+
usersExtensionPreferences?: {
|
|
733
|
+
[key: string]: unknown;
|
|
734
|
+
};
|
|
735
|
+
/** @description The remote provider preferences of the preference. Writers set the typed agentsActWithoutApproval field, not a provider's free-form agentsActWithoutApproval entry. A token-authenticated request that would change the stored state of a provider's agentsActWithoutApproval entry (a different value, adding it where absent, or removing it where present) is answered 403, and no part of the payload is applied. Writing back the stored entry unchanged is accepted. Once the typed field has been written, the entry is never read again (see Preference.agentsActWithoutApproval). */
|
|
736
|
+
remoteProviderPreferences?: {
|
|
737
|
+
[key: string]: unknown;
|
|
738
|
+
};
|
|
739
|
+
/** @description Interim rule (temporary): until the upstream platform, workspace and profile policies exist, inherit (including absent) resolves to required, and this field is stored but not consulted by approval resolution (see Preference.agentsActWithoutApproval; the hierarchy proposal is https://github.com/layer5io/meshery-cloud/issues/6365). Target model, once the hierarchy places the profile level: one profile-level source for agent writes, consulted only for an AI-app activity whose approvalPolicy is inherit or absent, and only when no higher-level setting (hierarchy defined in https://github.com/layer5io/meshery-cloud/issues/6365) has decided (see Preference.agentsActWithoutApproval): true means not_required, false means required, and absent sets nothing. Three states on write: true or false stores that value; null clears the stored value back to absent (inherit); omitted keeps the stored value. No schema default is declared. An API token, of any kind, cannot set this field: a token-authenticated request whose payload names this field, with any value including null and whatever the stored state is, is answered 403 and no part of the payload is applied. Only a request authenticated by the signed-in session can set it. A token client doing read-modify-write must omit this field: echoing the value it read, or null, answers 403 for the whole payload. See docs/agent-approval-preference.md. */
|
|
740
|
+
agentsActWithoutApproval?: boolean | null;
|
|
647
741
|
};
|
|
648
742
|
/** @description Placeholder for Adapter struct definition. */
|
|
649
743
|
Adapter: Record<string, never>;
|
|
@@ -727,6 +821,15 @@ export interface components {
|
|
|
727
821
|
"text/plain": string;
|
|
728
822
|
};
|
|
729
823
|
};
|
|
824
|
+
/** @description Forbidden */
|
|
825
|
+
403: {
|
|
826
|
+
headers: {
|
|
827
|
+
[name: string]: unknown;
|
|
828
|
+
};
|
|
829
|
+
content: {
|
|
830
|
+
"text/plain": string;
|
|
831
|
+
};
|
|
832
|
+
};
|
|
730
833
|
/** @description Result not found */
|
|
731
834
|
404: {
|
|
732
835
|
headers: {
|
|
@@ -1055,4 +1158,121 @@ export interface operations {
|
|
|
1055
1158
|
};
|
|
1056
1159
|
};
|
|
1057
1160
|
};
|
|
1161
|
+
updateUserPreferences: {
|
|
1162
|
+
parameters: {
|
|
1163
|
+
query?: never;
|
|
1164
|
+
header?: never;
|
|
1165
|
+
path?: never;
|
|
1166
|
+
cookie?: never;
|
|
1167
|
+
};
|
|
1168
|
+
requestBody: {
|
|
1169
|
+
content: {
|
|
1170
|
+
"application/json": {
|
|
1171
|
+
/** @description The mesh adapters of the preference. */
|
|
1172
|
+
meshAdapters?: Record<string, never>[];
|
|
1173
|
+
grafana?: {
|
|
1174
|
+
/** @description Grafana URL for the user configuration. */
|
|
1175
|
+
grafanaUrl?: string;
|
|
1176
|
+
/** @description Grafana API key for the user configuration. */
|
|
1177
|
+
grafanaApiKey?: string;
|
|
1178
|
+
/** @description Selected Grafana board configurations for the user. */
|
|
1179
|
+
selectedBoardsConfigs?: {
|
|
1180
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
1181
|
+
board?: Record<string, never>;
|
|
1182
|
+
/** @description Panels selected for the Grafana board configuration. */
|
|
1183
|
+
panels?: Record<string, never>[];
|
|
1184
|
+
/** @description Template variables applied to the selected Grafana board configuration. */
|
|
1185
|
+
templateVars?: string[];
|
|
1186
|
+
}[];
|
|
1187
|
+
};
|
|
1188
|
+
prometheus?: {
|
|
1189
|
+
/** @description The prometheus URL of the prometheus. */
|
|
1190
|
+
prometheusUrl?: string;
|
|
1191
|
+
/** @description The selected prometheus boards configs of the prometheus. */
|
|
1192
|
+
selectedPrometheusBoardsConfigs?: {
|
|
1193
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
1194
|
+
board?: Record<string, never>;
|
|
1195
|
+
/** @description Panels selected for the Grafana board configuration. */
|
|
1196
|
+
panels?: Record<string, never>[];
|
|
1197
|
+
/** @description Template variables applied to the selected Grafana board configuration. */
|
|
1198
|
+
templateVars?: string[];
|
|
1199
|
+
}[];
|
|
1200
|
+
};
|
|
1201
|
+
loadTestPrefs?: {
|
|
1202
|
+
/** @description Concurrent requests */
|
|
1203
|
+
c?: number;
|
|
1204
|
+
/** @description Queries per second */
|
|
1205
|
+
qps?: number;
|
|
1206
|
+
/** @description Duration */
|
|
1207
|
+
t?: string;
|
|
1208
|
+
/** @description Load generator */
|
|
1209
|
+
gen?: string;
|
|
1210
|
+
};
|
|
1211
|
+
/** @description The anonymous usage stats of the preference. */
|
|
1212
|
+
anonymousUsageStats?: boolean;
|
|
1213
|
+
/** @description The anonymous perf results of the preference. */
|
|
1214
|
+
anonymousPerfResults?: boolean;
|
|
1215
|
+
/** @description The dashboard preferences of the preference. */
|
|
1216
|
+
dashboardPreferences?: {
|
|
1217
|
+
[key: string]: unknown;
|
|
1218
|
+
};
|
|
1219
|
+
/**
|
|
1220
|
+
* Format: uuid
|
|
1221
|
+
* @description ID of the organization to make the session's selected organization.
|
|
1222
|
+
*/
|
|
1223
|
+
selectedOrganizationId?: string;
|
|
1224
|
+
/** @description The selected workspace for organizations of the preference. */
|
|
1225
|
+
selectedWorkspaceForOrganizations?: {
|
|
1226
|
+
[key: string]: string;
|
|
1227
|
+
};
|
|
1228
|
+
/** @description The users extension preferences of the preference. */
|
|
1229
|
+
usersExtensionPreferences?: {
|
|
1230
|
+
[key: string]: unknown;
|
|
1231
|
+
};
|
|
1232
|
+
/** @description The remote provider preferences of the preference. Writers set the typed agentsActWithoutApproval field, not a provider's free-form agentsActWithoutApproval entry. A token-authenticated request that would change the stored state of a provider's agentsActWithoutApproval entry (a different value, adding it where absent, or removing it where present) is answered 403, and no part of the payload is applied. Writing back the stored entry unchanged is accepted. Once the typed field has been written, the entry is never read again (see Preference.agentsActWithoutApproval). */
|
|
1233
|
+
remoteProviderPreferences?: {
|
|
1234
|
+
[key: string]: unknown;
|
|
1235
|
+
};
|
|
1236
|
+
/** @description Interim rule (temporary): until the upstream platform, workspace and profile policies exist, inherit (including absent) resolves to required, and this field is stored but not consulted by approval resolution (see Preference.agentsActWithoutApproval; the hierarchy proposal is https://github.com/layer5io/meshery-cloud/issues/6365). Target model, once the hierarchy places the profile level: one profile-level source for agent writes, consulted only for an AI-app activity whose approvalPolicy is inherit or absent, and only when no higher-level setting (hierarchy defined in https://github.com/layer5io/meshery-cloud/issues/6365) has decided (see Preference.agentsActWithoutApproval): true means not_required, false means required, and absent sets nothing. Three states on write: true or false stores that value; null clears the stored value back to absent (inherit); omitted keeps the stored value. No schema default is declared. An API token, of any kind, cannot set this field: a token-authenticated request whose payload names this field, with any value including null and whatever the stored state is, is answered 403 and no part of the payload is applied. Only a request authenticated by the signed-in session can set it. A token client doing read-modify-write must omit this field: echoing the value it read, or null, answers 403 for the whole payload. See docs/agent-approval-preference.md. */
|
|
1237
|
+
agentsActWithoutApproval?: boolean | null;
|
|
1238
|
+
};
|
|
1239
|
+
};
|
|
1240
|
+
};
|
|
1241
|
+
responses: {
|
|
1242
|
+
/** @description Preferences updated */
|
|
1243
|
+
201: {
|
|
1244
|
+
headers: {
|
|
1245
|
+
[name: string]: unknown;
|
|
1246
|
+
};
|
|
1247
|
+
content?: never;
|
|
1248
|
+
};
|
|
1249
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1250
|
+
401: {
|
|
1251
|
+
headers: {
|
|
1252
|
+
[name: string]: unknown;
|
|
1253
|
+
};
|
|
1254
|
+
content: {
|
|
1255
|
+
"text/plain": string;
|
|
1256
|
+
};
|
|
1257
|
+
};
|
|
1258
|
+
/** @description Forbidden */
|
|
1259
|
+
403: {
|
|
1260
|
+
headers: {
|
|
1261
|
+
[name: string]: unknown;
|
|
1262
|
+
};
|
|
1263
|
+
content: {
|
|
1264
|
+
"text/plain": string;
|
|
1265
|
+
};
|
|
1266
|
+
};
|
|
1267
|
+
/** @description Internal server error */
|
|
1268
|
+
500: {
|
|
1269
|
+
headers: {
|
|
1270
|
+
[name: string]: unknown;
|
|
1271
|
+
};
|
|
1272
|
+
content: {
|
|
1273
|
+
"text/plain": string;
|
|
1274
|
+
};
|
|
1275
|
+
};
|
|
1276
|
+
};
|
|
1277
|
+
};
|
|
1058
1278
|
}
|