@meshery/schemas 1.3.116 → 1.3.117
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 +460 -4
- package/dist/cloudApi.d.ts +460 -4
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta3/connection/Connection.d.ts +17 -5
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
- package/dist/constructs/v1beta3/event/Event.d.ts +11 -10
- package/dist/constructs/v1beta3/event/EventSchema.js +5 -2
- package/dist/constructs/v1beta3/event/EventSchema.mjs +5 -2
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +390 -1
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +35 -15
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +35 -15
- package/dist/index.d.mts +8 -7
- package/dist/index.d.ts +8 -7
- package/package.json +1 -1
|
@@ -27,7 +27,8 @@ export interface paths {
|
|
|
27
27
|
* `scheduled` when the schedule has a due time and `pending` otherwise.
|
|
28
28
|
* `nextRunAt` defaults to `runAt`. A `targetId` must name a live
|
|
29
29
|
* resource of `targetType` in the organization, else 400. Send
|
|
30
|
-
* `paused: true` to create the schedule already paused.
|
|
30
|
+
* `paused: true` to create the schedule already paused. `visibility`
|
|
31
|
+
* defaults to `public`.
|
|
31
32
|
*/
|
|
32
33
|
post: operations["createSchedule"];
|
|
33
34
|
delete?: never;
|
|
@@ -124,6 +125,33 @@ export interface paths {
|
|
|
124
125
|
patch?: never;
|
|
125
126
|
trace?: never;
|
|
126
127
|
};
|
|
128
|
+
"/api/public/activity-feed": {
|
|
129
|
+
parameters: {
|
|
130
|
+
query?: never;
|
|
131
|
+
header?: never;
|
|
132
|
+
path?: never;
|
|
133
|
+
cookie?: never;
|
|
134
|
+
};
|
|
135
|
+
/**
|
|
136
|
+
* Get public activity feed
|
|
137
|
+
* @description Returns a paginated, unauthenticated feed of completed schedule runs
|
|
138
|
+
* whose visibility is `public` and whose owner's `shareActivityPublicly`
|
|
139
|
+
* preference is on at read time. Results are ordered newest first by
|
|
140
|
+
* `completedAt`. Rate limited per client IP; an over-limit client
|
|
141
|
+
* receives 429 with `Retry-After`. Responses carry
|
|
142
|
+
* `Cache-Control: public, max-age=N` where N is at most 30 seconds.
|
|
143
|
+
* Browsers may call this route cross-origin (CORS-enabled GET/OPTIONS
|
|
144
|
+
* only, without credentials).
|
|
145
|
+
*/
|
|
146
|
+
get: operations["getPublicActivityFeed"];
|
|
147
|
+
put?: never;
|
|
148
|
+
post?: never;
|
|
149
|
+
delete?: never;
|
|
150
|
+
options?: never;
|
|
151
|
+
head?: never;
|
|
152
|
+
patch?: never;
|
|
153
|
+
trace?: never;
|
|
154
|
+
};
|
|
127
155
|
}
|
|
128
156
|
export type webhooks = Record<string, never>;
|
|
129
157
|
export interface components {
|
|
@@ -379,6 +407,15 @@ export interface components {
|
|
|
379
407
|
* @enum {string}
|
|
380
408
|
*/
|
|
381
409
|
posture?: "cautious" | "standard" | "brisk";
|
|
410
|
+
/**
|
|
411
|
+
* @description Visibility of the schedule: `public` (the default) allows completed runs
|
|
412
|
+
* to appear on the unauthenticated public activity feed (subject to user
|
|
413
|
+
* preferences), `org` restricts visibility to members of the schedule's
|
|
414
|
+
* organization, and `private` restricts it to the schedule owner.
|
|
415
|
+
* @default public
|
|
416
|
+
* @enum {string}
|
|
417
|
+
*/
|
|
418
|
+
visibility: "public" | "org" | "private";
|
|
382
419
|
};
|
|
383
420
|
/**
|
|
384
421
|
* @description Lifecycle status of a schedule. `pending`: created, not yet
|
|
@@ -421,6 +458,14 @@ export interface components {
|
|
|
421
458
|
* not at all.
|
|
422
459
|
*/
|
|
423
460
|
ScheduleTargetType: string;
|
|
461
|
+
/**
|
|
462
|
+
* @description Visibility of the schedule: `public` allows completed runs to appear on
|
|
463
|
+
* the unauthenticated public activity feed (subject to user preferences),
|
|
464
|
+
* `org` restricts visibility to members of the owning organization, and
|
|
465
|
+
* `private` restricts it to the schedule owner.
|
|
466
|
+
* @enum {string}
|
|
467
|
+
*/
|
|
468
|
+
ScheduleVisibility: "public" | "org" | "private";
|
|
424
469
|
/**
|
|
425
470
|
* @description Payload for creating or updating a schedule. Contains only
|
|
426
471
|
* client-settable fields; the owning `organizationId`, `createdBy`, the
|
|
@@ -539,6 +584,13 @@ export interface components {
|
|
|
539
584
|
* @enum {string}
|
|
540
585
|
*/
|
|
541
586
|
posture?: "cautious" | "standard" | "brisk";
|
|
587
|
+
/**
|
|
588
|
+
* @description Visibility of the schedule: `public`, `org`, or `private`.
|
|
589
|
+
* Defaults to `public` on creation. Omitted on update, the existing
|
|
590
|
+
* visibility is preserved.
|
|
591
|
+
* @enum {string}
|
|
592
|
+
*/
|
|
593
|
+
visibility?: "public" | "org" | "private";
|
|
542
594
|
};
|
|
543
595
|
/** @description Paginated collection of schedules. */
|
|
544
596
|
SchedulePage: {
|
|
@@ -782,6 +834,158 @@ export interface components {
|
|
|
782
834
|
* @enum {string}
|
|
783
835
|
*/
|
|
784
836
|
posture?: "cautious" | "standard" | "brisk";
|
|
837
|
+
/**
|
|
838
|
+
* @description Visibility of the schedule: `public` (the default) allows completed runs
|
|
839
|
+
* to appear on the unauthenticated public activity feed (subject to user
|
|
840
|
+
* preferences), `org` restricts visibility to members of the schedule's
|
|
841
|
+
* organization, and `private` restricts it to the schedule owner.
|
|
842
|
+
* @default public
|
|
843
|
+
* @enum {string}
|
|
844
|
+
*/
|
|
845
|
+
visibility: "public" | "org" | "private";
|
|
846
|
+
}[];
|
|
847
|
+
};
|
|
848
|
+
/**
|
|
849
|
+
* @description A completed schedule run projected into the public feed. Never includes
|
|
850
|
+
* email addresses, real names, or raw metadata. Public profile fields are
|
|
851
|
+
* resolved at read time for every served owner (live, active, and
|
|
852
|
+
* shareActivityPublicly on).
|
|
853
|
+
*/
|
|
854
|
+
PublicActivityFeedItem: {
|
|
855
|
+
/**
|
|
856
|
+
* Format: uuid
|
|
857
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
858
|
+
*/
|
|
859
|
+
userId: string;
|
|
860
|
+
/**
|
|
861
|
+
* @description Social platform the schedule ran on.
|
|
862
|
+
* @enum {string}
|
|
863
|
+
*/
|
|
864
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
865
|
+
/** @description One-line role and result summary from the completed run. */
|
|
866
|
+
roleResult: string;
|
|
867
|
+
/**
|
|
868
|
+
* Format: date-time
|
|
869
|
+
* @description Time the schedule run completed; feed is ordered newest first.
|
|
870
|
+
*/
|
|
871
|
+
completedAt: string;
|
|
872
|
+
/**
|
|
873
|
+
* @description Always `public` in this feed.
|
|
874
|
+
* @default public
|
|
875
|
+
* @enum {string}
|
|
876
|
+
*/
|
|
877
|
+
visibility: "public";
|
|
878
|
+
/** @description The same value PublicUser.username carries for the owner. Never email. Resolved for every served owner; omitted when empty. */
|
|
879
|
+
displayName?: string;
|
|
880
|
+
/**
|
|
881
|
+
* Format: uri
|
|
882
|
+
* @description Public avatar URL; resolved for every served owner, omitted when empty.
|
|
883
|
+
*/
|
|
884
|
+
avatarUrl?: string;
|
|
885
|
+
/** @description Public organization name; omitted when organization memberships are not public to an anonymous caller. */
|
|
886
|
+
organizationName?: string;
|
|
887
|
+
/**
|
|
888
|
+
* Format: uri
|
|
889
|
+
* @description HTTPS URL of the user's public profile.
|
|
890
|
+
*/
|
|
891
|
+
publicProfileUrl?: string;
|
|
892
|
+
};
|
|
893
|
+
/** @description One page of public activity feed items, newest first. */
|
|
894
|
+
PublicActivityFeedPage: {
|
|
895
|
+
/** @description Current page number. */
|
|
896
|
+
page: number;
|
|
897
|
+
/** @description Number of items per page; maximum 50. */
|
|
898
|
+
pageSize: number;
|
|
899
|
+
/** @description Total number of items available. */
|
|
900
|
+
totalCount: number;
|
|
901
|
+
/** @description Feed items included on this page, newest first. */
|
|
902
|
+
data: {
|
|
903
|
+
/**
|
|
904
|
+
* Format: uuid
|
|
905
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
906
|
+
*/
|
|
907
|
+
userId: string;
|
|
908
|
+
/**
|
|
909
|
+
* @description Social platform the schedule ran on.
|
|
910
|
+
* @enum {string}
|
|
911
|
+
*/
|
|
912
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
913
|
+
/** @description One-line role and result summary from the completed run. */
|
|
914
|
+
roleResult: string;
|
|
915
|
+
/**
|
|
916
|
+
* Format: date-time
|
|
917
|
+
* @description Time the schedule run completed; feed is ordered newest first.
|
|
918
|
+
*/
|
|
919
|
+
completedAt: string;
|
|
920
|
+
/**
|
|
921
|
+
* @description Always `public` in this feed.
|
|
922
|
+
* @default public
|
|
923
|
+
* @enum {string}
|
|
924
|
+
*/
|
|
925
|
+
visibility: "public";
|
|
926
|
+
/** @description The same value PublicUser.username carries for the owner. Never email. Resolved for every served owner; omitted when empty. */
|
|
927
|
+
displayName?: string;
|
|
928
|
+
/**
|
|
929
|
+
* Format: uri
|
|
930
|
+
* @description Public avatar URL; resolved for every served owner, omitted when empty.
|
|
931
|
+
*/
|
|
932
|
+
avatarUrl?: string;
|
|
933
|
+
/** @description Public organization name; omitted when organization memberships are not public to an anonymous caller. */
|
|
934
|
+
organizationName?: string;
|
|
935
|
+
/**
|
|
936
|
+
* Format: uri
|
|
937
|
+
* @description HTTPS URL of the user's public profile.
|
|
938
|
+
*/
|
|
939
|
+
publicProfileUrl?: string;
|
|
940
|
+
}[];
|
|
941
|
+
};
|
|
942
|
+
/** @description One page of public activity feed items, newest first. */
|
|
943
|
+
PublicActivityFeed: {
|
|
944
|
+
/** @description Current page number. */
|
|
945
|
+
page: number;
|
|
946
|
+
/** @description Number of items per page; maximum 50. */
|
|
947
|
+
pageSize: number;
|
|
948
|
+
/** @description Total number of items available. */
|
|
949
|
+
totalCount: number;
|
|
950
|
+
/** @description Feed items included on this page, newest first. */
|
|
951
|
+
data: {
|
|
952
|
+
/**
|
|
953
|
+
* Format: uuid
|
|
954
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
955
|
+
*/
|
|
956
|
+
userId: string;
|
|
957
|
+
/**
|
|
958
|
+
* @description Social platform the schedule ran on.
|
|
959
|
+
* @enum {string}
|
|
960
|
+
*/
|
|
961
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
962
|
+
/** @description One-line role and result summary from the completed run. */
|
|
963
|
+
roleResult: string;
|
|
964
|
+
/**
|
|
965
|
+
* Format: date-time
|
|
966
|
+
* @description Time the schedule run completed; feed is ordered newest first.
|
|
967
|
+
*/
|
|
968
|
+
completedAt: string;
|
|
969
|
+
/**
|
|
970
|
+
* @description Always `public` in this feed.
|
|
971
|
+
* @default public
|
|
972
|
+
* @enum {string}
|
|
973
|
+
*/
|
|
974
|
+
visibility: "public";
|
|
975
|
+
/** @description The same value PublicUser.username carries for the owner. Never email. Resolved for every served owner; omitted when empty. */
|
|
976
|
+
displayName?: string;
|
|
977
|
+
/**
|
|
978
|
+
* Format: uri
|
|
979
|
+
* @description Public avatar URL; resolved for every served owner, omitted when empty.
|
|
980
|
+
*/
|
|
981
|
+
avatarUrl?: string;
|
|
982
|
+
/** @description Public organization name; omitted when organization memberships are not public to an anonymous caller. */
|
|
983
|
+
organizationName?: string;
|
|
984
|
+
/**
|
|
985
|
+
* Format: uri
|
|
986
|
+
* @description HTTPS URL of the user's public profile.
|
|
987
|
+
*/
|
|
988
|
+
publicProfileUrl?: string;
|
|
785
989
|
}[];
|
|
786
990
|
};
|
|
787
991
|
};
|
|
@@ -1146,6 +1350,15 @@ export interface operations {
|
|
|
1146
1350
|
* @enum {string}
|
|
1147
1351
|
*/
|
|
1148
1352
|
posture?: "cautious" | "standard" | "brisk";
|
|
1353
|
+
/**
|
|
1354
|
+
* @description Visibility of the schedule: `public` (the default) allows completed runs
|
|
1355
|
+
* to appear on the unauthenticated public activity feed (subject to user
|
|
1356
|
+
* preferences), `org` restricts visibility to members of the schedule's
|
|
1357
|
+
* organization, and `private` restricts it to the schedule owner.
|
|
1358
|
+
* @default public
|
|
1359
|
+
* @enum {string}
|
|
1360
|
+
*/
|
|
1361
|
+
visibility: "public" | "org" | "private";
|
|
1149
1362
|
}[];
|
|
1150
1363
|
};
|
|
1151
1364
|
};
|
|
@@ -1330,6 +1543,13 @@ export interface operations {
|
|
|
1330
1543
|
* @enum {string}
|
|
1331
1544
|
*/
|
|
1332
1545
|
posture?: "cautious" | "standard" | "brisk";
|
|
1546
|
+
/**
|
|
1547
|
+
* @description Visibility of the schedule: `public`, `org`, or `private`.
|
|
1548
|
+
* Defaults to `public` on creation. Omitted on update, the existing
|
|
1549
|
+
* visibility is preserved.
|
|
1550
|
+
* @enum {string}
|
|
1551
|
+
*/
|
|
1552
|
+
visibility?: "public" | "org" | "private";
|
|
1333
1553
|
};
|
|
1334
1554
|
};
|
|
1335
1555
|
};
|
|
@@ -1575,6 +1795,15 @@ export interface operations {
|
|
|
1575
1795
|
* @enum {string}
|
|
1576
1796
|
*/
|
|
1577
1797
|
posture?: "cautious" | "standard" | "brisk";
|
|
1798
|
+
/**
|
|
1799
|
+
* @description Visibility of the schedule: `public` (the default) allows completed runs
|
|
1800
|
+
* to appear on the unauthenticated public activity feed (subject to user
|
|
1801
|
+
* preferences), `org` restricts visibility to members of the schedule's
|
|
1802
|
+
* organization, and `private` restricts it to the schedule owner.
|
|
1803
|
+
* @default public
|
|
1804
|
+
* @enum {string}
|
|
1805
|
+
*/
|
|
1806
|
+
visibility: "public" | "org" | "private";
|
|
1578
1807
|
};
|
|
1579
1808
|
};
|
|
1580
1809
|
};
|
|
@@ -1894,6 +2123,15 @@ export interface operations {
|
|
|
1894
2123
|
* @enum {string}
|
|
1895
2124
|
*/
|
|
1896
2125
|
posture?: "cautious" | "standard" | "brisk";
|
|
2126
|
+
/**
|
|
2127
|
+
* @description Visibility of the schedule: `public` (the default) allows completed runs
|
|
2128
|
+
* to appear on the unauthenticated public activity feed (subject to user
|
|
2129
|
+
* preferences), `org` restricts visibility to members of the schedule's
|
|
2130
|
+
* organization, and `private` restricts it to the schedule owner.
|
|
2131
|
+
* @default public
|
|
2132
|
+
* @enum {string}
|
|
2133
|
+
*/
|
|
2134
|
+
visibility: "public" | "org" | "private";
|
|
1897
2135
|
};
|
|
1898
2136
|
};
|
|
1899
2137
|
};
|
|
@@ -2074,6 +2312,13 @@ export interface operations {
|
|
|
2074
2312
|
* @enum {string}
|
|
2075
2313
|
*/
|
|
2076
2314
|
posture?: "cautious" | "standard" | "brisk";
|
|
2315
|
+
/**
|
|
2316
|
+
* @description Visibility of the schedule: `public`, `org`, or `private`.
|
|
2317
|
+
* Defaults to `public` on creation. Omitted on update, the existing
|
|
2318
|
+
* visibility is preserved.
|
|
2319
|
+
* @enum {string}
|
|
2320
|
+
*/
|
|
2321
|
+
visibility?: "public" | "org" | "private";
|
|
2077
2322
|
};
|
|
2078
2323
|
};
|
|
2079
2324
|
};
|
|
@@ -2319,6 +2564,15 @@ export interface operations {
|
|
|
2319
2564
|
* @enum {string}
|
|
2320
2565
|
*/
|
|
2321
2566
|
posture?: "cautious" | "standard" | "brisk";
|
|
2567
|
+
/**
|
|
2568
|
+
* @description Visibility of the schedule: `public` (the default) allows completed runs
|
|
2569
|
+
* to appear on the unauthenticated public activity feed (subject to user
|
|
2570
|
+
* preferences), `org` restricts visibility to members of the schedule's
|
|
2571
|
+
* organization, and `private` restricts it to the schedule owner.
|
|
2572
|
+
* @default public
|
|
2573
|
+
* @enum {string}
|
|
2574
|
+
*/
|
|
2575
|
+
visibility: "public" | "org" | "private";
|
|
2322
2576
|
};
|
|
2323
2577
|
};
|
|
2324
2578
|
};
|
|
@@ -2735,6 +2989,15 @@ export interface operations {
|
|
|
2735
2989
|
* @enum {string}
|
|
2736
2990
|
*/
|
|
2737
2991
|
posture?: "cautious" | "standard" | "brisk";
|
|
2992
|
+
/**
|
|
2993
|
+
* @description Visibility of the schedule: `public` (the default) allows completed runs
|
|
2994
|
+
* to appear on the unauthenticated public activity feed (subject to user
|
|
2995
|
+
* preferences), `org` restricts visibility to members of the schedule's
|
|
2996
|
+
* organization, and `private` restricts it to the schedule owner.
|
|
2997
|
+
* @default public
|
|
2998
|
+
* @enum {string}
|
|
2999
|
+
*/
|
|
3000
|
+
visibility: "public" | "org" | "private";
|
|
2738
3001
|
}[];
|
|
2739
3002
|
};
|
|
2740
3003
|
};
|
|
@@ -3055,6 +3318,15 @@ export interface operations {
|
|
|
3055
3318
|
* @enum {string}
|
|
3056
3319
|
*/
|
|
3057
3320
|
posture?: "cautious" | "standard" | "brisk";
|
|
3321
|
+
/**
|
|
3322
|
+
* @description Visibility of the schedule: `public` (the default) allows completed runs
|
|
3323
|
+
* to appear on the unauthenticated public activity feed (subject to user
|
|
3324
|
+
* preferences), `org` restricts visibility to members of the schedule's
|
|
3325
|
+
* organization, and `private` restricts it to the schedule owner.
|
|
3326
|
+
* @default public
|
|
3327
|
+
* @enum {string}
|
|
3328
|
+
*/
|
|
3329
|
+
visibility: "public" | "org" | "private";
|
|
3058
3330
|
};
|
|
3059
3331
|
};
|
|
3060
3332
|
};
|
|
@@ -3196,4 +3468,121 @@ export interface operations {
|
|
|
3196
3468
|
};
|
|
3197
3469
|
};
|
|
3198
3470
|
};
|
|
3471
|
+
getPublicActivityFeed: {
|
|
3472
|
+
parameters: {
|
|
3473
|
+
query?: {
|
|
3474
|
+
/** @description Page number. */
|
|
3475
|
+
page?: number;
|
|
3476
|
+
/** @description Number of items per page. */
|
|
3477
|
+
pageSize?: number;
|
|
3478
|
+
};
|
|
3479
|
+
header?: never;
|
|
3480
|
+
path?: never;
|
|
3481
|
+
cookie?: never;
|
|
3482
|
+
};
|
|
3483
|
+
requestBody?: never;
|
|
3484
|
+
responses: {
|
|
3485
|
+
/** @description Public activity feed page */
|
|
3486
|
+
200: {
|
|
3487
|
+
headers: {
|
|
3488
|
+
/** @description `public, max-age=N` with N from 0 to 30; max-age never exceeds 30 seconds. */
|
|
3489
|
+
"Cache-Control": string;
|
|
3490
|
+
[name: string]: unknown;
|
|
3491
|
+
};
|
|
3492
|
+
content: {
|
|
3493
|
+
"application/json": {
|
|
3494
|
+
/** @description Current page number. */
|
|
3495
|
+
page: number;
|
|
3496
|
+
/** @description Number of items per page; maximum 50. */
|
|
3497
|
+
pageSize: number;
|
|
3498
|
+
/** @description Total number of items available. */
|
|
3499
|
+
totalCount: number;
|
|
3500
|
+
/** @description Feed items included on this page, newest first. */
|
|
3501
|
+
data: {
|
|
3502
|
+
/**
|
|
3503
|
+
* Format: uuid
|
|
3504
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
3505
|
+
*/
|
|
3506
|
+
userId: string;
|
|
3507
|
+
/**
|
|
3508
|
+
* @description Social platform the schedule ran on.
|
|
3509
|
+
* @enum {string}
|
|
3510
|
+
*/
|
|
3511
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
3512
|
+
/** @description One-line role and result summary from the completed run. */
|
|
3513
|
+
roleResult: string;
|
|
3514
|
+
/**
|
|
3515
|
+
* Format: date-time
|
|
3516
|
+
* @description Time the schedule run completed; feed is ordered newest first.
|
|
3517
|
+
*/
|
|
3518
|
+
completedAt: string;
|
|
3519
|
+
/**
|
|
3520
|
+
* @description Always `public` in this feed.
|
|
3521
|
+
* @default public
|
|
3522
|
+
* @enum {string}
|
|
3523
|
+
*/
|
|
3524
|
+
visibility: "public";
|
|
3525
|
+
/** @description The same value PublicUser.username carries for the owner. Never email. Resolved for every served owner; omitted when empty. */
|
|
3526
|
+
displayName?: string;
|
|
3527
|
+
/**
|
|
3528
|
+
* Format: uri
|
|
3529
|
+
* @description Public avatar URL; resolved for every served owner, omitted when empty.
|
|
3530
|
+
*/
|
|
3531
|
+
avatarUrl?: string;
|
|
3532
|
+
/** @description Public organization name; omitted when organization memberships are not public to an anonymous caller. */
|
|
3533
|
+
organizationName?: string;
|
|
3534
|
+
/**
|
|
3535
|
+
* Format: uri
|
|
3536
|
+
* @description HTTPS URL of the user's public profile.
|
|
3537
|
+
*/
|
|
3538
|
+
publicProfileUrl?: string;
|
|
3539
|
+
}[];
|
|
3540
|
+
};
|
|
3541
|
+
};
|
|
3542
|
+
};
|
|
3543
|
+
/** @description Invalid request body or request param */
|
|
3544
|
+
400: {
|
|
3545
|
+
headers: {
|
|
3546
|
+
[name: string]: unknown;
|
|
3547
|
+
};
|
|
3548
|
+
content: {
|
|
3549
|
+
"text/plain": string;
|
|
3550
|
+
};
|
|
3551
|
+
};
|
|
3552
|
+
/** @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. */
|
|
3553
|
+
429: {
|
|
3554
|
+
headers: {
|
|
3555
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
3556
|
+
"Retry-After": number;
|
|
3557
|
+
[name: string]: unknown;
|
|
3558
|
+
};
|
|
3559
|
+
content: {
|
|
3560
|
+
"application/json": {
|
|
3561
|
+
/** @description The sentence the caller is shown. */
|
|
3562
|
+
error: string;
|
|
3563
|
+
/** @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. */
|
|
3564
|
+
code?: string;
|
|
3565
|
+
/**
|
|
3566
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
3567
|
+
* @enum {string}
|
|
3568
|
+
*/
|
|
3569
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
3570
|
+
/** @description MeshKit's probable causes of the error. */
|
|
3571
|
+
probableCause?: string[];
|
|
3572
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
3573
|
+
suggestedRemediation?: string[];
|
|
3574
|
+
};
|
|
3575
|
+
};
|
|
3576
|
+
};
|
|
3577
|
+
/** @description Internal server error */
|
|
3578
|
+
500: {
|
|
3579
|
+
headers: {
|
|
3580
|
+
[name: string]: unknown;
|
|
3581
|
+
};
|
|
3582
|
+
content: {
|
|
3583
|
+
"text/plain": string;
|
|
3584
|
+
};
|
|
3585
|
+
};
|
|
3586
|
+
};
|
|
3587
|
+
};
|
|
3199
3588
|
}
|