@meshery/schemas 1.3.71 → 1.3.73

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 (46) hide show
  1. package/dist/cloudApi.d.mts +23587 -20815
  2. package/dist/cloudApi.d.ts +23587 -20815
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +4 -0
  6. package/dist/constructs/v1beta2/schedule/ScheduleSchema.js +7 -4
  7. package/dist/constructs/v1beta2/schedule/ScheduleSchema.mjs +7 -4
  8. package/dist/constructs/v1beta3/academy/Academy.d.ts +18 -0
  9. package/dist/constructs/v1beta3/academy/AcademySchema.js +2 -2
  10. package/dist/constructs/v1beta3/academy/AcademySchema.mjs +2 -2
  11. package/dist/constructs/v1beta3/claim/Claim.d.ts +919 -0
  12. package/dist/constructs/v1beta3/claim/ClaimSchema.d.ts +2 -0
  13. package/dist/constructs/v1beta3/claim/ClaimSchema.js +88 -0
  14. package/dist/constructs/v1beta3/claim/ClaimSchema.mjs +88 -0
  15. package/dist/constructs/v1beta3/connection/Connection.d.ts +5 -0
  16. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
  17. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
  18. package/dist/constructs/v1beta3/{blowhorn_content/BlowhornContent.d.ts → content_piece/ContentPiece.d.ts} +101 -83
  19. package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.d.ts +2 -0
  20. package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.js +48 -0
  21. package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.mjs +48 -0
  22. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +66 -0
  23. package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
  24. package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
  25. package/dist/constructs/v1beta3/schedule/Schedule.d.ts +3804 -0
  26. package/dist/constructs/v1beta3/schedule/Schedule.js +1 -0
  27. package/dist/constructs/v1beta3/schedule/Schedule.mjs +0 -0
  28. package/dist/constructs/v1beta3/schedule/ScheduleSchema.d.ts +2 -0
  29. package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +61 -0
  30. package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +61 -0
  31. package/dist/index.d.mts +17 -1
  32. package/dist/index.d.ts +17 -1
  33. package/dist/index.js +2 -2
  34. package/dist/index.mjs +2 -2
  35. package/package.json +1 -1
  36. package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.d.ts +0 -2
  37. package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.js +0 -43
  38. package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.mjs +0 -43
  39. package/dist/constructs/v1beta3/job_lease/JobLease.d.ts +0 -2570
  40. package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.d.ts +0 -2
  41. package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.js +0 -83
  42. package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.mjs +0 -83
  43. /package/dist/constructs/v1beta3/{blowhorn_content/BlowhornContent.js → claim/Claim.js} +0 -0
  44. /package/dist/constructs/v1beta3/{blowhorn_content/BlowhornContent.mjs → claim/Claim.mjs} +0 -0
  45. /package/dist/constructs/v1beta3/{job_lease/JobLease.js → content_piece/ContentPiece.js} +0 -0
  46. /package/dist/constructs/v1beta3/{job_lease/JobLease.mjs → content_piece/ContentPiece.mjs} +0 -0
