@meshery/schemas 1.3.102 → 1.3.104

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 (67) hide show
  1. package/dist/cloudApi.d.mts +4496 -4098
  2. package/dist/cloudApi.d.ts +4496 -4098
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1alpha1/core/Core.d.ts +1 -1
  6. package/dist/constructs/v1alpha1/core/CoreSchema.js +1 -1
  7. package/dist/constructs/v1alpha1/core/CoreSchema.mjs +1 -1
  8. package/dist/constructs/v1beta1/diagnostics/Diagnostics.d.ts +536 -0
  9. package/dist/constructs/v1beta1/diagnostics/Diagnostics.js +1 -0
  10. package/dist/constructs/v1beta1/diagnostics/Diagnostics.mjs +0 -0
  11. package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.d.ts +2 -0
  12. package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.js +2 -0
  13. package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.mjs +2 -0
  14. package/dist/constructs/v1beta1/support/Support.d.ts +373 -0
  15. package/dist/constructs/v1beta1/support/SupportSchema.js +1 -1
  16. package/dist/constructs/v1beta1/support/SupportSchema.mjs +1 -1
  17. package/dist/constructs/v1beta2/core/Core.d.ts +26 -1
  18. package/dist/constructs/v1beta2/core/CoreSchema.js +1 -1
  19. package/dist/constructs/v1beta2/core/CoreSchema.mjs +1 -1
  20. package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.d.ts +186 -0
  21. package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.js +1 -0
  22. package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.mjs +0 -0
  23. package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.d.ts +2 -0
  24. package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.js +25 -0
  25. package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.mjs +25 -0
  26. package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealth.d.ts +50 -0
  27. package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.js +1 -1
  28. package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.mjs +1 -1
  29. package/dist/constructs/v1beta3/claim/Claim.d.ts +150 -0
  30. package/dist/constructs/v1beta3/claim/ClaimSchema.js +2 -2
  31. package/dist/constructs/v1beta3/claim/ClaimSchema.mjs +2 -2
  32. package/dist/constructs/v1beta3/connection/Connection.d.ts +100 -0
  33. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
  34. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
  35. package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +150 -0
  36. package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +5 -5
  37. package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +5 -5
  38. package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.js +1 -1
  39. package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.mjs +1 -1
  40. package/dist/constructs/v1beta3/design/DesignSchema.js +5 -5
  41. package/dist/constructs/v1beta3/design/DesignSchema.mjs +5 -5
  42. package/dist/constructs/v1beta3/event/Event.d.ts +275 -0
  43. package/dist/constructs/v1beta3/event/EventSchema.js +3 -3
  44. package/dist/constructs/v1beta3/event/EventSchema.mjs +3 -3
  45. package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.js +1 -1
  46. package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.mjs +1 -1
  47. package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.js +1 -1
  48. package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.mjs +1 -1
  49. package/dist/constructs/v1beta3/github/GithubSchema.js +1 -1
  50. package/dist/constructs/v1beta3/github/GithubSchema.mjs +1 -1
  51. package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
  52. package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
  53. package/dist/constructs/v1beta3/ledger/Ledger.d.ts +175 -0
  54. package/dist/constructs/v1beta3/ledger/LedgerSchema.js +5 -5
  55. package/dist/constructs/v1beta3/ledger/LedgerSchema.mjs +5 -5
  56. package/dist/constructs/v1beta3/profile/Profile.d.ts +225 -0
  57. package/dist/constructs/v1beta3/profile/ProfileSchema.js +1 -1
  58. package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +1 -1
  59. package/dist/constructs/v1beta3/provider_capability/ProviderCapability.d.ts +50 -0
  60. package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.js +1 -1
  61. package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.mjs +1 -1
  62. package/dist/constructs/v1beta3/schedule/Schedule.d.ts +225 -0
  63. package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +8 -8
  64. package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +8 -8
  65. package/dist/index.d.mts +1 -1
  66. package/dist/index.d.ts +1 -1
  67. package/package.json +1 -1
