@meshery/schemas 1.3.103 → 1.3.105

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 (26) hide show
  1. package/dist/cloudApi.d.mts +13 -13
  2. package/dist/cloudApi.d.ts +13 -13
  3. package/dist/constructs/v1beta1/registry/Registry.d.ts +6 -6
  4. package/dist/constructs/v1beta1/registry/RegistrySchema.js +3 -3
  5. package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +3 -3
  6. package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.d.ts +186 -0
  7. package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.js +1 -0
  8. package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.mjs +0 -0
  9. package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.d.ts +2 -0
  10. package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.js +25 -0
  11. package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.mjs +25 -0
  12. package/dist/constructs/v1beta3/connection/Connection.d.ts +19 -19
  13. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
  14. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
  15. package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.js +1 -1
  16. package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.mjs +1 -1
  17. package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.js +1 -1
  18. package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.mjs +1 -1
  19. package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.js +1 -1
  20. package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.mjs +1 -1
  21. package/dist/constructs/v1beta3/profile/Profile.d.ts +1 -1
  22. package/dist/constructs/v1beta3/profile/ProfileSchema.js +1 -1
  23. package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +1 -1
  24. package/dist/mesheryApi.d.mts +16 -16
  25. package/dist/mesheryApi.d.ts +16 -16
  26. package/package.json +1 -1
