@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.
- package/dist/cloudApi.d.mts +4496 -4098
- package/dist/cloudApi.d.ts +4496 -4098
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/core/Core.d.ts +1 -1
- package/dist/constructs/v1alpha1/core/CoreSchema.js +1 -1
- package/dist/constructs/v1alpha1/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta1/diagnostics/Diagnostics.d.ts +536 -0
- package/dist/constructs/v1beta1/diagnostics/Diagnostics.js +1 -0
- package/dist/constructs/v1beta1/diagnostics/Diagnostics.mjs +0 -0
- package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.js +2 -0
- package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.mjs +2 -0
- package/dist/constructs/v1beta1/support/Support.d.ts +373 -0
- package/dist/constructs/v1beta1/support/SupportSchema.js +1 -1
- package/dist/constructs/v1beta1/support/SupportSchema.mjs +1 -1
- package/dist/constructs/v1beta2/core/Core.d.ts +26 -1
- package/dist/constructs/v1beta2/core/CoreSchema.js +1 -1
- package/dist/constructs/v1beta2/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.d.ts +186 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.js +1 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.mjs +0 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.js +25 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.mjs +25 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealth.d.ts +50 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.js +1 -1
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.mjs +1 -1
- package/dist/constructs/v1beta3/claim/Claim.d.ts +150 -0
- package/dist/constructs/v1beta3/claim/ClaimSchema.js +2 -2
- package/dist/constructs/v1beta3/claim/ClaimSchema.mjs +2 -2
- package/dist/constructs/v1beta3/connection/Connection.d.ts +100 -0
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
- package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +150 -0
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +5 -5
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +5 -5
- package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.js +1 -1
- package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.mjs +1 -1
- package/dist/constructs/v1beta3/design/DesignSchema.js +5 -5
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +5 -5
- package/dist/constructs/v1beta3/event/Event.d.ts +275 -0
- package/dist/constructs/v1beta3/event/EventSchema.js +3 -3
- package/dist/constructs/v1beta3/event/EventSchema.mjs +3 -3
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.js +1 -1
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.mjs +1 -1
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.js +1 -1
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.mjs +1 -1
- package/dist/constructs/v1beta3/github/GithubSchema.js +1 -1
- package/dist/constructs/v1beta3/github/GithubSchema.mjs +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/ledger/Ledger.d.ts +175 -0
- package/dist/constructs/v1beta3/ledger/LedgerSchema.js +5 -5
- package/dist/constructs/v1beta3/ledger/LedgerSchema.mjs +5 -5
- package/dist/constructs/v1beta3/profile/Profile.d.ts +225 -0
- package/dist/constructs/v1beta3/profile/ProfileSchema.js +1 -1
- package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +1 -1
- package/dist/constructs/v1beta3/provider_capability/ProviderCapability.d.ts +50 -0
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.js +1 -1
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.mjs +1 -1
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +225 -0
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +8 -8
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +8 -8
- package/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- package/package.json +1 -1
|
@@ -267,6 +267,31 @@ export interface components {
|
|
|
267
267
|
"text/plain": string;
|
|
268
268
|
};
|
|
269
269
|
};
|
|
270
|
+
/** @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. */
|
|
271
|
+
MeshkitError429: {
|
|
272
|
+
headers: {
|
|
273
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
274
|
+
"Retry-After": number;
|
|
275
|
+
[name: string]: unknown;
|
|
276
|
+
};
|
|
277
|
+
content: {
|
|
278
|
+
"application/json": {
|
|
279
|
+
/** @description The sentence the caller is shown. */
|
|
280
|
+
error: string;
|
|
281
|
+
/** @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. */
|
|
282
|
+
code?: string;
|
|
283
|
+
/**
|
|
284
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
285
|
+
* @enum {string}
|
|
286
|
+
*/
|
|
287
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
288
|
+
/** @description MeshKit's probable causes of the error. */
|
|
289
|
+
probableCause?: string[];
|
|
290
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
291
|
+
suggestedRemediation?: string[];
|
|
292
|
+
};
|
|
293
|
+
};
|
|
294
|
+
};
|
|
270
295
|
};
|
|
271
296
|
parameters: {
|
|
272
297
|
/**
|
|
@@ -407,6 +432,31 @@ export interface operations {
|
|
|
407
432
|
"text/plain": string;
|
|
408
433
|
};
|
|
409
434
|
};
|
|
435
|
+
/** @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. */
|
|
436
|
+
429: {
|
|
437
|
+
headers: {
|
|
438
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
439
|
+
"Retry-After": number;
|
|
440
|
+
[name: string]: unknown;
|
|
441
|
+
};
|
|
442
|
+
content: {
|
|
443
|
+
"application/json": {
|
|
444
|
+
/** @description The sentence the caller is shown. */
|
|
445
|
+
error: string;
|
|
446
|
+
/** @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. */
|
|
447
|
+
code?: string;
|
|
448
|
+
/**
|
|
449
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
450
|
+
* @enum {string}
|
|
451
|
+
*/
|
|
452
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
453
|
+
/** @description MeshKit's probable causes of the error. */
|
|
454
|
+
probableCause?: string[];
|
|
455
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
456
|
+
suggestedRemediation?: string[];
|
|
457
|
+
};
|
|
458
|
+
};
|
|
459
|
+
};
|
|
410
460
|
/** @description Internal server error */
|
|
411
461
|
500: {
|
|
412
462
|
headers: {
|
|
@@ -548,6 +598,31 @@ export interface operations {
|
|
|
548
598
|
"text/plain": string;
|
|
549
599
|
};
|
|
550
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
|
+
};
|
|
551
626
|
/** @description Internal server error */
|
|
552
627
|
500: {
|
|
553
628
|
headers: {
|
|
@@ -655,6 +730,31 @@ export interface operations {
|
|
|
655
730
|
"text/plain": string;
|
|
656
731
|
};
|
|
657
732
|
};
|
|
733
|
+
/** @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. */
|
|
734
|
+
429: {
|
|
735
|
+
headers: {
|
|
736
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
737
|
+
"Retry-After": number;
|
|
738
|
+
[name: string]: unknown;
|
|
739
|
+
};
|
|
740
|
+
content: {
|
|
741
|
+
"application/json": {
|
|
742
|
+
/** @description The sentence the caller is shown. */
|
|
743
|
+
error: string;
|
|
744
|
+
/** @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. */
|
|
745
|
+
code?: string;
|
|
746
|
+
/**
|
|
747
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
748
|
+
* @enum {string}
|
|
749
|
+
*/
|
|
750
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
751
|
+
/** @description MeshKit's probable causes of the error. */
|
|
752
|
+
probableCause?: string[];
|
|
753
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
754
|
+
suggestedRemediation?: string[];
|
|
755
|
+
};
|
|
756
|
+
};
|
|
757
|
+
};
|
|
658
758
|
/** @description Internal server error */
|
|
659
759
|
500: {
|
|
660
760
|
headers: {
|
|
@@ -799,6 +899,31 @@ export interface operations {
|
|
|
799
899
|
"text/plain": string;
|
|
800
900
|
};
|
|
801
901
|
};
|
|
902
|
+
/** @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. */
|
|
903
|
+
429: {
|
|
904
|
+
headers: {
|
|
905
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
906
|
+
"Retry-After": number;
|
|
907
|
+
[name: string]: unknown;
|
|
908
|
+
};
|
|
909
|
+
content: {
|
|
910
|
+
"application/json": {
|
|
911
|
+
/** @description The sentence the caller is shown. */
|
|
912
|
+
error: string;
|
|
913
|
+
/** @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. */
|
|
914
|
+
code?: string;
|
|
915
|
+
/**
|
|
916
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
917
|
+
* @enum {string}
|
|
918
|
+
*/
|
|
919
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
920
|
+
/** @description MeshKit's probable causes of the error. */
|
|
921
|
+
probableCause?: string[];
|
|
922
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
923
|
+
suggestedRemediation?: string[];
|
|
924
|
+
};
|
|
925
|
+
};
|
|
926
|
+
};
|
|
802
927
|
/** @description Internal server error */
|
|
803
928
|
500: {
|
|
804
929
|
headers: {
|
|
@@ -880,6 +1005,31 @@ export interface operations {
|
|
|
880
1005
|
"text/plain": string;
|
|
881
1006
|
};
|
|
882
1007
|
};
|
|
1008
|
+
/** @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. */
|
|
1009
|
+
429: {
|
|
1010
|
+
headers: {
|
|
1011
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
1012
|
+
"Retry-After": number;
|
|
1013
|
+
[name: string]: unknown;
|
|
1014
|
+
};
|
|
1015
|
+
content: {
|
|
1016
|
+
"application/json": {
|
|
1017
|
+
/** @description The sentence the caller is shown. */
|
|
1018
|
+
error: string;
|
|
1019
|
+
/** @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. */
|
|
1020
|
+
code?: string;
|
|
1021
|
+
/**
|
|
1022
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
1023
|
+
* @enum {string}
|
|
1024
|
+
*/
|
|
1025
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
1026
|
+
/** @description MeshKit's probable causes of the error. */
|
|
1027
|
+
probableCause?: string[];
|
|
1028
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
1029
|
+
suggestedRemediation?: string[];
|
|
1030
|
+
};
|
|
1031
|
+
};
|
|
1032
|
+
};
|
|
883
1033
|
/** @description Internal server error */
|
|
884
1034
|
500: {
|
|
885
1035
|
headers: {
|
|
@@ -17,7 +17,7 @@ Content items carry a row number and a server-computed fingerprint over
|
|
|
17
17
|
their canonical values; updates are conditional on the fingerprint the
|
|
18
18
|
writer read, so stale writes are refused rather than silently applied.
|
|
19
19
|
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content item ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content item, unique across the live content items of the organization.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content item creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content item modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content item was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9},createdBy:{description:`ID of the user whose session created the content item. Derived from the authenticated session, never client-settable, and never changed by an update. Omitted on content items created before it was recorded, and when that user was later purged.
|
|
20
|
-
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},description:"Content items included on this page of results."}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},post:{"x-internal":["cloud"],tags:["contentItems"],summary:"Insert a content item",operationId:"insertContentItem",description:"Inserts a new content item. Insert-only: any supplied\n`id` and `expectedFingerprint` are ignored; existing rows change\nonly through the conditional `updateContentItem`. The\n`fingerprint` is server-computed. Row numbers are unique across\nthe live content items of the organization, whatever their\n`profile`. When `rowNumber` is omitted the server assigns the next\nrow number of the organization (one more than the highest row\nnumber the organization has used, counting soft-deleted content\nitems so a deleted item's number is not handed out again by\nassignment), atomically with the insert, so\nconcurrent inserts never receive the same number. An organization\nthat has never had a content item is assigned row number 1 first\n(an explicit `rowNumber` of 0 is still accepted). A supplied\n`rowNumber` that another live content item of the organization\nalready holds refuses the insert with a 409.\n",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for inserting or updating a content item.\nContains only client-settable fields; the owning\n`organizationId` (derived from the authenticated session), the\nserver-computed `fingerprint` and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile"],properties:{id:{description:"Existing content item ID for updates; ignored on insert.","x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255},rowNumber:{type:"integer",description:`Row number of the content item, unique across the live content
|
|
20
|
+
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},description:"Content items included on this page of results."}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",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"}}}}}},post:{"x-internal":["cloud"],tags:["contentItems"],summary:"Insert a content item",operationId:"insertContentItem",description:"Inserts a new content item. Insert-only: any supplied\n`id` and `expectedFingerprint` are ignored; existing rows change\nonly through the conditional `updateContentItem`. The\n`fingerprint` is server-computed. Row numbers are unique across\nthe live content items of the organization, whatever their\n`profile`. When `rowNumber` is omitted the server assigns the next\nrow number of the organization (one more than the highest row\nnumber the organization has used, counting soft-deleted content\nitems so a deleted item's number is not handed out again by\nassignment), atomically with the insert, so\nconcurrent inserts never receive the same number. An organization\nthat has never had a content item is assigned row number 1 first\n(an explicit `rowNumber` of 0 is still accepted). A supplied\n`rowNumber` that another live content item of the organization\nalready holds refuses the insert with a 409.\n",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for inserting or updating a content item.\nContains only client-settable fields; the owning\n`organizationId` (derived from the authenticated session), the\nserver-computed `fingerprint` and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile"],properties:{id:{description:"Existing content item ID for updates; ignored on insert.","x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255},rowNumber:{type:"integer",description:`Row number of the content item, unique across the live content
|
|
21
21
|
items of the organization. Optional: omitted on insert, the
|
|
22
22
|
server assigns the next row number of the organization; omitted
|
|
23
23
|
on update, the stored row number is kept.
|
|
@@ -30,12 +30,12 @@ Content items carry a row number and a server-computed fingerprint over
|
|
|
30
30
|
their canonical values; updates are conditional on the fingerprint the
|
|
31
31
|
writer read, so stale writes are refused rather than silently applied.
|
|
32
32
|
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content item ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content item, unique across the live content items of the organization.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content item creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content item modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content item was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9},createdBy:{description:`ID of the user whose session created the content item. Derived from the authenticated session, never client-settable, and never changed by an update. Omitted on content items created before it was recorded, and when that user was later purged.
|
|
33
|
-
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/content-items/{contentItemId}":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"Get a content item by ID",operationId:"getContentItem",parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Content item response",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
|
|
33
|
+
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",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"}}}}}}},"/api/content-items/{contentItemId}":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"Get a content item by ID",operationId:"getContentItem",parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Content item response",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
|
|
34
34
|
Content items carry a row number and a server-computed fingerprint over
|
|
35
35
|
their canonical values; updates are conditional on the fingerprint the
|
|
36
36
|
writer read, so stale writes are refused rather than silently applied.
|
|
37
37
|
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content item ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content item, unique across the live content items of the organization.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content item creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content item modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content item was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9},createdBy:{description:`ID of the user whose session created the content item. Derived from the authenticated session, never client-settable, and never changed by an update. Omitted on content items created before it was recorded, and when that user was later purged.
|
|
38
|
-
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},put:{"x-internal":["cloud"],tags:["contentItems"],summary:"Update a content item",operationId:"updateContentItem",description:"Conditionally updates the content item. When\n`expectedFingerprint` is supplied and stale, the update is\nrefused with a 409, as is an update that would move the item\nonto a `rowNumber` another live content item of the organization\nholds. An omitted `rowNumber` keeps the stored one.\n",parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for inserting or updating a content item.\nContains only client-settable fields; the owning\n`organizationId` (derived from the authenticated session), the\nserver-computed `fingerprint` and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile"],properties:{id:{description:"Existing content item ID for updates; ignored on insert.","x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255},rowNumber:{type:"integer",description:`Row number of the content item, unique across the live content
|
|
38
|
+
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",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"}}}}}},put:{"x-internal":["cloud"],tags:["contentItems"],summary:"Update a content item",operationId:"updateContentItem",description:"Conditionally updates the content item. When\n`expectedFingerprint` is supplied and stale, the update is\nrefused with a 409, as is an update that would move the item\nonto a `rowNumber` another live content item of the organization\nholds. An omitted `rowNumber` keeps the stored one.\n",parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for inserting or updating a content item.\nContains only client-settable fields; the owning\n`organizationId` (derived from the authenticated session), the\nserver-computed `fingerprint` and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile"],properties:{id:{description:"Existing content item ID for updates; ignored on insert.","x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255},rowNumber:{type:"integer",description:`Row number of the content item, unique across the live content
|
|
39
39
|
items of the organization. Optional: omitted on insert, the
|
|
40
40
|
server assigns the next row number of the organization; omitted
|
|
41
41
|
on update, the stored row number is kept.
|
|
@@ -48,13 +48,13 @@ Content items carry a row number and a server-computed fingerprint over
|
|
|
48
48
|
their canonical values; updates are conditional on the fingerprint the
|
|
49
49
|
writer read, so stale writes are refused rather than silently applied.
|
|
50
50
|
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content item ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content item, unique across the live content items of the organization.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content item creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content item modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content item was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9},createdBy:{description:`ID of the user whose session created the content item. Derived from the authenticated session, never client-settable, and never changed by an update. Omitted on content items created before it was recorded, and when that user was later purged.
|
|
51
|
-
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["contentItems"],summary:"Delete a content item",operationId:"deleteContentItem",description:`Soft-deletes the content item. When \`expectedFingerprint\` is
|
|
51
|
+
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",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"}}}}}},delete:{"x-internal":["cloud"],tags:["contentItems"],summary:"Delete a content item",operationId:"deleteContentItem",description:`Soft-deletes the content item. When \`expectedFingerprint\` is
|
|
52
52
|
supplied, the delete applies only when the stored fingerprint
|
|
53
53
|
still matches and is refused with a 409 otherwise; without it the
|
|
54
54
|
delete is unconditional.
|
|
55
55
|
`,parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"expectedFingerprint",in:"query",description:`Optional optimistic-concurrency precondition for delete: the
|
|
56
56
|
delete applies only when the stored fingerprint still matches.
|
|
57
|
-
`,required:false,schema:{type:"string",maxLength:255}}],responses:{204:{description:"Content item deleted"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",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:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{expectedFingerprint:{name:"expectedFingerprint",in:"query",description:`Optional optimistic-concurrency precondition for delete: the
|
|
57
|
+
`,required:false,schema:{type:"string",maxLength:255}}],responses:{204:{description:"Content item deleted"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",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:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",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"}}}}}}}},parameters:{expectedFingerprint:{name:"expectedFingerprint",in:"query",description:`Optional optimistic-concurrency precondition for delete: the
|
|
58
58
|
delete applies only when the stored fingerprint still matches.
|
|
59
59
|
`,required:false,schema:{type:"string",maxLength:255}},contentItemId:{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},pageSize:{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},pagesize:{name:"pagesize",in:"query",description:"Number of items per page. Deprecated alias of pageSize;\ncanonical `pageSize` wins when both are present.\n",deprecated:true,schema:{type:"integer",minimum:1}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}}},schemas:{ContentItem:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
|
|
60
60
|
Content items carry a row number and a server-computed fingerprint over
|
|
@@ -17,7 +17,7 @@ Content items carry a row number and a server-computed fingerprint over
|
|
|
17
17
|
their canonical values; updates are conditional on the fingerprint the
|
|
18
18
|
writer read, so stale writes are refused rather than silently applied.
|
|
19
19
|
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content item ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content item, unique across the live content items of the organization.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content item creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content item modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content item was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9},createdBy:{description:`ID of the user whose session created the content item. Derived from the authenticated session, never client-settable, and never changed by an update. Omitted on content items created before it was recorded, and when that user was later purged.
|
|
20
|
-
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},description:"Content items included on this page of results."}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},post:{"x-internal":["cloud"],tags:["contentItems"],summary:"Insert a content item",operationId:"insertContentItem",description:"Inserts a new content item. Insert-only: any supplied\n`id` and `expectedFingerprint` are ignored; existing rows change\nonly through the conditional `updateContentItem`. The\n`fingerprint` is server-computed. Row numbers are unique across\nthe live content items of the organization, whatever their\n`profile`. When `rowNumber` is omitted the server assigns the next\nrow number of the organization (one more than the highest row\nnumber the organization has used, counting soft-deleted content\nitems so a deleted item's number is not handed out again by\nassignment), atomically with the insert, so\nconcurrent inserts never receive the same number. An organization\nthat has never had a content item is assigned row number 1 first\n(an explicit `rowNumber` of 0 is still accepted). A supplied\n`rowNumber` that another live content item of the organization\nalready holds refuses the insert with a 409.\n",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for inserting or updating a content item.\nContains only client-settable fields; the owning\n`organizationId` (derived from the authenticated session), the\nserver-computed `fingerprint` and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile"],properties:{id:{description:"Existing content item ID for updates; ignored on insert.","x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255},rowNumber:{type:"integer",description:`Row number of the content item, unique across the live content
|
|
20
|
+
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},description:"Content items included on this page of results."}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",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"}}}}}},post:{"x-internal":["cloud"],tags:["contentItems"],summary:"Insert a content item",operationId:"insertContentItem",description:"Inserts a new content item. Insert-only: any supplied\n`id` and `expectedFingerprint` are ignored; existing rows change\nonly through the conditional `updateContentItem`. The\n`fingerprint` is server-computed. Row numbers are unique across\nthe live content items of the organization, whatever their\n`profile`. When `rowNumber` is omitted the server assigns the next\nrow number of the organization (one more than the highest row\nnumber the organization has used, counting soft-deleted content\nitems so a deleted item's number is not handed out again by\nassignment), atomically with the insert, so\nconcurrent inserts never receive the same number. An organization\nthat has never had a content item is assigned row number 1 first\n(an explicit `rowNumber` of 0 is still accepted). A supplied\n`rowNumber` that another live content item of the organization\nalready holds refuses the insert with a 409.\n",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for inserting or updating a content item.\nContains only client-settable fields; the owning\n`organizationId` (derived from the authenticated session), the\nserver-computed `fingerprint` and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile"],properties:{id:{description:"Existing content item ID for updates; ignored on insert.","x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255},rowNumber:{type:"integer",description:`Row number of the content item, unique across the live content
|
|
21
21
|
items of the organization. Optional: omitted on insert, the
|
|
22
22
|
server assigns the next row number of the organization; omitted
|
|
23
23
|
on update, the stored row number is kept.
|
|
@@ -30,12 +30,12 @@ Content items carry a row number and a server-computed fingerprint over
|
|
|
30
30
|
their canonical values; updates are conditional on the fingerprint the
|
|
31
31
|
writer read, so stale writes are refused rather than silently applied.
|
|
32
32
|
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content item ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content item, unique across the live content items of the organization.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content item creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content item modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content item was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9},createdBy:{description:`ID of the user whose session created the content item. Derived from the authenticated session, never client-settable, and never changed by an update. Omitted on content items created before it was recorded, and when that user was later purged.
|
|
33
|
-
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/content-items/{contentItemId}":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"Get a content item by ID",operationId:"getContentItem",parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Content item response",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
|
|
33
|
+
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",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"}}}}}}},"/api/content-items/{contentItemId}":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"Get a content item by ID",operationId:"getContentItem",parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Content item response",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
|
|
34
34
|
Content items carry a row number and a server-computed fingerprint over
|
|
35
35
|
their canonical values; updates are conditional on the fingerprint the
|
|
36
36
|
writer read, so stale writes are refused rather than silently applied.
|
|
37
37
|
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content item ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content item, unique across the live content items of the organization.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content item creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content item modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content item was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9},createdBy:{description:`ID of the user whose session created the content item. Derived from the authenticated session, never client-settable, and never changed by an update. Omitted on content items created before it was recorded, and when that user was later purged.
|
|
38
|
-
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},put:{"x-internal":["cloud"],tags:["contentItems"],summary:"Update a content item",operationId:"updateContentItem",description:"Conditionally updates the content item. When\n`expectedFingerprint` is supplied and stale, the update is\nrefused with a 409, as is an update that would move the item\nonto a `rowNumber` another live content item of the organization\nholds. An omitted `rowNumber` keeps the stored one.\n",parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for inserting or updating a content item.\nContains only client-settable fields; the owning\n`organizationId` (derived from the authenticated session), the\nserver-computed `fingerprint` and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile"],properties:{id:{description:"Existing content item ID for updates; ignored on insert.","x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255},rowNumber:{type:"integer",description:`Row number of the content item, unique across the live content
|
|
38
|
+
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",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"}}}}}},put:{"x-internal":["cloud"],tags:["contentItems"],summary:"Update a content item",operationId:"updateContentItem",description:"Conditionally updates the content item. When\n`expectedFingerprint` is supplied and stale, the update is\nrefused with a 409, as is an update that would move the item\nonto a `rowNumber` another live content item of the organization\nholds. An omitted `rowNumber` keeps the stored one.\n",parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for inserting or updating a content item.\nContains only client-settable fields; the owning\n`organizationId` (derived from the authenticated session), the\nserver-computed `fingerprint` and the server-generated\n`createdAt` / `updatedAt` timestamps are intentionally excluded.\n",required:["profile"],properties:{id:{description:"Existing content item ID for updates; ignored on insert.","x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255},rowNumber:{type:"integer",description:`Row number of the content item, unique across the live content
|
|
39
39
|
items of the organization. Optional: omitted on insert, the
|
|
40
40
|
server assigns the next row number of the organization; omitted
|
|
41
41
|
on update, the stored row number is kept.
|
|
@@ -48,13 +48,13 @@ Content items carry a row number and a server-computed fingerprint over
|
|
|
48
48
|
their canonical values; updates are conditional on the fingerprint the
|
|
49
49
|
writer read, so stale writes are refused rather than silently applied.
|
|
50
50
|
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content item ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},profile:{type:"string",description:"Subject of the owning profile.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"profile"},"x-order":3},rowNumber:{type:"integer",description:"Row number of the content item, unique across the live content items of the organization.",minimum:0,"x-oapi-codegen-extra-tags":{db:"row_number"},"x-order":4},fingerprint:{type:"string",description:"Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"fingerprint"},"x-order":5},data:{type:"object",description:"Content values, stored as a JSON blob.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"data"},"x-order":6},createdAt:{description:"Timestamp of content item creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last content item modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the content item was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9},createdBy:{description:`ID of the user whose session created the content item. Derived from the authenticated session, never client-settable, and never changed by an update. Omitted on content items created before it was recorded, and when that user was later purged.
|
|
51
|
-
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["contentItems"],summary:"Delete a content item",operationId:"deleteContentItem",description:`Soft-deletes the content item. When \`expectedFingerprint\` is
|
|
51
|
+
`,"x-go-name":"CreatedBy","x-oapi-codegen-extra-tags":{db:"created_by",json:"createdBy,omitempty"},"x-order":10,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",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"}}}}}},delete:{"x-internal":["cloud"],tags:["contentItems"],summary:"Delete a content item",operationId:"deleteContentItem",description:`Soft-deletes the content item. When \`expectedFingerprint\` is
|
|
52
52
|
supplied, the delete applies only when the stored fingerprint
|
|
53
53
|
still matches and is refused with a 409 otherwise; without it the
|
|
54
54
|
delete is unconditional.
|
|
55
55
|
`,parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"expectedFingerprint",in:"query",description:`Optional optimistic-concurrency precondition for delete: the
|
|
56
56
|
delete applies only when the stored fingerprint still matches.
|
|
57
|
-
`,required:false,schema:{type:"string",maxLength:255}}],responses:{204:{description:"Content item deleted"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",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:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{expectedFingerprint:{name:"expectedFingerprint",in:"query",description:`Optional optimistic-concurrency precondition for delete: the
|
|
57
|
+
`,required:false,schema:{type:"string",maxLength:255}}],responses:{204:{description:"Content item deleted"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",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:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint, or another live content item of the organization already holds the same rowNumber",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"}}}}}}}},parameters:{expectedFingerprint:{name:"expectedFingerprint",in:"query",description:`Optional optimistic-concurrency precondition for delete: the
|
|
58
58
|
delete applies only when the stored fingerprint still matches.
|
|
59
59
|
`,required:false,schema:{type:"string",maxLength:255}},contentItemId:{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},pageSize:{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},pagesize:{name:"pagesize",in:"query",description:"Number of items per page. Deprecated alias of pageSize;\ncanonical `pageSize` wins when both are present.\n",deprecated:true,schema:{type:"integer",minimum:1}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}}},schemas:{ContentItem:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
|
|
60
60
|
Content items carry a row number and a server-computed fingerprint over
|
|
@@ -13,4 +13,4 @@ nullable: a blank cell is not a zero.
|
|
|
13
13
|
the \`metadata\` of a create-event call. Contains only client-settable
|
|
14
14
|
fields; the row has no server-generated fields, because the events
|
|
15
15
|
service stores and returns event metadata verbatim, so the payload
|
|
16
|
-
and the recorded row (ContentMetrics) share one field set.`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},impressionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic impressions that day; null when the export's cell is blank."},impressionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored impressions that day; null when the export's cell is blank."},impressions:{type:"integer",nullable:true,minimum:0,description:"All impressions that day; null when the export's cell is blank."},uniqueImpressions:{type:"integer",nullable:true,minimum:0,description:"Unique impressions that day (the export reports this figure for organic only); null when the export's cell is blank."},clicksOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic clicks that day; null when the export's cell is blank."},clicksSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored clicks that day; null when the export's cell is blank."},clicks:{type:"integer",nullable:true,minimum:0,description:"All clicks that day; null when the export's cell is blank."},reactionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reactions that day; null when the export's cell is blank."},reactionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reactions that day; null when the export's cell is blank."},reactions:{type:"integer",nullable:true,minimum:0,description:"All reactions that day; null when the export's cell is blank."},commentsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic comments that day; null when the export's cell is blank."},commentsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored comments that day; null when the export's cell is blank."},comments:{type:"integer",nullable:true,minimum:0,description:"All comments that day; null when the export's cell is blank."},repostsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reposts that day; null when the export's cell is blank."},repostsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reposts that day; null when the export's cell is blank."},reposts:{type:"integer",nullable:true,minimum:0,description:"All reposts that day; null when the export's cell is blank."},engagementRateOrganic:{type:"number",nullable:true,minimum:0,description:"Organic engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRateSponsored:{type:"number",nullable:true,minimum:0,description:"Sponsored engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRate:{type:"number",nullable:true,minimum:0,description:"Overall engagement rate that day, as the export reports it; null when the export's cell is blank."},sourceFile:{type:"string",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;
|
|
16
|
+
and the recorded row (ContentMetrics) share one field set.`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],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",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},impressionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic impressions that day; null when the export's cell is blank."},impressionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored impressions that day; null when the export's cell is blank."},impressions:{type:"integer",nullable:true,minimum:0,description:"All impressions that day; null when the export's cell is blank."},uniqueImpressions:{type:"integer",nullable:true,minimum:0,description:"Unique impressions that day (the export reports this figure for organic only); null when the export's cell is blank."},clicksOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic clicks that day; null when the export's cell is blank."},clicksSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored clicks that day; null when the export's cell is blank."},clicks:{type:"integer",nullable:true,minimum:0,description:"All clicks that day; null when the export's cell is blank."},reactionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reactions that day; null when the export's cell is blank."},reactionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reactions that day; null when the export's cell is blank."},reactions:{type:"integer",nullable:true,minimum:0,description:"All reactions that day; null when the export's cell is blank."},commentsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic comments that day; null when the export's cell is blank."},commentsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored comments that day; null when the export's cell is blank."},comments:{type:"integer",nullable:true,minimum:0,description:"All comments that day; null when the export's cell is blank."},repostsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reposts that day; null when the export's cell is blank."},repostsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reposts that day; null when the export's cell is blank."},reposts:{type:"integer",nullable:true,minimum:0,description:"All reposts that day; null when the export's cell is blank."},engagementRateOrganic:{type:"number",nullable:true,minimum:0,description:"Organic engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRateSponsored:{type:"number",nullable:true,minimum:0,description:"Sponsored engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRate:{type:"number",nullable:true,minimum:0,description:"Overall engagement rate that day, as the export reports it; null when the export's cell is blank."},sourceFile:{type:"string",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;
|
|
@@ -13,4 +13,4 @@ nullable: a blank cell is not a zero.
|
|
|
13
13
|
the \`metadata\` of a create-event call. Contains only client-settable
|
|
14
14
|
fields; the row has no server-generated fields, because the events
|
|
15
15
|
service stores and returns event metadata verbatim, so the payload
|
|
16
|
-
and the recorded row (ContentMetrics) share one field set.`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},impressionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic impressions that day; null when the export's cell is blank."},impressionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored impressions that day; null when the export's cell is blank."},impressions:{type:"integer",nullable:true,minimum:0,description:"All impressions that day; null when the export's cell is blank."},uniqueImpressions:{type:"integer",nullable:true,minimum:0,description:"Unique impressions that day (the export reports this figure for organic only); null when the export's cell is blank."},clicksOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic clicks that day; null when the export's cell is blank."},clicksSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored clicks that day; null when the export's cell is blank."},clicks:{type:"integer",nullable:true,minimum:0,description:"All clicks that day; null when the export's cell is blank."},reactionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reactions that day; null when the export's cell is blank."},reactionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reactions that day; null when the export's cell is blank."},reactions:{type:"integer",nullable:true,minimum:0,description:"All reactions that day; null when the export's cell is blank."},commentsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic comments that day; null when the export's cell is blank."},commentsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored comments that day; null when the export's cell is blank."},comments:{type:"integer",nullable:true,minimum:0,description:"All comments that day; null when the export's cell is blank."},repostsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reposts that day; null when the export's cell is blank."},repostsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reposts that day; null when the export's cell is blank."},reposts:{type:"integer",nullable:true,minimum:0,description:"All reposts that day; null when the export's cell is blank."},engagementRateOrganic:{type:"number",nullable:true,minimum:0,description:"Organic engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRateSponsored:{type:"number",nullable:true,minimum:0,description:"Sponsored engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRate:{type:"number",nullable:true,minimum:0,description:"Overall engagement rate that day, as the export reports it; null when the export's cell is blank."},sourceFile:{type:"string",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};
|
|
16
|
+
and the recorded row (ContentMetrics) share one field set.`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],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",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},impressionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic impressions that day; null when the export's cell is blank."},impressionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored impressions that day; null when the export's cell is blank."},impressions:{type:"integer",nullable:true,minimum:0,description:"All impressions that day; null when the export's cell is blank."},uniqueImpressions:{type:"integer",nullable:true,minimum:0,description:"Unique impressions that day (the export reports this figure for organic only); null when the export's cell is blank."},clicksOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic clicks that day; null when the export's cell is blank."},clicksSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored clicks that day; null when the export's cell is blank."},clicks:{type:"integer",nullable:true,minimum:0,description:"All clicks that day; null when the export's cell is blank."},reactionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reactions that day; null when the export's cell is blank."},reactionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reactions that day; null when the export's cell is blank."},reactions:{type:"integer",nullable:true,minimum:0,description:"All reactions that day; null when the export's cell is blank."},commentsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic comments that day; null when the export's cell is blank."},commentsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored comments that day; null when the export's cell is blank."},comments:{type:"integer",nullable:true,minimum:0,description:"All comments that day; null when the export's cell is blank."},repostsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reposts that day; null when the export's cell is blank."},repostsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reposts that day; null when the export's cell is blank."},reposts:{type:"integer",nullable:true,minimum:0,description:"All reposts that day; null when the export's cell is blank."},engagementRateOrganic:{type:"number",nullable:true,minimum:0,description:"Organic engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRateSponsored:{type:"number",nullable:true,minimum:0,description:"Sponsored engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRate:{type:"number",nullable:true,minimum:0,description:"Overall engagement rate that day, as the export reports it; null when the export's cell is blank."},sourceFile:{type:"string",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};
|