@meshery/schemas 1.3.90 → 1.3.91

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/dist/cloudApi.d.mts +4307 -4307
  2. package/dist/cloudApi.d.ts +4307 -4307
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta3/activity_result/ActivityResult.d.ts +1 -1
  6. package/dist/constructs/v1beta3/activity_result/ActivityResultSchema.js +1 -1
  7. package/dist/constructs/v1beta3/activity_result/ActivityResultSchema.mjs +1 -1
  8. package/dist/constructs/v1beta3/{content_piece/ContentPiece.d.ts → content_item/ContentItem.d.ts} +96 -96
  9. package/dist/constructs/v1beta3/content_item/ContentItemSchema.d.ts +2 -0
  10. package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +71 -0
  11. package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +71 -0
  12. package/dist/constructs/v1beta3/profile/Profile.d.ts +7 -4
  13. package/dist/constructs/v1beta3/profile/ProfileSchema.js +8 -5
  14. package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +8 -5
  15. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +2 -2
  16. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +1 -1
  17. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +1 -1
  18. package/dist/permissions.d.mts +29 -29
  19. package/dist/permissions.d.ts +29 -29
  20. package/dist/permissions.js +1 -1
  21. package/dist/permissions.mjs +1 -1
  22. package/package.json +1 -1
  23. package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.d.ts +0 -2
  24. package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.js +0 -71
  25. package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.mjs +0 -71
  26. /package/dist/constructs/v1beta3/{content_piece/ContentPiece.js → content_item/ContentItem.js} +0 -0
  27. /package/dist/constructs/v1beta3/{content_piece/ContentPiece.mjs → content_item/ContentItem.mjs} +0 -0