@@ -0,0 +1,186 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+
6
+ export type paths = Record<string, never>;
7
+ export type webhooks = Record<string, never>;
8
+ export interface components {
9
+ schemas: {
10
+ /**
11
+ * Activity Metrics Schema
12
+ * @description Server-returned per-activity reception figures for one post, as recorded
13
+ * in the `metadata` of an event on the events service (category `blowhorn`,
14
+ * action `activity_metrics`); the event construct carries the envelope and
15
+ * this construct names the metadata's own shape, which Event leaves open.
16
+ * One row is one activity as one export read it, identified by
17
+ * (organizationId, platform, activityRef, readingDate): a later export adds a
18
+ * reading rather than replacing an earlier one, so the rows are a time series
19
+ * and the reading with the latest readingDate is an activity's current
20
+ * figures. The events service appends and enforces no uniqueness, so
21
+ * re-importing an export records the same key twice: readers take, for each
22
+ * key, the most recently recorded event and must not sum duplicates. The figures come from a
23
+ * LinkedIn page content export's "All posts" sheet, whose header sits under
24
+ * a disclaimer row; readingDate is that export's date, the day the figures
25
+ * were true as of. `matched` records whether the row's link resolved to a
26
+ * stored content activity at import (through `content.promotion_link`,
27
+ * per-profile entries of an `all` row included); an unmatched row is kept,
28
+ * not dropped - the post was made outside Blowhorn and is still the page's
29
+ * reception. Every figure is nullable: a blank figure in the source export
30
+ * is not a zero.
31
+ */
32
+ ActivityMetrics: {
33
+ /**
34
+ * Format: uuid
35
+ * @description Owning organization ID.
36
+ */
37
+ organizationId: string;
38
+ /** @description The platform the activity was posted to (today only `linkedin` produces these exports). */
39
+ platform: string;
40
+ /** @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. */
41
+ activityRef: string;
42
+ /**
43
+ * Format: date
44
+ * @description The export's date - the day the figures were read as of, as an ISO calendar date.
45
+ */
46
+ readingDate: string;
47
+ /** @description The page the export belongs to, named as the source export names it. */
48
+ subject: string;
49
+ /** @description The post link as the export spelled it, before normalization to `activityRef`. */
50
+ link: string;
51
+ /** @description The post's title as the export gives it; null when the export names none. */
52
+ title?: string | null;
53
+ /** @description The post's type as the export gives it (for example `Organic`); null when the export names none. */
54
+ postType?: string | null;
55
+ /** @description Who the export says posted the activity; null when the export names none. */
56
+ postedBy?: string | null;
57
+ /**
58
+ * Format: date
59
+ * @description The day the activity was created, as an ISO calendar date; null when the export names none.
60
+ */
61
+ createdDate?: string | null;
62
+ /** @description The audience the export names for the activity; null when it names none. */
63
+ audience?: string | null;
64
+ /** @description The content type the export names for the activity; null when it names none. */
65
+ contentType?: string | null;
66
+ /** @description Impressions the activity had gathered by the reading date; null when the export's cell is blank. */
67
+ impressions?: number | null;
68
+ /** @description Views the activity had gathered by the reading date; null when the export's cell is blank. */
69
+ views?: number | null;
70
+ /** @description Offsite views the activity had gathered by the reading date; null when the export's cell is blank. */
71
+ offsiteViews?: number | null;
72
+ /** @description Clicks the activity had gathered by the reading date; null when the export's cell is blank. */
73
+ clicks?: number | null;
74
+ /**
75
+ * Format: double
76
+ * @description Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank.
77
+ */
78
+ clickThroughRate?: number | null;
79
+ /** @description Likes the activity had gathered by the reading date; null when the export's cell is blank. */
80
+ likes?: number | null;
81
+ /** @description Comments the activity had gathered by the reading date; null when the export's cell is blank. */
82
+ comments?: number | null;
83
+ /** @description Reposts the activity had gathered by the reading date; null when the export's cell is blank. */
84
+ reposts?: number | null;
85
+ /** @description Follows the activity had produced by the reading date; null when the export's cell is blank. */
86
+ follows?: number | null;
87
+ /**
88
+ * Format: double
89
+ * @description Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank.
90
+ */
91
+ engagementRate?: number | null;
92
+ /** @description Whether the activity's link resolved to a stored content activity at import. */
93
+ matched: boolean;
94
+ /** @description The content row the activity matched, when it matched; null for an unmatched activity. */
95
+ contentRow?: number | null;
96
+ /** @description The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched. */
97
+ contentProfile?: string | null;
98
+ /** @description The export file the row was read from; empty when the row did not come from a file export. */
99
+ sourceFile: string;
100
+ };
101
+ /**
102
+ * Activity Metrics Payload Schema
103
+ * @description Payload for recording one activity's reception figures as of one export,
104
+ * sent as the `metadata` of a create-event call. Contains only
105
+ * client-settable fields; the row has no server-generated fields, because
106
+ * the events service stores and returns event metadata verbatim, so the
107
+ * payload and the recorded row (ActivityMetrics) share one field set.
108
+ */
109
+ ActivityMetricsPayload: {
110
+ /**
111
+ * Format: uuid
112
+ * @description Owning organization ID.
113
+ */
114
+ organizationId: string;
115
+ /** @description The platform the activity was posted to (today only `linkedin` produces these exports). */
116
+ platform: string;
117
+ /** @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. */
118
+ activityRef: string;
119
+ /**
120
+ * Format: date
121
+ * @description The export's date - the day the figures were read as of, as an ISO calendar date.
122
+ */
123
+ readingDate: string;
124
+ /** @description The page the export belongs to, named as the source export names it. */
125
+ subject: string;
126
+ /** @description The post link as the export spelled it, before normalization to `activityRef`. */
127
+ link: string;
128
+ /** @description The post's title as the export gives it; null when the export names none. */
129
+ title?: string | null;
130
+ /** @description The post's type as the export gives it (for example `Organic`); null when the export names none. */
131
+ postType?: string | null;
132
+ /** @description Who the export says posted the activity; null when the export names none. */
133
+ postedBy?: string | null;
134
+ /**
135
+ * Format: date
136
+ * @description The day the activity was created, as an ISO calendar date; null when the export names none.
137
+ */
138
+ createdDate?: string | null;
139
+ /** @description The audience the export names for the activity; null when it names none. */
140
+ audience?: string | null;
141
+ /** @description The content type the export names for the activity; null when it names none. */
142
+ contentType?: string | null;
143
+ /** @description Impressions the activity had gathered by the reading date; null when the export's cell is blank. */
144
+ impressions?: number | null;
145
+ /** @description Views the activity had gathered by the reading date; null when the export's cell is blank. */
146
+ views?: number | null;
147
+ /** @description Offsite views the activity had gathered by the reading date; null when the export's cell is blank. */
148
+ offsiteViews?: number | null;
149
+ /** @description Clicks the activity had gathered by the reading date; null when the export's cell is blank. */
150
+ clicks?: number | null;
151
+ /**
152
+ * Format: double
153
+ * @description Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank.
154
+ */
155
+ clickThroughRate?: number | null;
156
+ /** @description Likes the activity had gathered by the reading date; null when the export's cell is blank. */
157
+ likes?: number | null;
158
+ /** @description Comments the activity had gathered by the reading date; null when the export's cell is blank. */
159
+ comments?: number | null;
160
+ /** @description Reposts the activity had gathered by the reading date; null when the export's cell is blank. */
161
+ reposts?: number | null;
162
+ /** @description Follows the activity had produced by the reading date; null when the export's cell is blank. */
163
+ follows?: number | null;
164
+ /**
165
+ * Format: double
166
+ * @description Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank.
167
+ */
168
+ engagementRate?: number | null;
169
+ /** @description Whether the activity's link resolved to a stored content activity at import. */
170
+ matched: boolean;
171
+ /** @description The content row the activity matched, when it matched; null for an unmatched activity. */
172
+ contentRow?: number | null;
173
+ /** @description The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched. */
174
+ contentProfile?: string | null;
175
+ /** @description The export file the row was read from; empty when the row did not come from a file export. */
176
+ sourceFile: string;
177
+ };
178
+ };
179
+ responses: never;
180
+ parameters: never;
181
+ requestBodies: never;
182
+ headers: never;
183
+ pathItems: never;
184
+ }
185
+ export type $defs = Record<string, never>;
186
+ export type operations = Record<string, never>;
@@ -0,0 +1,2 @@
1
+ declare const ActivityMetricsSchema: Record<string, unknown>;
2
+ export default ActivityMetricsSchema;
@@ -0,0 +1,25 @@
1
+ 'use strict';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;module.exports=t;
@@ -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};
@@ -21,7 +21,7 @@ export interface paths {
21
21
  * Register a new connection
22
22
  * @description Register a new connection with credentials. Meshery Cloud reserves the GitHub App connection's identity (name `GitHub App`, sub_type `git`): only its GitHub authorization flow creates that connection, so a request naming it is refused with a `409` MeshKit error that names the reserved GitHub App connection identity.
23
23
  *
24
- * Every connection belongs to exactly one organization. The server assigns `organizationId` from the session (`X-Current-Orgid`, then the caller's selected organization) and does not accept it in the body.
24
+ * Every connection registered belongs to exactly one organization. The server assigns `organizationId` from the session (`X-Current-Orgid`, then the caller's selected organization) and does not accept it in the body. When the session names none, the server may use the caller's only organization (Meshery Cloud: the only live organization the caller belongs to, else the only one of those the caller owns); it must not guess between several, and answers 400 instead. Connections registered before servers recorded an organization may have none.
25
25
  *
26
26
  * Desktop registration uses this shared operation, but kind `desktop` is implemented by Cloud: a server that does not support it rejects a `desktop` body with `400`. The heartbeat and deregistration routes are Cloud-only. A client desktop app install registers itself on every connect to Cloud, sign-in included, with kind `desktop`, type `platform`, sub_type `management`, status `connected`, and `metadata` matching `DesktopConnectionMetadata`. Servers implementing this contract must take the organization from the `X-Current-Orgid` header, refuse a `desktop` registration without it with `400`, and refuse a caller who is not a live member of that organization with `403`. They must deduplicate on (organization, owner, `metadata.installationId`): registering the same install again updates that connection and returns `200`, while a new connection returns `201`. A `desktop` body whose metadata lacks `installationId` is refused with `400`. Installs on one computer share `metadata.computerId`, so a server can group them by computer. The kind names the connection type, never the product that runs on the machine.
27
27
  *
@@ -577,9 +577,9 @@ export interface components {
577
577
  deletedAt?: string | null;
578
578
  /**
579
579
  * Format: uuid
580
- * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
580
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
581
581
  */
582
- organizationId: string;
582
+ organizationId?: string | null;
583
583
  /** @description Associated environments for this connection */
584
584
  environments?: {
585
585
  /**
@@ -1288,9 +1288,9 @@ export interface components {
1288
1288
  deletedAt?: string | null;
1289
1289
  /**
1290
1290
  * Format: uuid
1291
- * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
1291
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
1292
1292
  */
1293
- organizationId: string;
1293
+ organizationId?: string | null;
1294
1294
  /** @description Associated environments for this connection */
1295
1295
  environments?: {
1296
1296
  /**
@@ -2346,9 +2346,9 @@ export interface operations {
2346
2346
  deletedAt?: string | null;
2347
2347
  /**
2348
2348
  * Format: uuid
2349
- * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
2349
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
2350
2350
  */
2351
- organizationId: string;
2351
+ organizationId?: string | null;
2352
2352
  /** @description Associated environments for this connection */
2353
2353
  environments?: {
2354
2354
  /**
@@ -2956,9 +2956,9 @@ export interface operations {
2956
2956
  deletedAt?: string | null;
2957
2957
  /**
2958
2958
  * Format: uuid
2959
- * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
2959
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
2960
2960
  */
2961
- organizationId: string;
2961
+ organizationId?: string | null;
2962
2962
  /** @description Associated environments for this connection */
2963
2963
  environments?: {
2964
2964
  /**
@@ -3320,9 +3320,9 @@ export interface operations {
3320
3320
  deletedAt?: string | null;
3321
3321
  /**
3322
3322
  * Format: uuid
3323
- * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
3323
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
3324
3324
  */
3325
- organizationId: string;
3325
+ organizationId?: string | null;
3326
3326
  /** @description Associated environments for this connection */
3327
3327
  environments?: {
3328
3328
  /**
@@ -3935,9 +3935,9 @@ export interface operations {
3935
3935
  deletedAt?: string | null;
3936
3936
  /**
3937
3937
  * Format: uuid
3938
- * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
3938
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
3939
3939
  */
3940
- organizationId: string;
3940
+ organizationId?: string | null;
3941
3941
  /** @description Associated environments for this connection */
3942
3942
  environments?: {
3943
3943
  /**
@@ -4543,9 +4543,9 @@ export interface operations {
4543
4543
  deletedAt?: string | null;
4544
4544
  /**
4545
4545
  * Format: uuid
4546
- * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
4546
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
4547
4547
  */
4548
- organizationId: string;
4548
+ organizationId?: string | null;
4549
4549
  /** @description Associated environments for this connection */
4550
4550
  environments?: {
4551
4551
  /**
@@ -5043,9 +5043,9 @@ export interface operations {
5043
5043
  deletedAt?: string | null;
5044
5044
  /**
5045
5045
  * Format: uuid
5046
- * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
5046
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
5047
5047
  */
5048
- organizationId: string;
5048
+ organizationId?: string | null;
5049
5049
  /** @description Associated environments for this connection */
5050
5050
  environments?: {
5051
5051
  /**
@@ -5677,9 +5677,9 @@ export interface operations {
5677
5677
  deletedAt?: string | null;
5678
5678
  /**
5679
5679
  * Format: uuid
5680
- * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
5680
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
5681
5681
  */
5682
- organizationId: string;
5682
+ organizationId?: string | null;
5683
5683
  /** @description Associated environments for this connection */
5684
5684
  environments?: {
5685
5685
  /**