@@ -0,0 +1,25 @@
1
+ var e={openapi:"3.0.0",info:{title:"Activity Metrics",description:"OpenAPI schema for per-activity reception figures for one post,\nconsumed by Blowhorn's analytics store. The rows have no endpoints of\ntheir own: they are recorded and read back as the `metadata` of events\non the events service (category `blowhorn`, action `activity_metrics`;\nsee the event construct), so this file declares the components only and\nthe paths stay with the event construct.\n",version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},paths:{},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{ActivityMetrics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Activity Metrics Schema",description:`Server-returned per-activity reception figures for one post, as recorded
2
+ in the \`metadata\` of an event on the events service (category \`blowhorn\`,
3
+ action \`activity_metrics\`); the event construct carries the envelope and
4
+ this construct names the metadata's own shape, which Event leaves open.
5
+ One row is one activity as one export read it, identified by
6
+ (organizationId, platform, activityRef, readingDate): a later export adds a
7
+ reading rather than replacing an earlier one, so the rows are a time series
8
+ and the reading with the latest readingDate is an activity's current
9
+ figures. The events service appends and enforces no uniqueness, so
10
+ re-importing an export records the same key twice: readers take, for each
11
+ key, the most recently recorded event and must not sum duplicates. The figures come from a
12
+ LinkedIn page content export's "All posts" sheet, whose header sits under
13
+ a disclaimer row; readingDate is that export's date, the day the figures
14
+ were true as of. \`matched\` records whether the row's link resolved to a
15
+ stored content activity at import (through \`content.promotion_link\`,
16
+ per-profile entries of an \`all\` row included); an unmatched row is kept,
17
+ not dropped - the post was made outside Blowhorn and is still the page's
18
+ reception. Every figure is nullable: a blank figure in the source export
19
+ is not a zero.
20
+ `,type:"object",additionalProperties:false,required:["organizationId","platform","activityRef","readingDate","subject","link","matched","sourceFile"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",maxLength:64,description:"The platform the activity was posted to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},activityRef:{type:"string",maxLength:255,description:"The activity's platform identifier, normalized to its URN (`urn:li:activity:<id>`, `urn:li:share:<id>` or `urn:li:ugcPost:<id>`) so the encoded and plain spellings of one link agree. The URN kind is kept, so one post reached as both an activity URN and a share URN is two activityRefs; the exports name each post by one link, so readings of the same post line up across exports.","x-oapi-codegen-extra-tags":{db:"activity_ref"},"x-order":3},readingDate:{type:"string",format:"date",description:"The export's date - the day the figures were read as of, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},subject:{type:"string",maxLength:255,description:"The page the export belongs to, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":5},link:{type:"string",maxLength:2048,description:"The post link as the export spelled it, before normalization to `activityRef`.","x-oapi-codegen-extra-tags":{db:"link"},"x-order":6},title:{type:"string",maxLength:3e3,nullable:true,description:"The post's title as the export gives it; null when the export names none.","x-oapi-codegen-extra-tags":{db:"title"},"x-order":7},postType:{type:"string",maxLength:64,nullable:true,description:"The post's type as the export gives it (for example `Organic`); null when the export names none.","x-oapi-codegen-extra-tags":{db:"post_type"},"x-order":8},postedBy:{type:"string",maxLength:255,nullable:true,description:"Who the export says posted the activity; null when the export names none.","x-oapi-codegen-extra-tags":{db:"posted_by"},"x-order":9},createdDate:{type:"string",format:"date",nullable:true,description:"The day the activity was created, as an ISO calendar date; null when the export names none.","x-oapi-codegen-extra-tags":{db:"created_date"},"x-order":10},audience:{type:"string",maxLength:255,nullable:true,description:"The audience the export names for the activity; null when it names none.","x-oapi-codegen-extra-tags":{db:"audience"},"x-order":11},contentType:{type:"string",maxLength:64,nullable:true,description:"The content type the export names for the activity; null when it names none.","x-oapi-codegen-extra-tags":{db:"content_type"},"x-order":12},impressions:{type:"integer",nullable:true,minimum:0,description:"Impressions the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"impressions"},"x-order":13},views:{type:"integer",nullable:true,minimum:0,description:"Views the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"views"},"x-order":14},offsiteViews:{type:"integer",nullable:true,minimum:0,description:"Offsite views the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"offsite_views"},"x-order":15},clicks:{type:"integer",nullable:true,minimum:0,description:"Clicks the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"clicks"},"x-order":16},clickThroughRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"click_through_rate"},"x-order":17},likes:{type:"integer",nullable:true,minimum:0,description:"Likes the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"likes"},"x-order":18},comments:{type:"integer",nullable:true,minimum:0,description:"Comments the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"comments"},"x-order":19},reposts:{type:"integer",nullable:true,minimum:0,description:"Reposts the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reposts"},"x-order":20},follows:{type:"integer",nullable:true,minimum:0,description:"Follows the activity had produced by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"follows"},"x-order":21},engagementRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"engagement_rate"},"x-order":22},matched:{type:"boolean",description:"Whether the activity's link resolved to a stored content activity at import.","x-oapi-codegen-extra-tags":{db:"matched"},"x-order":23},contentRow:{type:"integer",nullable:true,minimum:0,description:"The content row the activity matched, when it matched; null for an unmatched activity.","x-oapi-codegen-extra-tags":{db:"content_row"},"x-order":24},contentProfile:{type:"string",maxLength:255,nullable:true,description:"The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched.","x-oapi-codegen-extra-tags":{db:"content_profile"},"x-order":25},sourceFile:{type:"string",maxLength:1024,description:"The export file the row was read from; empty when the row did not come from a file export.","x-oapi-codegen-extra-tags":{db:"source_file"},"x-order":26}}},ActivityMetricsPayload:{$schema:"http://json-schema.org/draft-07/schema#",title:"Activity Metrics Payload Schema",description:`Payload for recording one activity's reception figures as of one export,
21
+ sent as the \`metadata\` of a create-event call. Contains only
22
+ client-settable fields; the row has no server-generated fields, because
23
+ the events service stores and returns event metadata verbatim, so the
24
+ payload and the recorded row (ActivityMetrics) share one field set.
25
+ `,type:"object",additionalProperties:false,required:["organizationId","platform","activityRef","readingDate","subject","link","matched","sourceFile"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID"},platform:{type:"string",maxLength:64,description:"The platform the activity was posted to (today only `linkedin` produces these exports)."},activityRef:{type:"string",maxLength:255,description:"The activity's platform identifier, normalized to its URN (`urn:li:activity:<id>`, `urn:li:share:<id>` or `urn:li:ugcPost:<id>`) so the encoded and plain spellings of one link agree. The URN kind is kept, so one post reached as both an activity URN and a share URN is two activityRefs; the exports name each post by one link, so readings of the same post line up across exports."},readingDate:{type:"string",format:"date",description:"The export's date - the day the figures were read as of, as an ISO calendar date."},subject:{type:"string",maxLength:255,description:"The page the export belongs to, named as the source export names it."},link:{type:"string",maxLength:2048,description:"The post link as the export spelled it, before normalization to `activityRef`."},title:{type:"string",maxLength:3e3,nullable:true,description:"The post's title as the export gives it; null when the export names none."},postType:{type:"string",maxLength:64,nullable:true,description:"The post's type as the export gives it (for example `Organic`); null when the export names none."},postedBy:{type:"string",maxLength:255,nullable:true,description:"Who the export says posted the activity; null when the export names none."},createdDate:{type:"string",format:"date",nullable:true,description:"The day the activity was created, as an ISO calendar date; null when the export names none."},audience:{type:"string",maxLength:255,nullable:true,description:"The audience the export names for the activity; null when it names none."},contentType:{type:"string",maxLength:64,nullable:true,description:"The content type the export names for the activity; null when it names none."},impressions:{type:"integer",nullable:true,minimum:0,description:"Impressions the activity had gathered by the reading date; null when the export's cell is blank."},views:{type:"integer",nullable:true,minimum:0,description:"Views the activity had gathered by the reading date; null when the export's cell is blank."},offsiteViews:{type:"integer",nullable:true,minimum:0,description:"Offsite views the activity had gathered by the reading date; null when the export's cell is blank."},clicks:{type:"integer",nullable:true,minimum:0,description:"Clicks the activity had gathered by the reading date; null when the export's cell is blank."},clickThroughRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank."},likes:{type:"integer",nullable:true,minimum:0,description:"Likes the activity had gathered by the reading date; null when the export's cell is blank."},comments:{type:"integer",nullable:true,minimum:0,description:"Comments the activity had gathered by the reading date; null when the export's cell is blank."},reposts:{type:"integer",nullable:true,minimum:0,description:"Reposts the activity had gathered by the reading date; null when the export's cell is blank."},follows:{type:"integer",nullable:true,minimum:0,description:"Follows the activity had produced by the reading date; null when the export's cell is blank."},engagementRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank."},matched:{type:"boolean",description:"Whether the activity's link resolved to a stored content activity at import."},contentRow:{type:"integer",nullable:true,minimum:0,description:"The content row the activity matched, when it matched; null for an unmatched activity."},contentProfile:{type:"string",maxLength:255,nullable:true,description:"The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched."},sourceFile:{type:"string",maxLength:1024,description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;export{t as default};
@@ -67,6 +67,31 @@ export interface components {
67
67
  "text/plain": string;
68
68
  };
69
69
  };