@@ -0,0 +1,71 @@
1
+ 'use strict';var e={openapi:"3.0.0",info:{title:"ContentItem",description:`OpenAPI schema for content items - fingerprinted content
2
+ values keyed by organization and row number, with conditional
3
+ updates.
4
+ Organization scope: every operation acts only in the organization the
5
+ session resolved to (X-Current-Orgid, then the user's selected
6
+ organization), and only when the caller is a live member of it.
7
+ Authorization: each operation requires one permission key in that
8
+ organization (Catalog Management / Content Items: View Content
9
+ Items for the reads, Create Content Item, Edit Content Item and
10
+ Delete Content Item for the writes); a caller without it receives a
11
+ 403 before any row is read. Past that check, an id that does not name
12
+ a live content item of the organization, and a caller who is not a
13
+ live member of it, receive the same 404, so the existence of another
14
+ organization's rows is never disclosed.
15
+ `,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"contentItems",description:"Operations related to content items."}],paths:{"/api/content-items":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"List content items",operationId:"listContentItems",description:"Returns a paginated list of the live content items in the\norganization of the authenticated session, ordered by `rowNumber`\nunless `order` names another column (`rowNumber`, `createdAt`,\n`updatedAt`). `search` matches the profile or the content values,\ncase-insensitively.\n",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},{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}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"profile",in:"query",required:false,description:"Filter by owning profile subject (exact match).",schema:{type:"string"}}],responses:{200:{description:"Content item page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of content items.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},contentItems:{type:"array",items:{"x-go-type":"ContentItem",$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
16
+ Content items carry a row number and a server-computed fingerprint over
17
+ their canonical values; updates are conditional on the fingerprint the
18
+ writer read, so stale writes are refused rather than silently applied.
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}}},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
+ items of the organization. Optional: omitted on insert, the
21
+ server assigns the next row number of the organization; omitted
22
+ on update, the stored row number is kept.
23
+ `,minimum:0},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},expectedFingerprint:{type:"string",description:`Optimistic-concurrency precondition for update: when supplied,
24
+ the update applies only when the stored fingerprint still
25
+ matches, and is refused with a 409 otherwise. Ignored on
26
+ insert.
27
+ `,maxLength:255}}}}}},responses:{201:{description:"Content item created",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.
28
+ Content items carry a row number and a server-computed fingerprint over
29
+ their canonical values; updates are conditional on the fingerprint the
30
+ writer read, so stale writes are refused rather than silently applied.
31
+ `,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}}}}}},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.
32
+ Content items carry a row number and a server-computed fingerprint over
33
+ their canonical values; updates are conditional on the fingerprint the
34
+ writer read, so stale writes are refused rather than silently applied.
35
+ `,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}}}}}},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
36
+ items of the organization. Optional: omitted on insert, the
37
+ server assigns the next row number of the organization; omitted
38
+ on update, the stored row number is kept.
39
+ `,minimum:0},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},expectedFingerprint:{type:"string",description:`Optimistic-concurrency precondition for update: when supplied,
40
+ the update applies only when the stored fingerprint still
41
+ matches, and is refused with a 409 otherwise. Ignored on
42
+ insert.
43
+ `,maxLength:255}}}}}},responses:{200:{description:"Content item updated",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.
44
+ Content items carry a row number and a server-computed fingerprint over
45
+ their canonical values; updates are conditional on the fingerprint the
46
+ writer read, so stale writes are refused rather than silently applied.
47
+ `,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}}}}}},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
48
+ supplied, the delete applies only when the stored fingerprint
49
+ still matches and is refused with a 409 otherwise; without it the
50
+ delete is unconditional.
51
+ `,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
52
+ delete applies only when the stored fingerprint still matches.
53
+ `,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
54
+ delete applies only when the stored fingerprint still matches.
55
+ `,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.
56
+ Content items carry a row number and a server-computed fingerprint over
57
+ their canonical values; updates are conditional on the fingerprint the
58
+ writer read, so stale writes are refused rather than silently applied.
59
+ `,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}}},ContentItemPayload:{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
60
+ items of the organization. Optional: omitted on insert, the
61
+ server assigns the next row number of the organization; omitted
62
+ on update, the stored row number is kept.
63
+ `,minimum:0},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},expectedFingerprint:{type:"string",description:`Optimistic-concurrency precondition for update: when supplied,
64
+ the update applies only when the stored fingerprint still
65
+ matches, and is refused with a 409 otherwise. Ignored on
66
+ insert.
67
+ `,maxLength:255}}},ContentItemPage:{type:"object",description:"Paginated collection of content items.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},contentItems:{type:"array",items:{"x-go-type":"ContentItem",$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
68
+ Content items carry a row number and a server-computed fingerprint over
69
+ their canonical values; updates are conditional on the fingerprint the
70
+ writer read, so stale writes are refused rather than silently applied.
71
+ `,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}}},description:"Content items included on this page of results."}}}}}},t=e;module.exports=t;
@@ -0,0 +1,71 @@
1
+ var e={openapi:"3.0.0",info:{title:"ContentItem",description:`OpenAPI schema for content items - fingerprinted content
2
+ values keyed by organization and row number, with conditional
3
+ updates.
4
+ Organization scope: every operation acts only in the organization the
5
+ session resolved to (X-Current-Orgid, then the user's selected
6
+ organization), and only when the caller is a live member of it.
7
+ Authorization: each operation requires one permission key in that
8
+ organization (Catalog Management / Content Items: View Content
9
+ Items for the reads, Create Content Item, Edit Content Item and
10
+ Delete Content Item for the writes); a caller without it receives a
11
+ 403 before any row is read. Past that check, an id that does not name
12
+ a live content item of the organization, and a caller who is not a
13
+ live member of it, receive the same 404, so the existence of another
14
+ organization's rows is never disclosed.
15
+ `,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"contentItems",description:"Operations related to content items."}],paths:{"/api/content-items":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"List content items",operationId:"listContentItems",description:"Returns a paginated list of the live content items in the\norganization of the authenticated session, ordered by `rowNumber`\nunless `order` names another column (`rowNumber`, `createdAt`,\n`updatedAt`). `search` matches the profile or the content values,\ncase-insensitively.\n",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},{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}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"profile",in:"query",required:false,description:"Filter by owning profile subject (exact match).",schema:{type:"string"}}],responses:{200:{description:"Content item page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of content items.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},contentItems:{type:"array",items:{"x-go-type":"ContentItem",$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
16
+ Content items carry a row number and a server-computed fingerprint over
17
+ their canonical values; updates are conditional on the fingerprint the
18
+ writer read, so stale writes are refused rather than silently applied.
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}}},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
+ items of the organization. Optional: omitted on insert, the
21
+ server assigns the next row number of the organization; omitted
22
+ on update, the stored row number is kept.
23
+ `,minimum:0},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},expectedFingerprint:{type:"string",description:`Optimistic-concurrency precondition for update: when supplied,
24
+ the update applies only when the stored fingerprint still
25
+ matches, and is refused with a 409 otherwise. Ignored on
26
+ insert.
27
+ `,maxLength:255}}}}}},responses:{201:{description:"Content item created",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.
28
+ Content items carry a row number and a server-computed fingerprint over
29
+ their canonical values; updates are conditional on the fingerprint the
30
+ writer read, so stale writes are refused rather than silently applied.
31
+ `,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}}}}}},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.
32
+ Content items carry a row number and a server-computed fingerprint over
33
+ their canonical values; updates are conditional on the fingerprint the
34
+ writer read, so stale writes are refused rather than silently applied.
35
+ `,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}}}}}},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
36
+ items of the organization. Optional: omitted on insert, the
37
+ server assigns the next row number of the organization; omitted
38
+ on update, the stored row number is kept.
39
+ `,minimum:0},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},expectedFingerprint:{type:"string",description:`Optimistic-concurrency precondition for update: when supplied,
40
+ the update applies only when the stored fingerprint still
41
+ matches, and is refused with a 409 otherwise. Ignored on
42
+ insert.
43
+ `,maxLength:255}}}}}},responses:{200:{description:"Content item updated",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.
44
+ Content items carry a row number and a server-computed fingerprint over
45
+ their canonical values; updates are conditional on the fingerprint the
46
+ writer read, so stale writes are refused rather than silently applied.
47
+ `,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}}}}}},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
48
+ supplied, the delete applies only when the stored fingerprint
49
+ still matches and is refused with a 409 otherwise; without it the
50
+ delete is unconditional.
51
+ `,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
52
+ delete applies only when the stored fingerprint still matches.
53
+ `,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
54
+ delete applies only when the stored fingerprint still matches.
55
+ `,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.
56
+ Content items carry a row number and a server-computed fingerprint over
57
+ their canonical values; updates are conditional on the fingerprint the
58
+ writer read, so stale writes are refused rather than silently applied.
59
+ `,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}}},ContentItemPayload:{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
60
+ items of the organization. Optional: omitted on insert, the
61
+ server assigns the next row number of the organization; omitted
62
+ on update, the stored row number is kept.
63
+ `,minimum:0},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},expectedFingerprint:{type:"string",description:`Optimistic-concurrency precondition for update: when supplied,
64
+ the update applies only when the stored fingerprint still
65
+ matches, and is refused with a 409 otherwise. Ignored on
66
+ insert.
67
+ `,maxLength:255}}},ContentItemPage:{type:"object",description:"Paginated collection of content items.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},contentItems:{type:"array",items:{"x-go-type":"ContentItem",$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
68
+ Content items carry a row number and a server-computed fingerprint over
69
+ their canonical values; updates are conditional on the fingerprint the
70
+ writer read, so stale writes are refused rather than silently applied.
71
+ `,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}}},description:"Content items included on this page of results."}}}}}},t=e;export{t as default};
@@ -13,7 +13,7 @@ export interface paths {
13
13
  };
