@meshery/schemas 1.3.81 → 1.3.83
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +384 -9
- package/dist/cloudApi.d.ts +384 -9
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta2/organization/Organization.d.ts +454 -2
- package/dist/constructs/v1beta2/organization/OrganizationSchema.js +1 -1
- package/dist/constructs/v1beta2/organization/OrganizationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/content_piece/ContentPiece.d.ts +77 -22
- package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.js +27 -7
- package/dist/constructs/v1beta3/content_piece/ContentPieceSchema.mjs +27 -7
- package/dist/index.d.mts +122 -1
- package/dist/index.d.ts +122 -1
- package/dist/mesheryApi.d.mts +364 -1
- package/dist/mesheryApi.d.ts +364 -1
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
var e={openapi:"3.0.0",info:{title:"ContentPiece",description:`OpenAPI schema for content pieces - fingerprinted content
|
|
2
|
-
values keyed by
|
|
2
|
+
values keyed by organization and row number, with conditional
|
|
3
3
|
updates.
|
|
4
4
|
Organization scope: every operation acts only in the organization the
|
|
5
5
|
session resolved to (X-Current-Orgid, then the user's selected
|
|
@@ -16,7 +16,11 @@ organization's rows is never disclosed.
|
|
|
16
16
|
Content pieces carry a row number and a server-computed fingerprint over
|
|
17
17
|
their canonical values; updates are conditional on the fingerprint the
|
|
18
18
|
writer read, so stale writes are refused rather than silently applied.
|
|
19
|
-
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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
|
|
19
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 piece, unique across the live content pieces 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 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"}}}},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:["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. Row numbers are unique across\nthe live content pieces 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\npieces so a deleted piece'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 piece is assigned row number 0 first. A supplied\n`rowNumber` that another live content piece 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 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"],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 piece, unique across the live content
|
|
20
|
+
pieces 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,
|
|
20
24
|
the update applies only when the stored fingerprint still
|
|
21
25
|
matches, and is refused with a 409 otherwise. Ignored on
|
|
22
26
|
insert.
|
|
@@ -24,11 +28,15 @@ insert.
|
|
|
24
28
|
Content pieces carry a row number and a server-computed fingerprint over
|
|
25
29
|
their canonical values; updates are conditional on the fingerprint the
|
|
26
30
|
writer read, so stale writes are refused rather than silently applied.
|
|
27
|
-
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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
|
|
31
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 piece, unique across the live content pieces 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 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"}}}},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 piece 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/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.
|
|
28
32
|
Content pieces carry a row number and a server-computed fingerprint over
|
|
29
33
|
their canonical values; updates are conditional on the fingerprint the
|
|
30
34
|
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 piece 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
|
|
35
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 piece, unique across the live content pieces 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 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"}}}},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:["contentPieces"],summary:"Update a content piece",operationId:"updateContentPiece",description:"Conditionally updates the content piece. When\n`expectedFingerprint` is supplied and stale, the update is\nrefused with a 409, as is an update that would move the piece\nonto a `rowNumber` another live content piece of the organization\nholds. An omitted `rowNumber` keeps the stored one.\n",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"],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 piece, unique across the live content
|
|
36
|
+
pieces 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,
|
|
32
40
|
the update applies only when the stored fingerprint still
|
|
33
41
|
matches, and is refused with a 409 otherwise. Ignored on
|
|
34
42
|
insert.
|
|
@@ -36,11 +44,23 @@ insert.
|
|
|
36
44
|
Content pieces carry a row number and a server-computed fingerprint over
|
|
37
45
|
their canonical values; updates are conditional on the fingerprint the
|
|
38
46
|
writer read, so stale writes are refused rather than silently applied.
|
|
39
|
-
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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
|
|
47
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 piece, unique across the live content pieces 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 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"}}}},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 piece 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:["contentPieces"],summary:"Delete a content piece",operationId:"deleteContentPiece",description:`Soft-deletes the content piece. 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:"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"}}},{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 piece 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 piece 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 piece 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}},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.
|
|
40
56
|
Content pieces carry a row number and a server-computed fingerprint over
|
|
41
57
|
their canonical values; updates are conditional on the fingerprint the
|
|
42
58
|
writer read, so stale writes are refused rather than silently applied.
|
|
43
|
-
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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
|
|
59
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 piece, unique across the live content pieces 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 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"],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 piece, unique across the live content
|
|
60
|
+
pieces 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,
|
|
44
64
|
the update applies only when the stored fingerprint still
|
|
45
65
|
matches, and is refused with a 409 otherwise. Ignored on
|
|
46
66
|
insert.
|
|
@@ -48,4 +68,4 @@ insert.
|
|
|
48
68
|
Content pieces carry a row number and a server-computed fingerprint over
|
|
49
69
|
their canonical values; updates are conditional on the fingerprint the
|
|
50
70
|
writer read, so stale writes are refused rather than silently applied.
|
|
51
|
-
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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
|
|
71
|
+
`,type:"object",additionalProperties:false,required:["id","organizationId","profile","rowNumber","fingerprint","createdAt","updatedAt"],properties:{id:{description:"Server-generated content piece 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 piece, unique across the live content pieces 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 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};
|
package/dist/index.d.mts
CHANGED
|
@@ -32270,6 +32270,122 @@ interface components$6 {
|
|
|
32270
32270
|
reason?: string;
|
|
32271
32271
|
};
|
|
32272
32272
|
};
|
|
32273
|
+
/** @description Partial update of organization preferences (patchOrgPreferences). Every member is optional: a present member replaces that member of the stored preferences as a whole, and an omitted member stays unchanged. Members are those of PreferencesPayload, with the same schemas, and may not be null. */
|
|
32274
|
+
PreferencesPatchPayload: {
|
|
32275
|
+
/** @description UI theme configured for an organization. */
|
|
32276
|
+
theme?: {
|
|
32277
|
+
/**
|
|
32278
|
+
* Format: uuid
|
|
32279
|
+
* @description Theme identifier.
|
|
32280
|
+
*/
|
|
32281
|
+
id: string;
|
|
32282
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
32283
|
+
logo: {
|
|
32284
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32285
|
+
desktopView: {
|
|
32286
|
+
/** @description SVG markup for the asset. */
|
|
32287
|
+
svg: string;
|
|
32288
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32289
|
+
location: string;
|
|
32290
|
+
};
|
|
32291
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32292
|
+
mobileView: {
|
|
32293
|
+
/** @description SVG markup for the asset. */
|
|
32294
|
+
svg: string;
|
|
32295
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32296
|
+
location: string;
|
|
32297
|
+
};
|
|
32298
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32299
|
+
darkDesktopView: {
|
|
32300
|
+
/** @description SVG markup for the asset. */
|
|
32301
|
+
svg: string;
|
|
32302
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32303
|
+
location: string;
|
|
32304
|
+
};
|
|
32305
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32306
|
+
darkMobileView: {
|
|
32307
|
+
/** @description SVG markup for the asset. */
|
|
32308
|
+
svg: string;
|
|
32309
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32310
|
+
location: string;
|
|
32311
|
+
};
|
|
32312
|
+
};
|
|
32313
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
32314
|
+
vars?: {
|
|
32315
|
+
[key: string]: unknown;
|
|
32316
|
+
};
|
|
32317
|
+
};
|
|
32318
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
32319
|
+
dashboard?: {
|
|
32320
|
+
[key: string]: unknown;
|
|
32321
|
+
};
|
|
32322
|
+
/** @description Optional per-organization branding overrides for the auth pages: carousel slides and FAQ entries. Stored as JSON inside organization.metadata.preferences, so no dedicated column backs it. Empty or omitted fields fall back to the platform defaults. */
|
|
32323
|
+
authBranding?: {
|
|
32324
|
+
/** @description Ordered slides rendered in the auth-page feature carousel. */
|
|
32325
|
+
carousel?: {
|
|
32326
|
+
/**
|
|
32327
|
+
* Format: uri
|
|
32328
|
+
* @description URL of the slide image asset.
|
|
32329
|
+
*/
|
|
32330
|
+
imageUrl: string;
|
|
32331
|
+
/** @description Slide title. */
|
|
32332
|
+
title: string;
|
|
32333
|
+
/** @description Slide description text. */
|
|
32334
|
+
description: string;
|
|
32335
|
+
}[];
|
|
32336
|
+
/** @description FAQ entries rendered on the auth pages. */
|
|
32337
|
+
faqs?: {
|
|
32338
|
+
/** @description The question text. */
|
|
32339
|
+
question: string;
|
|
32340
|
+
/** @description The answer text. */
|
|
32341
|
+
answer: string;
|
|
32342
|
+
}[];
|
|
32343
|
+
};
|
|
32344
|
+
/** @description Per-organization overrides for the legal, support, and social links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links; social carries the organization's brand profiles. Empty or omitted fields fall back to the platform defaults. */
|
|
32345
|
+
links?: {
|
|
32346
|
+
/**
|
|
32347
|
+
* Format: uri
|
|
32348
|
+
* @description URL of the organization's Terms of Service page.
|
|
32349
|
+
*/
|
|
32350
|
+
termsOfService?: string;
|
|
32351
|
+
/**
|
|
32352
|
+
* Format: uri
|
|
32353
|
+
* @description URL of the organization's Privacy Policy page.
|
|
32354
|
+
*/
|
|
32355
|
+
privacy?: string;
|
|
32356
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
32357
|
+
support?: {
|
|
32358
|
+
[key: string]: string;
|
|
32359
|
+
};
|
|
32360
|
+
/** @description The organization's social brand profiles. Deliberately a sibling of support rather than an entry in it: support renders as support contacts on the auth and error pages, where a brand profile does not belong. Each platform is a named, individually validated URL so consumers can render the matching platform icon. Empty or omitted fields fall back to the platform defaults. */
|
|
32361
|
+
social?: {
|
|
32362
|
+
/**
|
|
32363
|
+
* Format: uri
|
|
32364
|
+
* @description URL of the organization's LinkedIn profile.
|
|
32365
|
+
*/
|
|
32366
|
+
linkedin?: string;
|
|
32367
|
+
/**
|
|
32368
|
+
* Format: uri
|
|
32369
|
+
* @description URL of the organization's X (formerly Twitter) profile.
|
|
32370
|
+
*/
|
|
32371
|
+
x?: string;
|
|
32372
|
+
/**
|
|
32373
|
+
* Format: uri
|
|
32374
|
+
* @description URL of the organization's YouTube channel.
|
|
32375
|
+
*/
|
|
32376
|
+
youtube?: string;
|
|
32377
|
+
};
|
|
32378
|
+
};
|
|
32379
|
+
/** @description Whether the feature carousel renders on the organization's auth pages. Omitted keeps the stored value. */
|
|
32380
|
+
showAuthCarousel?: boolean;
|
|
32381
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitted keeps the current pause unchanged; it does not lift the pause. */
|
|
32382
|
+
schedulePause?: {
|
|
32383
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32384
|
+
paused: boolean;
|
|
32385
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32386
|
+
reason?: string;
|
|
32387
|
+
};
|
|
32388
|
+
};
|
|
32273
32389
|
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
32274
32390
|
OrgMetadata: {
|
|
32275
32391
|
/** @description Organization-level user experience preferences. */
|
|
@@ -33452,6 +33568,8 @@ interface components$6 {
|
|
|
33452
33568
|
order: string;
|
|
33453
33569
|
/** @description Get all possible entries */
|
|
33454
33570
|
all: boolean;
|
|
33571
|
+
/** @description Entity tag of the organization's preferences as last read, from the `ETag` header of getOrgPreferences or patchOrgPreferences. When present the write applies only if it still matches; otherwise 412. */
|
|
33572
|
+
ifMatch: string;
|
|
33455
33573
|
};
|
|
33456
33574
|
requestBodies: {
|
|
33457
33575
|
/** @description Body for creating or updating an organization */
|
|
@@ -33591,7 +33709,10 @@ interface components$6 {
|
|
|
33591
33709
|
};
|
|
33592
33710
|
};
|
|
33593
33711
|
};
|
|
33594
|
-
headers:
|
|
33712
|
+
headers: {
|
|
33713
|
+
/** @description Strong entity tag of the organization's stored preferences. It changes whenever the preferences change; send it back as `If-Match` to make a patchOrgPreferences write conditional. */
|
|
33714
|
+
PreferencesETag: string;
|
|
33715
|
+
};
|
|
33595
33716
|
pathItems: never;
|
|
33596
33717
|
}
|
|
33597
33718
|
|
package/dist/index.d.ts
CHANGED
|
@@ -32270,6 +32270,122 @@ interface components$6 {
|
|
|
32270
32270
|
reason?: string;
|
|
32271
32271
|
};
|
|
32272
32272
|
};
|
|
32273
|
+
/** @description Partial update of organization preferences (patchOrgPreferences). Every member is optional: a present member replaces that member of the stored preferences as a whole, and an omitted member stays unchanged. Members are those of PreferencesPayload, with the same schemas, and may not be null. */
|
|
32274
|
+
PreferencesPatchPayload: {
|
|
32275
|
+
/** @description UI theme configured for an organization. */
|
|
32276
|
+
theme?: {
|
|
32277
|
+
/**
|
|
32278
|
+
* Format: uuid
|
|
32279
|
+
* @description Theme identifier.
|
|
32280
|
+
*/
|
|
32281
|
+
id: string;
|
|
32282
|
+
/** @description Themed logo assets used across light and dark, desktop and mobile presentations. */
|
|
32283
|
+
logo: {
|
|
32284
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32285
|
+
desktopView: {
|
|
32286
|
+
/** @description SVG markup for the asset. */
|
|
32287
|
+
svg: string;
|
|
32288
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32289
|
+
location: string;
|
|
32290
|
+
};
|
|
32291
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32292
|
+
mobileView: {
|
|
32293
|
+
/** @description SVG markup for the asset. */
|
|
32294
|
+
svg: string;
|
|
32295
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32296
|
+
location: string;
|
|
32297
|
+
};
|
|
32298
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32299
|
+
darkDesktopView: {
|
|
32300
|
+
/** @description SVG markup for the asset. */
|
|
32301
|
+
svg: string;
|
|
32302
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32303
|
+
location: string;
|
|
32304
|
+
};
|
|
32305
|
+
/** @description Image asset anchored to a named location within an organization theme. */
|
|
32306
|
+
darkMobileView: {
|
|
32307
|
+
/** @description SVG markup for the asset. */
|
|
32308
|
+
svg: string;
|
|
32309
|
+
/** @description Named location of the asset (e.g. header, footer). */
|
|
32310
|
+
location: string;
|
|
32311
|
+
};
|
|
32312
|
+
};
|
|
32313
|
+
/** @description Arbitrary theme variables keyed by name. */
|
|
32314
|
+
vars?: {
|
|
32315
|
+
[key: string]: unknown;
|
|
32316
|
+
};
|
|
32317
|
+
};
|
|
32318
|
+
/** @description Preferences specific to dashboard behavior. */
|
|
32319
|
+
dashboard?: {
|
|
32320
|
+
[key: string]: unknown;
|
|
32321
|
+
};
|
|
32322
|
+
/** @description Optional per-organization branding overrides for the auth pages: carousel slides and FAQ entries. Stored as JSON inside organization.metadata.preferences, so no dedicated column backs it. Empty or omitted fields fall back to the platform defaults. */
|
|
32323
|
+
authBranding?: {
|
|
32324
|
+
/** @description Ordered slides rendered in the auth-page feature carousel. */
|
|
32325
|
+
carousel?: {
|
|
32326
|
+
/**
|
|
32327
|
+
* Format: uri
|
|
32328
|
+
* @description URL of the slide image asset.
|
|
32329
|
+
*/
|
|
32330
|
+
imageUrl: string;
|
|
32331
|
+
/** @description Slide title. */
|
|
32332
|
+
title: string;
|
|
32333
|
+
/** @description Slide description text. */
|
|
32334
|
+
description: string;
|
|
32335
|
+
}[];
|
|
32336
|
+
/** @description FAQ entries rendered on the auth pages. */
|
|
32337
|
+
faqs?: {
|
|
32338
|
+
/** @description The question text. */
|
|
32339
|
+
question: string;
|
|
32340
|
+
/** @description The answer text. */
|
|
32341
|
+
answer: string;
|
|
32342
|
+
}[];
|
|
32343
|
+
};
|
|
32344
|
+
/** @description Per-organization overrides for the legal, support, and social links shown on the auth pages and the error page. termsOfService and privacy are the named legal links; support is an open-ended set of named support contacts/links; social carries the organization's brand profiles. Empty or omitted fields fall back to the platform defaults. */
|
|
32345
|
+
links?: {
|
|
32346
|
+
/**
|
|
32347
|
+
* Format: uri
|
|
32348
|
+
* @description URL of the organization's Terms of Service page.
|
|
32349
|
+
*/
|
|
32350
|
+
termsOfService?: string;
|
|
32351
|
+
/**
|
|
32352
|
+
* Format: uri
|
|
32353
|
+
* @description URL of the organization's Privacy Policy page.
|
|
32354
|
+
*/
|
|
32355
|
+
privacy?: string;
|
|
32356
|
+
/** @description Open-ended set of named support contacts/links rendered on the auth and error pages, keyed by display name with a value that is a URL, a mailto:/tel: link, or free text. For example a "slack" entry pointing at https://slack.meshery.io, a "discussion forum" entry, or a "support desk" entry holding a phone number. */
|
|
32357
|
+
support?: {
|
|
32358
|
+
[key: string]: string;
|
|
32359
|
+
};
|
|
32360
|
+
/** @description The organization's social brand profiles. Deliberately a sibling of support rather than an entry in it: support renders as support contacts on the auth and error pages, where a brand profile does not belong. Each platform is a named, individually validated URL so consumers can render the matching platform icon. Empty or omitted fields fall back to the platform defaults. */
|
|
32361
|
+
social?: {
|
|
32362
|
+
/**
|
|
32363
|
+
* Format: uri
|
|
32364
|
+
* @description URL of the organization's LinkedIn profile.
|
|
32365
|
+
*/
|
|
32366
|
+
linkedin?: string;
|
|
32367
|
+
/**
|
|
32368
|
+
* Format: uri
|
|
32369
|
+
* @description URL of the organization's X (formerly Twitter) profile.
|
|
32370
|
+
*/
|
|
32371
|
+
x?: string;
|
|
32372
|
+
/**
|
|
32373
|
+
* Format: uri
|
|
32374
|
+
* @description URL of the organization's YouTube channel.
|
|
32375
|
+
*/
|
|
32376
|
+
youtube?: string;
|
|
32377
|
+
};
|
|
32378
|
+
};
|
|
32379
|
+
/** @description Whether the feature carousel renders on the organization's auth pages. Omitted keeps the stored value. */
|
|
32380
|
+
showAuthCarousel?: boolean;
|
|
32381
|
+
/** @description Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitted keeps the current pause unchanged; it does not lift the pause. */
|
|
32382
|
+
schedulePause?: {
|
|
32383
|
+
/** @description Whether every schedule in the organization is paused. */
|
|
32384
|
+
paused: boolean;
|
|
32385
|
+
/** @description Reason given for the pause. Cleared when the pause is lifted. */
|
|
32386
|
+
reason?: string;
|
|
32387
|
+
};
|
|
32388
|
+
};
|
|
32273
32389
|
/** @description Free-form metadata associated with an organization, including preferences. */
|
|
32274
32390
|
OrgMetadata: {
|
|
32275
32391
|
/** @description Organization-level user experience preferences. */
|
|
@@ -33452,6 +33568,8 @@ interface components$6 {
|
|
|
33452
33568
|
order: string;
|
|
33453
33569
|
/** @description Get all possible entries */
|
|
33454
33570
|
all: boolean;
|
|
33571
|
+
/** @description Entity tag of the organization's preferences as last read, from the `ETag` header of getOrgPreferences or patchOrgPreferences. When present the write applies only if it still matches; otherwise 412. */
|
|
33572
|
+
ifMatch: string;
|
|
33455
33573
|
};
|
|
33456
33574
|
requestBodies: {
|
|
33457
33575
|
/** @description Body for creating or updating an organization */
|
|
@@ -33591,7 +33709,10 @@ interface components$6 {
|
|
|
33591
33709
|
};
|
|
33592
33710
|
};
|
|
33593
33711
|
};
|
|
33594
|
-
headers:
|
|
33712
|
+
headers: {
|
|
33713
|
+
/** @description Strong entity tag of the organization's stored preferences. It changes whenever the preferences change; send it back as `If-Match` to make a patchOrgPreferences write conditional. */
|
|
33714
|
+
PreferencesETag: string;
|
|
33715
|
+
};
|
|
33595
33716
|
pathItems: never;
|
|
33596
33717
|
}
|
|
33597
33718
|
|