70
+ /** @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. */
71
+ MeshkitError429: {
72
+ headers: {
73
+ /** @description Number of seconds the caller must wait before retrying. */
74
+ "Retry-After": number;
75
+ [name: string]: unknown;
76
+ };
77
+ content: {
78
+ "application/json": {
79
+ /** @description The sentence the caller is shown. */
80
+ error: string;
81
+ /** @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. */
82
+ code?: string;
83
+ /**
84
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
85
+ * @enum {string}
86
+ */
87
+ severity?: "emergency" | "alert" | "critical" | "fatal";
88
+ /** @description MeshKit's probable causes of the error. */
89
+ probableCause?: string[];
90
+ /** @description MeshKit's suggested remediations for the error. */
91
+ suggestedRemediation?: string[];
92
+ };
93
+ };
94
+ };
70
95
  };
71
96
  parameters: never;
72
97
  requestBodies: never;
@@ -117,6 +142,31 @@ export interface operations {
117
142
  "text/plain": string;
118
143
  };
119
144
  };
145
+ /** @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. */
146
+ 429: {
147
+ headers: {
148
+ /** @description Number of seconds the caller must wait before retrying. */
149
+ "Retry-After": number;
150
+ [name: string]: unknown;
151
+ };
152
+ content: {
153
+ "application/json": {
154
+ /** @description The sentence the caller is shown. */
155
+ error: string;
156
+ /** @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. */
157
+ code?: string;
158
+ /**
159
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
160
+ * @enum {string}
161
+ */
162
+ severity?: "emergency" | "alert" | "critical" | "fatal";
163
+ /** @description MeshKit's probable causes of the error. */
164
+ probableCause?: string[];
165
+ /** @description MeshKit's suggested remediations for the error. */
166
+ suggestedRemediation?: string[];
167
+ };
168
+ };
169
+ };
120
170
  /** @description Internal server error */