14
14
  /**
15
15
  * Get all profiles
16
- * @description Gets the live profiles the caller can see: those assigned to a workspace the caller is a member of, those the caller owns, and, for organization admins, every profile of the organization. `search` matches the name or description case-insensitively.
16
+ * @description Gets the live profiles the caller can see: those the caller owns (including profiles assigned to no workspace), those assigned to a workspace the caller is a member of, and, for organization admins, every profile of the organization. Provider admins are not granted visibility automatically. `search` matches the name or description case-insensitively.
17
17
  */
18
18
  get: operations["getProfiles"];
19
19
  put?: never;
@@ -35,7 +35,10 @@ export interface paths {
35
35
  path?: never;
36
36
  cookie?: never;
37
37
  };
38
- /** Get profile by ID */
38
+ /**
39
+ * Get profile by ID
40
+ * @description Gets a profile visible to the caller: its owner (whether or not the profile is assigned to any workspace), an organization admin, or a member of a workspace it is assigned to. Provider admins are not granted visibility automatically. A profile the caller cannot see returns 404. Seeing the profile does not grant access to its linked connections.
41
+ */
39
42
  get: operations["getProfileById"];
40
43
  /**
41
44
  * Update a profile
@@ -62,7 +65,7 @@ export interface paths {
62
65
  };
63
66
  /**
64
67
  * Get profile connections
65
- * @description Gets the connections linked to the profile. Requires View Profiles and visibility of the profile.
68
+ * @description Gets the connections linked to the profile. Requires View Profiles and visibility of the profile. Visibility of the profile alone does not grant access to the linked connections, which follow their own access rules.
66
69
  */
67
70
  get: operations["getProfileConnections"];
68
71
  put?: never;
@@ -103,7 +106,7 @@ export interface components {
103
106
  schemas: {
104
107
  /**
105
108
  * Profile
106
- * @description A profile is a publishing or persona profile: a named set of settings, owned by an organization, that a person or brand publishes as, with the platform accounts it acts through linked to it as Connections. It is not the user account profile (`/api/identity/users/profile`) and not a performance profile (`/api/performance/profiles`), and it is neither an environment nor a workspace. Like environments, a profile is assigned to any number of workspaces, and workspace assignment is how access to it is granted: a profile is readable by members of the workspaces it is assigned to and by organization admins.
109
+ * @description A profile is a publishing or persona profile: a named set of settings, owned by an organization, that a person or brand publishes as, with the platform accounts it acts through linked to it as Connections. It is not the user account profile (`/api/identity/users/profile`) and not a performance profile (`/api/performance/profiles`), and it is neither an environment nor a workspace. Like environments, a profile is assigned to any number of workspaces, and workspace assignment is how access to it is shared: a profile is readable by its owner (whether or not it is assigned to any workspace), by organization admins, and by members of the workspaces it is assigned to. Provider admins do not see profiles automatically, and seeing a profile does not grant access to its linked connections.
107
110
  * @example {
108
111
  * "id": "00000000-0000-0000-0000-000000000000",
109
112
  * "schemaVersion": "profiles.meshery.io/v1beta3",