@@ -0,0 +1,48 @@
1
+ var e={openapi:"3.0.0",info:{title:"ContentPiece",description:`OpenAPI schema for content pieces - fingerprinted content
2
+ values keyed by owning profile 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. A
7
+ caller who is not a member receives the same 404 as an unknown id, so
8
+ the existence of another organization's rows is never disclosed.
9
+ `,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:"contentPieces",description:"Operations related to content pieces."}],paths:{"/api/content/pieces":{get:{"x-internal":["cloud"],tags:["contentPieces"],summary:"List content pieces",operationId:"listContentPieces",description:"Returns a paginated list of content pieces in the organization of the authenticated session.",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.",schema:{type:"string"}}],responses:{200:{description:"Content piece page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of content pieces.",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},contentPieces:{type:"array",items:{"x-go-type":"ContentPiece",$schema:"http://json-schema.org/draft-07/schema#",title:"Content Piece Schema",description:`Server-returned content piece as persisted by meshery-cloud.
10
+ Content pieces carry a row number and a server-computed fingerprint over
11
+ their canonical values; updates are conditional on the fingerprint the
12
+ writer read, so stale writes are refused rather than silently applied.
13
+ `,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 within the owning profile.",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 piece 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 piece 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 piece 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 pieces included on this page of results."}}}}}},401:{description:"Expired JWT token used or insufficient privilege",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:["contentPieces"],summary:"Insert a content piece",operationId:"insertContentPiece",description:"Inserts a new content piece. Insert-only: any supplied\n`id` and `expectedFingerprint` are ignored; existing rows change\nonly through the conditional `updateContentPiece`. The\n`fingerprint` is server-computed.\n",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for inserting or updating a content piece.\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","rowNumber"],properties:{id:{description:"Existing content piece 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 within the owning profile.",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,
14
+ the update applies only when the stored fingerprint still
15
+ matches, and is refused with a 409 otherwise. Ignored on
16
+ insert.
17
+ `,maxLength:255}}}}}},responses:{201:{description:"Content piece created",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Piece Schema",description:`Server-returned content piece as persisted by meshery-cloud.
18
+ Content pieces carry a row number and a server-computed fingerprint over
19
+ their canonical values; updates are conditional on the fingerprint the
20
+ writer read, so stale writes are refused rather than silently applied.
21
+ `,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 within the owning profile.",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 piece 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 piece 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 piece 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"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/content/pieces/{contentPieceId}":{get:{"x-internal":["cloud"],tags:["contentPieces"],summary:"Get a content piece by ID",operationId:"getContentPiece",parameters:[{name:"contentPieceId",in:"path",description:"Content piece 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 piece response",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Piece Schema",description:`Server-returned content piece as persisted by meshery-cloud.
22
+ Content pieces carry a row number and a server-computed fingerprint over
23
+ their canonical values; updates are conditional on the fingerprint the
24
+ writer read, so stale writes are refused rather than silently applied.
25
+ `,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 within the owning profile.",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 piece 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 piece 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 piece 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"}}}},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:["contentPieces"],summary:"Update a content piece",operationId:"updateContentPiece",description:`Conditionally updates the content piece. When
26
+ \`expectedFingerprint\` is supplied and stale, the update is
27
+ refused with a 409.
28
+ `,parameters:[{name:"contentPieceId",in:"path",description:"Content piece 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 piece.\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","rowNumber"],properties:{id:{description:"Existing content piece 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 within the owning profile.",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,
29
+ the update applies only when the stored fingerprint still
30
+ matches, and is refused with a 409 otherwise. Ignored on
31
+ insert.
32
+ `,maxLength:255}}}}}},responses:{200:{description:"Content piece updated",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Piece Schema",description:`Server-returned content piece as persisted by meshery-cloud.
33
+ Content pieces carry a row number and a server-computed fingerprint over
34
+ their canonical values; updates are conditional on the fingerprint the
35
+ writer read, so stale writes are refused rather than silently applied.
36
+ `,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 within the owning profile.",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 piece 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 piece 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 piece 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"}}}},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",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["contentPieces"],summary:"Delete a content piece",operationId:"deleteContentPiece",description:"Soft-deletes the content piece.",parameters:[{name:"contentPieceId",in:"path",description:"Content piece 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:{204:{description:"Content piece deleted"},401:{description:"Expired JWT token used or insufficient privilege",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"}}}}}}}},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"}}}},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",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{contentPieceId:{name:"contentPieceId",in:"path",description:"Content piece 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:{ContentPiece:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Piece Schema",description:`Server-returned content piece as persisted by meshery-cloud.
37
+ Content pieces carry a row number and a server-computed fingerprint over
38
+ their canonical values; updates are conditional on the fingerprint the
39
+ writer read, so stale writes are refused rather than silently applied.
40
+ `,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 within the owning profile.",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 piece 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 piece 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 piece 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}}},ContentPiecePayload:{type:"object",description:"Payload for inserting or updating a content piece.\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","rowNumber"],properties:{id:{description:"Existing content piece 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 within the owning profile.",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,
41
+ the update applies only when the stored fingerprint still
42
+ matches, and is refused with a 409 otherwise. Ignored on
43
+ insert.
44
+ `,maxLength:255}}},ContentPiecePage:{type:"object",description:"Paginated collection of content pieces.",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},contentPieces:{type:"array",items:{"x-go-type":"ContentPiece",$schema:"http://json-schema.org/draft-07/schema#",title:"Content Piece Schema",description:`Server-returned content piece as persisted by meshery-cloud.
45
+ Content pieces carry a row number and a server-computed fingerprint over
46
+ their canonical values; updates are conditional on the fingerprint the
47
+ writer read, so stale writes are refused rather than silently applied.
48
+ `,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 within the owning profile.",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 piece 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 piece 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 piece 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 pieces included on this page of results."}}}}}},t=e;export{t as default};
@@ -205,6 +205,12 @@ export interface components {
205
205
  * @enum {string}
206
206
  */
207
207
  acceptanceOutcome: "direct_membership" | "child_organization";
208
+ /**
209
+ * @description Determines what branding a child organization created by accepting this invitation starts with. Applies only when acceptanceOutcome is child_organization; ignored otherwise. parent (the default, including every invitation that omits this property) copies the inviting organization's branding into the child at creation: theme (logos and colors), authentication-page branding, email branding (sender name, templates, and footer), links (including social profiles), and the authentication-page carousel setting. provider copies the provider organization's branding instead. none gives the child no branding of its own. Every copy is a snapshot: later changes to the source do not propagate, and the child's administrators can change its branding afterwards without affecting the source.
210
+ * @default parent
211
+ * @enum {string}
212
+ */
213
+ childOrganizationBranding: "parent" | "provider" | "none";
208
214
  /**
209
215
  * @description Activation status of the invitation.
210
216
  * @enum {string}
@@ -428,6 +434,12 @@ export interface components {
428
434
  * @enum {string}
429
435
  */
430
436
  acceptanceOutcome: "direct_membership" | "child_organization";
437
+ /**
438
+ * @description Determines what branding a child organization created by accepting this invitation starts with. Applies only when acceptanceOutcome is child_organization; ignored otherwise. parent (the default, including every invitation that omits this property) copies the inviting organization's branding into the child at creation: theme (logos and colors), authentication-page branding, email branding (sender name, templates, and footer), links (including social profiles), and the authentication-page carousel setting. provider copies the provider organization's branding instead. none gives the child no branding of its own. Every copy is a snapshot: later changes to the source do not propagate, and the child's administrators can change its branding afterwards without affecting the source.
439
+ * @default parent
440
+ * @enum {string}
441
+ */
442
+ childOrganizationBranding: "parent" | "provider" | "none";
431
443
  /**
432
444
  * @description Activation status of the invitation.
433
445
  * @enum {string}
@@ -445,6 +457,12 @@ export interface components {
445
457
  * @enum {string}
446
458
  */
447
459
  InvitationAcceptanceOutcome: "direct_membership" | "child_organization";
460
+ /**
461
+ * @description Branding a child organization created through an invitation starts with: parent (default) copies the inviting organization's branding, provider copies the provider organization's branding, none gives the child no branding of its own. A snapshot taken at creation.
462
+ * @default parent
463
+ * @enum {string}
464
+ */
465
+ InvitationChildOrganizationBranding: "parent" | "provider" | "none";
448
466
  /** @description Invitation entity schema. */
449
467
  Invitation: {
450
468
  /**
@@ -489,6 +507,12 @@ export interface components {
489
507
  * @enum {string}
490
508
  */
491
509
  acceptanceOutcome: "direct_membership" | "child_organization";
510
+ /**
511
+ * @description Determines what branding a child organization created by accepting this invitation starts with. Applies only when acceptanceOutcome is child_organization; ignored otherwise. parent (the default, including every invitation that omits this property) copies the inviting organization's branding into the child at creation: theme (logos and colors), authentication-page branding, email branding (sender name, templates, and footer), links (including social profiles), and the authentication-page carousel setting. provider copies the provider organization's branding instead. none gives the child no branding of its own. Every copy is a snapshot: later changes to the source do not propagate, and the child's administrators can change its branding afterwards without affecting the source.
512
+ * @default parent
513
+ * @enum {string}
514
+ */
515
+ childOrganizationBranding: "parent" | "provider" | "none";
492
516
  /**
493
517
  * @description Activation status of the invitation.
494
518
  * @enum {string}
@@ -745,6 +769,12 @@ export interface operations {
745
769
  * @enum {string}
746
770
  */
747
771
  acceptanceOutcome: "direct_membership" | "child_organization";
772
+ /**
773
+ * @description Determines what branding a child organization created by accepting this invitation starts with. Applies only when acceptanceOutcome is child_organization; ignored otherwise. parent (the default, including every invitation that omits this property) copies the inviting organization's branding into the child at creation: theme (logos and colors), authentication-page branding, email branding (sender name, templates, and footer), links (including social profiles), and the authentication-page carousel setting. provider copies the provider organization's branding instead. none gives the child no branding of its own. Every copy is a snapshot: later changes to the source do not propagate, and the child's administrators can change its branding afterwards without affecting the source.
774
+ * @default parent
775
+ * @enum {string}
776
+ */
777
+ childOrganizationBranding: "parent" | "provider" | "none";
748
778
  /**
749
779
  * @description Activation status of the invitation.
750
780
  * @enum {string}
@@ -859,6 +889,12 @@ export interface operations {
859
889
  * @enum {string}
860
890
  */
861
891
  acceptanceOutcome?: "direct_membership" | "child_organization";
892
+ /**
893
+ * @description Determines what branding a child organization created by accepting this invitation starts with. Applies only when acceptanceOutcome is child_organization; ignored otherwise. parent (the default, including every invitation that omits this property) copies the inviting organization's branding into the child at creation: theme (logos and colors), authentication-page branding, email branding (sender name, templates, and footer), links (including social profiles), and the authentication-page carousel setting. provider copies the provider organization's branding instead. none gives the child no branding of its own. Every copy is a snapshot: later changes to the source do not propagate, and the child's administrators can change its branding afterwards without affecting the source.
894
+ * @default parent
895
+ * @enum {string}
896
+ */
897
+ childOrganizationBranding?: "parent" | "provider" | "none";
862
898
  /**
863
899
  * @description Activation status of the invitation.
864
900
  * @enum {string}
@@ -917,6 +953,12 @@ export interface operations {
917
953
  * @enum {string}
918
954
  */
919
955
  acceptanceOutcome: "direct_membership" | "child_organization";
956
+ /**
957
+ * @description Determines what branding a child organization created by accepting this invitation starts with. Applies only when acceptanceOutcome is child_organization; ignored otherwise. parent (the default, including every invitation that omits this property) copies the inviting organization's branding into the child at creation: theme (logos and colors), authentication-page branding, email branding (sender name, templates, and footer), links (including social profiles), and the authentication-page carousel setting. provider copies the provider organization's branding instead. none gives the child no branding of its own. Every copy is a snapshot: later changes to the source do not propagate, and the child's administrators can change its branding afterwards without affecting the source.
958
+ * @default parent
959
+ * @enum {string}
960
+ */
961
+ childOrganizationBranding: "parent" | "provider" | "none";
920
962
  /**
921
963
  * @description Activation status of the invitation.
922
964
  * @enum {string}
@@ -1177,6 +1219,12 @@ export interface operations {
1177
1219
  * @enum {string}
1178
1220
  */
1179
1221
  acceptanceOutcome: "direct_membership" | "child_organization";
1222
+ /**
1223
+ * @description Determines what branding a child organization created by accepting this invitation starts with. Applies only when acceptanceOutcome is child_organization; ignored otherwise. parent (the default, including every invitation that omits this property) copies the inviting organization's branding into the child at creation: theme (logos and colors), authentication-page branding, email branding (sender name, templates, and footer), links (including social profiles), and the authentication-page carousel setting. provider copies the provider organization's branding instead. none gives the child no branding of its own. Every copy is a snapshot: later changes to the source do not propagate, and the child's administrators can change its branding afterwards without affecting the source.
1224
+ * @default parent
1225
+ * @enum {string}
1226
+ */
1227
+ childOrganizationBranding: "parent" | "provider" | "none";
1180
1228
  /**
1181
1229
  * @description Activation status of the invitation.
1182
1230
  * @enum {string}
@@ -1280,6 +1328,12 @@ export interface operations {
1280
1328
  * @enum {string}
1281
1329
  */
1282
1330
  acceptanceOutcome?: "direct_membership" | "child_organization";
1331
+ /**
1332
+ * @description Determines what branding a child organization created by accepting this invitation starts with. Applies only when acceptanceOutcome is child_organization; ignored otherwise. parent (the default, including every invitation that omits this property) copies the inviting organization's branding into the child at creation: theme (logos and colors), authentication-page branding, email branding (sender name, templates, and footer), links (including social profiles), and the authentication-page carousel setting. provider copies the provider organization's branding instead. none gives the child no branding of its own. Every copy is a snapshot: later changes to the source do not propagate, and the child's administrators can change its branding afterwards without affecting the source.
1333
+ * @default parent
1334
+ * @enum {string}
1335
+ */
1336
+ childOrganizationBranding?: "parent" | "provider" | "none";
1283
1337
  /**
1284
1338
  * @description Activation status of the invitation.
1285
1339
  * @enum {string}
@@ -1338,6 +1392,12 @@ export interface operations {
1338
1392
  * @enum {string}
1339
1393
  */
1340
1394
  acceptanceOutcome: "direct_membership" | "child_organization";
1395
+ /**
1396
+ * @description Determines what branding a child organization created by accepting this invitation starts with. Applies only when acceptanceOutcome is child_organization; ignored otherwise. parent (the default, including every invitation that omits this property) copies the inviting organization's branding into the child at creation: theme (logos and colors), authentication-page branding, email branding (sender name, templates, and footer), links (including social profiles), and the authentication-page carousel setting. provider copies the provider organization's branding instead. none gives the child no branding of its own. Every copy is a snapshot: later changes to the source do not propagate, and the child's administrators can change its branding afterwards without affecting the source.
1397
+ * @default parent
1398
+ * @enum {string}
1399
+ */
1400
+ childOrganizationBranding: "parent" | "provider" | "none";
1341
1401
  /**
1342
1402
  * @description Activation status of the invitation.
1343
1403
  * @enum {string}
@@ -1502,6 +1562,12 @@ export interface operations {
1502
1562
  * @enum {string}
1503
1563
  */
1504
1564
  acceptanceOutcome: "direct_membership" | "child_organization";
1565
+ /**
1566
+ * @description Determines what branding a child organization created by accepting this invitation starts with. Applies only when acceptanceOutcome is child_organization; ignored otherwise. parent (the default, including every invitation that omits this property) copies the inviting organization's branding into the child at creation: theme (logos and colors), authentication-page branding, email branding (sender name, templates, and footer), links (including social profiles), and the authentication-page carousel setting. provider copies the provider organization's branding instead. none gives the child no branding of its own. Every copy is a snapshot: later changes to the source do not propagate, and the child's administrators can change its branding afterwards without affecting the source.
1567
+ * @default parent
1568
+ * @enum {string}
1569
+ */
1570
+ childOrganizationBranding: "parent" | "provider" | "none";
1505
1571
  /**
1506
1572
  * @description Activation status of the invitation.
1507
1573
  * @enum {string}