121
171
  500: {
122
172
  headers: {
@@ -4,4 +4,4 @@ payload and no template.
4
4
  `,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"blowhornHealth",description:"Operations related to Blowhorn health."}],paths:{"/api/blowhorn/health":{get:{"x-internal":["cloud"],tags:["blowhornHealth"],summary:"Get Blowhorn health",operationId:"getBlowhornHealth",description:`Returns the frozen Blowhorn contract version and whether the
5
5
  organization of the authenticated session is bound. Migrations move
6
6
  server-side; this endpoint reports the contract the server speaks.
7
- `,responses:{200:{description:"Blowhorn health response",content:{"application/json":{schema:{type:"object",description:"Blowhorn contract version and organization binding status.",additionalProperties:false,required:["contractVersion","bound"],properties:{contractVersion:{type:"string",description:"Frozen Blowhorn contract version the server speaks.",minLength:1,maxLength:255},bound:{type:"boolean",description:"Whether the organization is bound for Blowhorn operations."},organizationId:{description:"Organization whose binding was checked.","x-go-name":"OrganizationID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},checkedAt:{description:"Time the binding was checked.",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"Bearer [REDACTED]",bearerFormat:"JWT"}},responses:{401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},schemas:{BlowhornHealth:{type:"object",description:"Blowhorn contract version and organization binding status.",additionalProperties:false,required:["contractVersion","bound"],properties:{contractVersion:{type:"string",description:"Frozen Blowhorn contract version the server speaks.",minLength:1,maxLength:255},bound:{type:"boolean",description:"Whether the organization is bound for Blowhorn operations."},organizationId:{description:"Organization whose binding was checked.","x-go-name":"OrganizationID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},checkedAt:{description:"Time the binding was checked.",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},t=e;module.exports=t;
7
+ `,responses:{200:{description:"Blowhorn health response",content:{"application/json":{schema:{type:"object",description:"Blowhorn contract version and organization binding status.",additionalProperties:false,required:["contractVersion","bound"],properties:{contractVersion:{type:"string",description:"Frozen Blowhorn contract version the server speaks.",minLength:1,maxLength:255},bound:{type:"boolean",description:"Whether the organization is bound for Blowhorn operations."},organizationId:{description:"Organization whose binding was checked.","x-go-name":"OrganizationID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},checkedAt:{description:"Time the binding was checked.",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},429:{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.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,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."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"Bearer [REDACTED]",bearerFormat:"JWT"}},responses:{401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}},MeshkitError429:{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.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,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."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}}},schemas:{BlowhornHealth:{type:"object",description:"Blowhorn contract version and organization binding status.",additionalProperties:false,required:["contractVersion","bound"],properties:{contractVersion:{type:"string",description:"Frozen Blowhorn contract version the server speaks.",minLength:1,maxLength:255},bound:{type:"boolean",description:"Whether the organization is bound for Blowhorn operations."},organizationId:{description:"Organization whose binding was checked.","x-go-name":"OrganizationID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},checkedAt:{description:"Time the binding was checked.",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},t=e;module.exports=t;
@@ -4,4 +4,4 @@ payload and no template.
4
4
  `,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"blowhornHealth",description:"Operations related to Blowhorn health."}],paths:{"/api/blowhorn/health":{get:{"x-internal":["cloud"],tags:["blowhornHealth"],summary:"Get Blowhorn health",operationId:"getBlowhornHealth",description:`Returns the frozen Blowhorn contract version and whether the
5
5
  organization of the authenticated session is bound. Migrations move
6
6
  server-side; this endpoint reports the contract the server speaks.
7
- `,responses:{200:{description:"Blowhorn health response",content:{"application/json":{schema:{type:"object",description:"Blowhorn contract version and organization binding status.",additionalProperties:false,required:["contractVersion","bound"],properties:{contractVersion:{type:"string",description:"Frozen Blowhorn contract version the server speaks.",minLength:1,maxLength:255},bound:{type:"boolean",description:"Whether the organization is bound for Blowhorn operations."},organizationId:{description:"Organization whose binding was checked.","x-go-name":"OrganizationID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},checkedAt:{description:"Time the binding was checked.",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"Bearer [REDACTED]",bearerFormat:"JWT"}},responses:{401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},schemas:{BlowhornHealth:{type:"object",description:"Blowhorn contract version and organization binding status.",additionalProperties:false,required:["contractVersion","bound"],properties:{contractVersion:{type:"string",description:"Frozen Blowhorn contract version the server speaks.",minLength:1,maxLength:255},bound:{type:"boolean",description:"Whether the organization is bound for Blowhorn operations."},organizationId:{description:"Organization whose binding was checked.","x-go-name":"OrganizationID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},checkedAt:{description:"Time the binding was checked.",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},t=e;export{t as default};
7
+ `,responses:{200:{description:"Blowhorn health response",content:{"application/json":{schema:{type:"object",description:"Blowhorn contract version and organization binding status.",additionalProperties:false,required:["contractVersion","bound"],properties:{contractVersion:{type:"string",description:"Frozen Blowhorn contract version the server speaks.",minLength:1,maxLength:255},bound:{type:"boolean",description:"Whether the organization is bound for Blowhorn operations."},organizationId:{description:"Organization whose binding was checked.","x-go-name":"OrganizationID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},checkedAt:{description:"Time the binding was checked.",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},429:{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.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,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."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"Bearer [REDACTED]",bearerFormat:"JWT"}},responses:{401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}},MeshkitError429:{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.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,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."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}}},schemas:{BlowhornHealth:{type:"object",description:"Blowhorn contract version and organization binding status.",additionalProperties:false,required:["contractVersion","bound"],properties:{contractVersion:{type:"string",description:"Frozen Blowhorn contract version the server speaks.",minLength:1,maxLength:255},bound:{type:"boolean",description:"Whether the organization is bound for Blowhorn operations."},organizationId:{description:"Organization whose binding was checked.","x-go-name":"OrganizationID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},checkedAt:{description:"Time the binding was checked.",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},t=e;export{t as default};
@@ -390,6 +390,31 @@ export interface components {
390
390
  "text/plain": string;
391
391
  };
392
392
  };
393
+ /** @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. */
394
+ MeshkitError429: {
395
+ headers: {
396
+ /** @description Number of seconds the caller must wait before retrying. */
397
+ "Retry-After": number;
398
+ [name: string]: unknown;
399
+ };
400
+ content: {
401
+ "application/json": {
402
+ /** @description The sentence the caller is shown. */
403
+ error: string;
404
+ /** @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. */
405
+ code?: string;
406
+ /**
407
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
408
+ * @enum {string}
409
+ */
410
+ severity?: "emergency" | "alert" | "critical" | "fatal";
411
+ /** @description MeshKit's probable causes of the error. */
412
+ probableCause?: string[];
413
+ /** @description MeshKit's suggested remediations for the error. */
414
+ suggestedRemediation?: string[];
415
+ };
416
+ };
417
+ };
393
418
  };
394
419
  parameters: {
395
420
  /** @description Claim ID */
@@ -573,6 +598,31 @@ export interface operations {
573
598
  "text/plain": string;
574
599
  };
575
600
  };
601
+ /** @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. */
602
+ 429: {
603
+ headers: {
604
+ /** @description Number of seconds the caller must wait before retrying. */
605
+ "Retry-After": number;
606
+ [name: string]: unknown;
607
+ };
608
+ content: {
609
+ "application/json": {
610
+ /** @description The sentence the caller is shown. */
611
+ error: string;
612
+ /** @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. */
613
+ code?: string;
614
+ /**
615
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
616
+ * @enum {string}
617
+ */
618
+ severity?: "emergency" | "alert" | "critical" | "fatal";
619
+ /** @description MeshKit's probable causes of the error. */
620
+ probableCause?: string[];
621
+ /** @description MeshKit's suggested remediations for the error. */
622
+ suggestedRemediation?: string[];
623
+ };
624
+ };
625
+ };
576
626
  /** @description Internal server error */
577
627
  500: {
578
628
  headers: {
@@ -835,6 +885,31 @@ export interface operations {
835
885
  "text/plain": string;
836
886
  };
837
887
  };
888
+ /** @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. */
889
+ 429: {
890
+ headers: {
891
+ /** @description Number of seconds the caller must wait before retrying. */
892
+ "Retry-After": number;
893
+ [name: string]: unknown;
894
+ };
895
+ content: {
896
+ "application/json": {
897
+ /** @description The sentence the caller is shown. */
898
+ error: string;
899
+ /** @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. */
900
+ code?: string;
901
+ /**
902
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
903
+ * @enum {string}
904
+ */
905
+ severity?: "emergency" | "alert" | "critical" | "fatal";
906
+ /** @description MeshKit's probable causes of the error. */
907
+ probableCause?: string[];
908
+ /** @description MeshKit's suggested remediations for the error. */
909
+ suggestedRemediation?: string[];
910
+ };
911
+ };
912
+ };
838
913
  /** @description Internal server error */
839
914
  500: {
840
915
  headers: {
@@ -974,6 +1049,31 @@ export interface operations {
974
1049
  "text/plain": string;
975
1050
  };
976
1051
  };
1052
+ /** @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. */
1053
+ 429: {
1054
+ headers: {
1055
+ /** @description Number of seconds the caller must wait before retrying. */
1056
+ "Retry-After": number;
1057
+ [name: string]: unknown;
1058
+ };
1059
+ content: {
1060
+ "application/json": {
1061
+ /** @description The sentence the caller is shown. */
1062
+ error: string;
1063
+ /** @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. */
1064
+ code?: string;
1065
+ /**
1066
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
1067
+ * @enum {string}
1068
+ */
1069
+ severity?: "emergency" | "alert" | "critical" | "fatal";
1070
+ /** @description MeshKit's probable causes of the error. */
1071
+ probableCause?: string[];
1072
+ /** @description MeshKit's suggested remediations for the error. */
1073
+ suggestedRemediation?: string[];
1074
+ };
1075
+ };
1076
+ };
977
1077
  /** @description Internal server error */
978
1078
  500: {
979
1079
  headers: {
@@ -1143,6 +1243,31 @@ export interface operations {
1143
1243
  "text/plain": string;
1144
1244
  };
1145
1245
  };
1246
+ /** @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. */
1247
+ 429: {
1248
+ headers: {
1249
+ /** @description Number of seconds the caller must wait before retrying. */
1250
+ "Retry-After": number;
1251
+ [name: string]: unknown;
1252
+ };
1253
+ content: {
1254
+ "application/json": {
1255
+ /** @description The sentence the caller is shown. */
1256
+ error: string;
1257
+ /** @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. */
1258
+ code?: string;
1259
+ /**
1260
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
1261
+ * @enum {string}
1262
+ */
1263
+ severity?: "emergency" | "alert" | "critical" | "fatal";
1264
+ /** @description MeshKit's probable causes of the error. */
1265
+ probableCause?: string[];
1266
+ /** @description MeshKit's suggested remediations for the error. */
1267
+ suggestedRemediation?: string[];
1268
+ };
1269
+ };
1270
+ };
1146
1271
  /** @description Internal server error */
1147
1272
  500: {
1148
1273
  headers: {
@@ -1317,6 +1442,31 @@ export interface operations {
1317
1442
  "text/plain": string;
1318
1443
  };
1319
1444
  };
1445
+ /** @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. */
1446
+ 429: {
1447
+ headers: {
1448
+ /** @description Number of seconds the caller must wait before retrying. */
1449
+ "Retry-After": number;
1450
+ [name: string]: unknown;
1451
+ };
1452
+ content: {
1453
+ "application/json": {
1454
+ /** @description The sentence the caller is shown. */
1455
+ error: string;
1456
+ /** @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. */
1457
+ code?: string;
1458
+ /**
1459
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
1460
+ * @enum {string}
1461
+ */
1462
+ severity?: "emergency" | "alert" | "critical" | "fatal";
1463
+ /** @description MeshKit's probable causes of the error. */
1464
+ probableCause?: string[];
1465
+ /** @description MeshKit's suggested remediations for the error. */
1466
+ suggestedRemediation?: string[];
1467
+ };
1468
+ };
1469
+ };
1320
1470
  /** @description Internal server error */
1321
1471
  500: {
1322
1472
  headers: {