@meshery/schemas 1.3.22 → 1.3.23
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 +5239 -3023
- package/dist/cloudApi.d.ts +5239 -3023
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta1/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta1/component/ComponentSchema.js +1 -1
- package/dist/constructs/v1beta1/component/ComponentSchema.mjs +1 -1
- package/dist/constructs/v1beta1/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta1/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta1/credential/CredentialSchema.js +8 -8
- package/dist/constructs/v1beta1/credential/CredentialSchema.mjs +8 -8
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +4 -4
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +4 -4
- package/dist/constructs/v1beta1/model/Model.d.ts +586 -2
- package/dist/constructs/v1beta1/model/ModelSchema.js +10 -2
- package/dist/constructs/v1beta1/model/ModelSchema.mjs +10 -2
- package/dist/constructs/v1beta1/pattern/PatternSchema.js +11 -11
- package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +11 -11
- package/dist/constructs/v1beta1/schedule/ScheduleSchema.js +6 -6
- package/dist/constructs/v1beta1/schedule/ScheduleSchema.mjs +6 -6
- package/dist/constructs/v1beta1/system/System.d.ts +112 -0
- package/dist/constructs/v1beta1/system/SystemSchema.js +1 -1
- package/dist/constructs/v1beta1/system/SystemSchema.mjs +1 -1
- package/dist/constructs/v1beta1/team/TeamSchema.js +1 -1
- package/dist/constructs/v1beta1/team/TeamSchema.mjs +1 -1
- package/dist/constructs/v1beta1/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta1/token/TokenSchema.mjs +1 -1
- package/dist/constructs/v1beta1/view/ViewSchema.js +4 -4
- package/dist/constructs/v1beta1/view/ViewSchema.mjs +4 -4
- package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +4 -4
- package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +4 -4
- package/dist/constructs/v1beta2/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta2/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta2/component/ComponentSchema.js +1 -1
- package/dist/constructs/v1beta2/component/ComponentSchema.mjs +1 -1
- package/dist/constructs/v1beta2/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta2/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta2/credential/CredentialSchema.js +6 -6
- package/dist/constructs/v1beta2/credential/CredentialSchema.mjs +6 -6
- package/dist/constructs/v1beta2/design/DesignSchema.js +11 -11
- package/dist/constructs/v1beta2/design/DesignSchema.mjs +11 -11
- package/dist/constructs/v1beta2/model/Model.d.ts +587 -3
- package/dist/constructs/v1beta2/model/ModelSchema.js +10 -2
- package/dist/constructs/v1beta2/model/ModelSchema.mjs +10 -2
- package/dist/constructs/v1beta2/organization/Organization.d.ts +434 -0
- package/dist/constructs/v1beta2/organization/OrganizationSchema.js +1 -1
- package/dist/constructs/v1beta2/organization/OrganizationSchema.mjs +1 -1
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.js +5 -5
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.mjs +5 -5
- package/dist/constructs/v1beta2/team/TeamSchema.js +1 -1
- package/dist/constructs/v1beta2/team/TeamSchema.mjs +1 -1
- package/dist/constructs/v1beta2/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta2/token/TokenSchema.mjs +1 -1
- package/dist/constructs/v1beta2/user/User.d.ts +695 -0
- package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
- package/dist/constructs/v1beta2/view/ViewSchema.js +4 -4
- package/dist/constructs/v1beta2/view/ViewSchema.mjs +4 -4
- package/dist/constructs/v1beta3/component/ComponentSchema.js +1 -1
- package/dist/constructs/v1beta3/component/ComponentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/connection/Connection.d.ts +173 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/design/Design.d.ts +3569 -2245
- package/dist/constructs/v1beta3/design/DesignSchema.js +56 -12
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +56 -12
- package/dist/constructs/v1beta3/environment/Environment.d.ts +42 -0
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +188 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/pattern_resource/PatternResource.d.ts +701 -0
- package/dist/constructs/v1beta3/pattern_resource/PatternResource.js +1 -0
- package/dist/constructs/v1beta3/pattern_resource/PatternResource.mjs +0 -0
- package/dist/constructs/v1beta3/pattern_resource/PatternResourceSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/pattern_resource/PatternResourceSchema.js +78 -0
- package/dist/constructs/v1beta3/pattern_resource/PatternResourceSchema.mjs +78 -0
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +4 -4
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +4 -4
- package/dist/index.d.mts +573 -1
- package/dist/index.d.ts +573 -1
- package/dist/index.js +41 -33
- package/dist/index.mjs +41 -33
- package/dist/mesheryApi.d.mts +905 -734
- package/dist/mesheryApi.d.ts +905 -734
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
|
File without changes
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"PatternResource",description:`OpenAPI schema for Meshery pattern resources \u2014 the
|
|
2
|
+
Kubernetes-addressable identities (name, namespace, type, OAM type)
|
|
3
|
+
of resources provisioned from designs. Persisted by meshery-cloud in
|
|
4
|
+
the \`meshery_pattern_resources\` table and consumed by the meshery
|
|
5
|
+
server's design engine through the remote provider.
|
|
6
|
+
|
|
7
|
+
These endpoints previously lived (schema-less) in the design
|
|
8
|
+
construct's api.yml; they are owned by this construct now so the
|
|
9
|
+
entity, page envelope, and payload are defined alongside the
|
|
10
|
+
operations that serve them, mirroring the filter construct's layout.
|
|
11
|
+
`,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:"patternResources",description:"Operations related to Meshery pattern resources."}],paths:{"/api/content/patterns/resource":{get:{"x-internal":["cloud"],tags:["patternResources"],summary:"Get pattern resources",operationId:"getPatternResources",description:`Returns a paginated list of pattern resources owned by the
|
|
12
|
+
authenticated user, optionally filtered by resource identity
|
|
13
|
+
fields and organization or workspace scope.
|
|
14
|
+
`,parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{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 kept for
|
|
15
|
+
the meshery server's remote provider, which still sends the
|
|
16
|
+
lowercase form; canonical \`pageSize\` wins when both are present.
|
|
17
|
+
`,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:"name",in:"query",required:false,description:"Filter by resource name.",schema:{type:"string"}},{name:"namespace",in:"query",required:false,description:"Filter by Kubernetes namespace.",schema:{type:"string"}},{name:"type",in:"query",required:false,description:"Filter by resource type discriminator.",schema:{type:"string"}},{name:"oamType",in:"query",required:false,description:"Filter by OAM categorization (e.g. workload, trait, scope).",schema:{type:"string"}},{name:"orgId",in:"query",required:false,description:"Scope results to an organization.",schema:{type:"string",format:"uuid"}},{name:"workspaceId",in:"query",required:false,description:"Scope results to a workspace.",schema:{type:"string",format:"uuid"}}],responses:{200:{description:"Pattern resources page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of pattern resources.",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},resources:{type:"array",items:{"x-go-type":"MesheryPatternResource",$schema:"http://json-schema.org/draft-07/schema#",title:"Pattern Resource Schema",description:`Server-returned Meshery pattern resource as persisted by meshery-cloud
|
|
18
|
+
(\`meshery_pattern_resources\` table). A pattern resource records the
|
|
19
|
+
Kubernetes-addressable identity (name, namespace, type, OAM type) of a
|
|
20
|
+
resource provisioned from a design, and is used by the design engine to
|
|
21
|
+
deduplicate provisioned resources. This v1beta3 shape supersedes the
|
|
22
|
+
legacy v1alpha2 snake_case wire form and corrects its \`Namepace\` typo
|
|
23
|
+
to \`namespace\`.
|
|
24
|
+
`,type:"object",additionalProperties:false,required:["id","userId","name","namespace","type","oamType","deleted","createdAt","updatedAt"],properties:{id:{description:"Server-generated pattern resource ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"Owning user ID. Persisted in the `owner` column of the\n`meshery_pattern_resources` table (confirmed against the\nproduction schema dump); the wire identifier stays camelCase\n`userId` per the identifier-naming contract.\n","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255,"x-order":3},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into. Corrects\nthe legacy v1alpha2 `Namepace` typo.\n",minLength:1,maxLength:255,"x-order":4},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255,"x-order":5},oamType:{type:"string",description:"OAM (Open Application Model) categorization of the resource,\nstored in the `oam_type` column (e.g. `workload`, `trait`,\n`scope`).\n",minLength:1,maxLength:255,"x-go-name":"OAMType","x-oapi-codegen-extra-tags":{db:"oam_type"},"x-order":6},deleted:{type:"boolean",description:`Soft-delete marker. Server-managed; rows are flagged rather than
|
|
25
|
+
removed so the design engine can reconcile prior provisions.
|
|
26
|
+
`,default:false,"x-order":7},createdAt:{description:"Timestamp of pattern resource creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last pattern resource modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},description:"Pattern resources included on this page of results."}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},post:{"x-internal":["cloud"],tags:["patternResources"],summary:"Save pattern resource",operationId:"upsertPatternResource",description:"Creates a new pattern resource when no `id` is supplied, or\nupdates the entry matching the provided `id`. Ownership is\nderived from the authenticated session; any client-supplied\nowner is ignored.\n",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a pattern resource via\n`POST /api/content/patterns/resource`. Contains only\nclient-settable fields; the owning `userId` (derived from the\nauthenticated session), the `deleted` marker, and the\nserver-generated `createdAt` / `updatedAt` timestamps are\nintentionally excluded.\n",required:["name","namespace","type","oamType"],properties:{id:{description:"Existing pattern resource ID for updates; omit on create.","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"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into.",minLength:1,maxLength:255},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255},oamType:{type:"string",description:"OAM categorization of the resource (e.g. workload, trait, scope).",minLength:1,maxLength:255,"x-go-name":"OAMType"}}}}}},responses:{200:{description:"Pattern resource saved",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Pattern Resource Schema",description:`Server-returned Meshery pattern resource as persisted by meshery-cloud
|
|
27
|
+
(\`meshery_pattern_resources\` table). A pattern resource records the
|
|
28
|
+
Kubernetes-addressable identity (name, namespace, type, OAM type) of a
|
|
29
|
+
resource provisioned from a design, and is used by the design engine to
|
|
30
|
+
deduplicate provisioned resources. This v1beta3 shape supersedes the
|
|
31
|
+
legacy v1alpha2 snake_case wire form and corrects its \`Namepace\` typo
|
|
32
|
+
to \`namespace\`.
|
|
33
|
+
`,type:"object",additionalProperties:false,required:["id","userId","name","namespace","type","oamType","deleted","createdAt","updatedAt"],properties:{id:{description:"Server-generated pattern resource ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"Owning user ID. Persisted in the `owner` column of the\n`meshery_pattern_resources` table (confirmed against the\nproduction schema dump); the wire identifier stays camelCase\n`userId` per the identifier-naming contract.\n","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255,"x-order":3},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into. Corrects\nthe legacy v1alpha2 `Namepace` typo.\n",minLength:1,maxLength:255,"x-order":4},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255,"x-order":5},oamType:{type:"string",description:"OAM (Open Application Model) categorization of the resource,\nstored in the `oam_type` column (e.g. `workload`, `trait`,\n`scope`).\n",minLength:1,maxLength:255,"x-go-name":"OAMType","x-oapi-codegen-extra-tags":{db:"oam_type"},"x-order":6},deleted:{type:"boolean",description:`Soft-delete marker. Server-managed; rows are flagged rather than
|
|
34
|
+
removed so the design engine can reconcile prior provisions.
|
|
35
|
+
`,default:false,"x-order":7},createdAt:{description:"Timestamp of pattern resource creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last pattern resource modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/content/patterns/resource/{patternResourceId}":{get:{"x-internal":["cloud"],tags:["patternResources"],summary:"Get pattern resource by ID",operationId:"getPatternResource",parameters:[{name:"patternResourceId",in:"path",description:"Pattern resource 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:"Pattern resource response",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Pattern Resource Schema",description:`Server-returned Meshery pattern resource as persisted by meshery-cloud
|
|
36
|
+
(\`meshery_pattern_resources\` table). A pattern resource records the
|
|
37
|
+
Kubernetes-addressable identity (name, namespace, type, OAM type) of a
|
|
38
|
+
resource provisioned from a design, and is used by the design engine to
|
|
39
|
+
deduplicate provisioned resources. This v1beta3 shape supersedes the
|
|
40
|
+
legacy v1alpha2 snake_case wire form and corrects its \`Namepace\` typo
|
|
41
|
+
to \`namespace\`.
|
|
42
|
+
`,type:"object",additionalProperties:false,required:["id","userId","name","namespace","type","oamType","deleted","createdAt","updatedAt"],properties:{id:{description:"Server-generated pattern resource ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"Owning user ID. Persisted in the `owner` column of the\n`meshery_pattern_resources` table (confirmed against the\nproduction schema dump); the wire identifier stays camelCase\n`userId` per the identifier-naming contract.\n","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255,"x-order":3},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into. Corrects\nthe legacy v1alpha2 `Namepace` typo.\n",minLength:1,maxLength:255,"x-order":4},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255,"x-order":5},oamType:{type:"string",description:"OAM (Open Application Model) categorization of the resource,\nstored in the `oam_type` column (e.g. `workload`, `trait`,\n`scope`).\n",minLength:1,maxLength:255,"x-go-name":"OAMType","x-oapi-codegen-extra-tags":{db:"oam_type"},"x-order":6},deleted:{type:"boolean",description:`Soft-delete marker. Server-managed; rows are flagged rather than
|
|
43
|
+
removed so the design engine can reconcile prior provisions.
|
|
44
|
+
`,default:false,"x-order":7},createdAt:{description:"Timestamp of pattern resource creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last pattern resource modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},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"}}}}}},delete:{"x-internal":["cloud"],tags:["patternResources"],summary:"Delete pattern resource",operationId:"deletePatternResource",description:`Soft-deletes the pattern resource and returns the deleted
|
|
45
|
+
entity. The live meshery-cloud handler responds 200 with the
|
|
46
|
+
deleted resource body (not 204), so the deleted record's
|
|
47
|
+
identity remains available to the caller.
|
|
48
|
+
`,parameters:[{name:"patternResourceId",in:"path",description:"Pattern resource 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:"Deleted pattern resource",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Pattern Resource Schema",description:`Server-returned Meshery pattern resource as persisted by meshery-cloud
|
|
49
|
+
(\`meshery_pattern_resources\` table). A pattern resource records the
|
|
50
|
+
Kubernetes-addressable identity (name, namespace, type, OAM type) of a
|
|
51
|
+
resource provisioned from a design, and is used by the design engine to
|
|
52
|
+
deduplicate provisioned resources. This v1beta3 shape supersedes the
|
|
53
|
+
legacy v1alpha2 snake_case wire form and corrects its \`Namepace\` typo
|
|
54
|
+
to \`namespace\`.
|
|
55
|
+
`,type:"object",additionalProperties:false,required:["id","userId","name","namespace","type","oamType","deleted","createdAt","updatedAt"],properties:{id:{description:"Server-generated pattern resource ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"Owning user ID. Persisted in the `owner` column of the\n`meshery_pattern_resources` table (confirmed against the\nproduction schema dump); the wire identifier stays camelCase\n`userId` per the identifier-naming contract.\n","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255,"x-order":3},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into. Corrects\nthe legacy v1alpha2 `Namepace` typo.\n",minLength:1,maxLength:255,"x-order":4},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255,"x-order":5},oamType:{type:"string",description:"OAM (Open Application Model) categorization of the resource,\nstored in the `oam_type` column (e.g. `workload`, `trait`,\n`scope`).\n",minLength:1,maxLength:255,"x-go-name":"OAMType","x-oapi-codegen-extra-tags":{db:"oam_type"},"x-order":6},deleted:{type:"boolean",description:`Soft-delete marker. Server-managed; rows are flagged rather than
|
|
56
|
+
removed so the design engine can reconcile prior provisions.
|
|
57
|
+
`,default:false,"x-order":7},createdAt:{description:"Timestamp of pattern resource creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last pattern resource modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},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"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{patternResourceId:{name:"patternResourceId",in:"path",description:"Pattern resource 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:"string"}},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 kept for
|
|
58
|
+
the meshery server's remote provider, which still sends the
|
|
59
|
+
lowercase form; canonical \`pageSize\` wins when both are present.
|
|
60
|
+
`,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:{MesheryPatternResource:{$schema:"http://json-schema.org/draft-07/schema#",title:"Pattern Resource Schema",description:`Server-returned Meshery pattern resource as persisted by meshery-cloud
|
|
61
|
+
(\`meshery_pattern_resources\` table). A pattern resource records the
|
|
62
|
+
Kubernetes-addressable identity (name, namespace, type, OAM type) of a
|
|
63
|
+
resource provisioned from a design, and is used by the design engine to
|
|
64
|
+
deduplicate provisioned resources. This v1beta3 shape supersedes the
|
|
65
|
+
legacy v1alpha2 snake_case wire form and corrects its \`Namepace\` typo
|
|
66
|
+
to \`namespace\`.
|
|
67
|
+
`,type:"object",additionalProperties:false,required:["id","userId","name","namespace","type","oamType","deleted","createdAt","updatedAt"],properties:{id:{description:"Server-generated pattern resource ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"Owning user ID. Persisted in the `owner` column of the\n`meshery_pattern_resources` table (confirmed against the\nproduction schema dump); the wire identifier stays camelCase\n`userId` per the identifier-naming contract.\n","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255,"x-order":3},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into. Corrects\nthe legacy v1alpha2 `Namepace` typo.\n",minLength:1,maxLength:255,"x-order":4},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255,"x-order":5},oamType:{type:"string",description:"OAM (Open Application Model) categorization of the resource,\nstored in the `oam_type` column (e.g. `workload`, `trait`,\n`scope`).\n",minLength:1,maxLength:255,"x-go-name":"OAMType","x-oapi-codegen-extra-tags":{db:"oam_type"},"x-order":6},deleted:{type:"boolean",description:`Soft-delete marker. Server-managed; rows are flagged rather than
|
|
68
|
+
removed so the design engine can reconcile prior provisions.
|
|
69
|
+
`,default:false,"x-order":7},createdAt:{description:"Timestamp of pattern resource creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last pattern resource modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},MesheryPatternResourcePayload:{type:"object",description:"Payload for creating or updating a pattern resource via\n`POST /api/content/patterns/resource`. Contains only\nclient-settable fields; the owning `userId` (derived from the\nauthenticated session), the `deleted` marker, and the\nserver-generated `createdAt` / `updatedAt` timestamps are\nintentionally excluded.\n",required:["name","namespace","type","oamType"],properties:{id:{description:"Existing pattern resource ID for updates; omit on create.","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"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into.",minLength:1,maxLength:255},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255},oamType:{type:"string",description:"OAM categorization of the resource (e.g. workload, trait, scope).",minLength:1,maxLength:255,"x-go-name":"OAMType"}}},MesheryPatternResourcePage:{type:"object",description:"Paginated collection of pattern resources.",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},resources:{type:"array",items:{"x-go-type":"MesheryPatternResource",$schema:"http://json-schema.org/draft-07/schema#",title:"Pattern Resource Schema",description:`Server-returned Meshery pattern resource as persisted by meshery-cloud
|
|
70
|
+
(\`meshery_pattern_resources\` table). A pattern resource records the
|
|
71
|
+
Kubernetes-addressable identity (name, namespace, type, OAM type) of a
|
|
72
|
+
resource provisioned from a design, and is used by the design engine to
|
|
73
|
+
deduplicate provisioned resources. This v1beta3 shape supersedes the
|
|
74
|
+
legacy v1alpha2 snake_case wire form and corrects its \`Namepace\` typo
|
|
75
|
+
to \`namespace\`.
|
|
76
|
+
`,type:"object",additionalProperties:false,required:["id","userId","name","namespace","type","oamType","deleted","createdAt","updatedAt"],properties:{id:{description:"Server-generated pattern resource ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"Owning user ID. Persisted in the `owner` column of the\n`meshery_pattern_resources` table (confirmed against the\nproduction schema dump); the wire identifier stays camelCase\n`userId` per the identifier-naming contract.\n","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255,"x-order":3},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into. Corrects\nthe legacy v1alpha2 `Namepace` typo.\n",minLength:1,maxLength:255,"x-order":4},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255,"x-order":5},oamType:{type:"string",description:"OAM (Open Application Model) categorization of the resource,\nstored in the `oam_type` column (e.g. `workload`, `trait`,\n`scope`).\n",minLength:1,maxLength:255,"x-go-name":"OAMType","x-oapi-codegen-extra-tags":{db:"oam_type"},"x-order":6},deleted:{type:"boolean",description:`Soft-delete marker. Server-managed; rows are flagged rather than
|
|
77
|
+
removed so the design engine can reconcile prior provisions.
|
|
78
|
+
`,default:false,"x-order":7},createdAt:{description:"Timestamp of pattern resource creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last pattern resource modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},description:"Pattern resources included on this page of results."}}}}}},t=e;module.exports=t;
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"PatternResource",description:`OpenAPI schema for Meshery pattern resources \u2014 the
|
|
2
|
+
Kubernetes-addressable identities (name, namespace, type, OAM type)
|
|
3
|
+
of resources provisioned from designs. Persisted by meshery-cloud in
|
|
4
|
+
the \`meshery_pattern_resources\` table and consumed by the meshery
|
|
5
|
+
server's design engine through the remote provider.
|
|
6
|
+
|
|
7
|
+
These endpoints previously lived (schema-less) in the design
|
|
8
|
+
construct's api.yml; they are owned by this construct now so the
|
|
9
|
+
entity, page envelope, and payload are defined alongside the
|
|
10
|
+
operations that serve them, mirroring the filter construct's layout.
|
|
11
|
+
`,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:"patternResources",description:"Operations related to Meshery pattern resources."}],paths:{"/api/content/patterns/resource":{get:{"x-internal":["cloud"],tags:["patternResources"],summary:"Get pattern resources",operationId:"getPatternResources",description:`Returns a paginated list of pattern resources owned by the
|
|
12
|
+
authenticated user, optionally filtered by resource identity
|
|
13
|
+
fields and organization or workspace scope.
|
|
14
|
+
`,parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{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 kept for
|
|
15
|
+
the meshery server's remote provider, which still sends the
|
|
16
|
+
lowercase form; canonical \`pageSize\` wins when both are present.
|
|
17
|
+
`,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:"name",in:"query",required:false,description:"Filter by resource name.",schema:{type:"string"}},{name:"namespace",in:"query",required:false,description:"Filter by Kubernetes namespace.",schema:{type:"string"}},{name:"type",in:"query",required:false,description:"Filter by resource type discriminator.",schema:{type:"string"}},{name:"oamType",in:"query",required:false,description:"Filter by OAM categorization (e.g. workload, trait, scope).",schema:{type:"string"}},{name:"orgId",in:"query",required:false,description:"Scope results to an organization.",schema:{type:"string",format:"uuid"}},{name:"workspaceId",in:"query",required:false,description:"Scope results to a workspace.",schema:{type:"string",format:"uuid"}}],responses:{200:{description:"Pattern resources page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of pattern resources.",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},resources:{type:"array",items:{"x-go-type":"MesheryPatternResource",$schema:"http://json-schema.org/draft-07/schema#",title:"Pattern Resource Schema",description:`Server-returned Meshery pattern resource as persisted by meshery-cloud
|
|
18
|
+
(\`meshery_pattern_resources\` table). A pattern resource records the
|
|
19
|
+
Kubernetes-addressable identity (name, namespace, type, OAM type) of a
|
|
20
|
+
resource provisioned from a design, and is used by the design engine to
|
|
21
|
+
deduplicate provisioned resources. This v1beta3 shape supersedes the
|
|
22
|
+
legacy v1alpha2 snake_case wire form and corrects its \`Namepace\` typo
|
|
23
|
+
to \`namespace\`.
|
|
24
|
+
`,type:"object",additionalProperties:false,required:["id","userId","name","namespace","type","oamType","deleted","createdAt","updatedAt"],properties:{id:{description:"Server-generated pattern resource ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"Owning user ID. Persisted in the `owner` column of the\n`meshery_pattern_resources` table (confirmed against the\nproduction schema dump); the wire identifier stays camelCase\n`userId` per the identifier-naming contract.\n","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255,"x-order":3},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into. Corrects\nthe legacy v1alpha2 `Namepace` typo.\n",minLength:1,maxLength:255,"x-order":4},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255,"x-order":5},oamType:{type:"string",description:"OAM (Open Application Model) categorization of the resource,\nstored in the `oam_type` column (e.g. `workload`, `trait`,\n`scope`).\n",minLength:1,maxLength:255,"x-go-name":"OAMType","x-oapi-codegen-extra-tags":{db:"oam_type"},"x-order":6},deleted:{type:"boolean",description:`Soft-delete marker. Server-managed; rows are flagged rather than
|
|
25
|
+
removed so the design engine can reconcile prior provisions.
|
|
26
|
+
`,default:false,"x-order":7},createdAt:{description:"Timestamp of pattern resource creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last pattern resource modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},description:"Pattern resources included on this page of results."}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},post:{"x-internal":["cloud"],tags:["patternResources"],summary:"Save pattern resource",operationId:"upsertPatternResource",description:"Creates a new pattern resource when no `id` is supplied, or\nupdates the entry matching the provided `id`. Ownership is\nderived from the authenticated session; any client-supplied\nowner is ignored.\n",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a pattern resource via\n`POST /api/content/patterns/resource`. Contains only\nclient-settable fields; the owning `userId` (derived from the\nauthenticated session), the `deleted` marker, and the\nserver-generated `createdAt` / `updatedAt` timestamps are\nintentionally excluded.\n",required:["name","namespace","type","oamType"],properties:{id:{description:"Existing pattern resource ID for updates; omit on create.","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"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into.",minLength:1,maxLength:255},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255},oamType:{type:"string",description:"OAM categorization of the resource (e.g. workload, trait, scope).",minLength:1,maxLength:255,"x-go-name":"OAMType"}}}}}},responses:{200:{description:"Pattern resource saved",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Pattern Resource Schema",description:`Server-returned Meshery pattern resource as persisted by meshery-cloud
|
|
27
|
+
(\`meshery_pattern_resources\` table). A pattern resource records the
|
|
28
|
+
Kubernetes-addressable identity (name, namespace, type, OAM type) of a
|
|
29
|
+
resource provisioned from a design, and is used by the design engine to
|
|
30
|
+
deduplicate provisioned resources. This v1beta3 shape supersedes the
|
|
31
|
+
legacy v1alpha2 snake_case wire form and corrects its \`Namepace\` typo
|
|
32
|
+
to \`namespace\`.
|
|
33
|
+
`,type:"object",additionalProperties:false,required:["id","userId","name","namespace","type","oamType","deleted","createdAt","updatedAt"],properties:{id:{description:"Server-generated pattern resource ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"Owning user ID. Persisted in the `owner` column of the\n`meshery_pattern_resources` table (confirmed against the\nproduction schema dump); the wire identifier stays camelCase\n`userId` per the identifier-naming contract.\n","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255,"x-order":3},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into. Corrects\nthe legacy v1alpha2 `Namepace` typo.\n",minLength:1,maxLength:255,"x-order":4},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255,"x-order":5},oamType:{type:"string",description:"OAM (Open Application Model) categorization of the resource,\nstored in the `oam_type` column (e.g. `workload`, `trait`,\n`scope`).\n",minLength:1,maxLength:255,"x-go-name":"OAMType","x-oapi-codegen-extra-tags":{db:"oam_type"},"x-order":6},deleted:{type:"boolean",description:`Soft-delete marker. Server-managed; rows are flagged rather than
|
|
34
|
+
removed so the design engine can reconcile prior provisions.
|
|
35
|
+
`,default:false,"x-order":7},createdAt:{description:"Timestamp of pattern resource creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last pattern resource modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/content/patterns/resource/{patternResourceId}":{get:{"x-internal":["cloud"],tags:["patternResources"],summary:"Get pattern resource by ID",operationId:"getPatternResource",parameters:[{name:"patternResourceId",in:"path",description:"Pattern resource 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:"Pattern resource response",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Pattern Resource Schema",description:`Server-returned Meshery pattern resource as persisted by meshery-cloud
|
|
36
|
+
(\`meshery_pattern_resources\` table). A pattern resource records the
|
|
37
|
+
Kubernetes-addressable identity (name, namespace, type, OAM type) of a
|
|
38
|
+
resource provisioned from a design, and is used by the design engine to
|
|
39
|
+
deduplicate provisioned resources. This v1beta3 shape supersedes the
|
|
40
|
+
legacy v1alpha2 snake_case wire form and corrects its \`Namepace\` typo
|
|
41
|
+
to \`namespace\`.
|
|
42
|
+
`,type:"object",additionalProperties:false,required:["id","userId","name","namespace","type","oamType","deleted","createdAt","updatedAt"],properties:{id:{description:"Server-generated pattern resource ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"Owning user ID. Persisted in the `owner` column of the\n`meshery_pattern_resources` table (confirmed against the\nproduction schema dump); the wire identifier stays camelCase\n`userId` per the identifier-naming contract.\n","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255,"x-order":3},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into. Corrects\nthe legacy v1alpha2 `Namepace` typo.\n",minLength:1,maxLength:255,"x-order":4},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255,"x-order":5},oamType:{type:"string",description:"OAM (Open Application Model) categorization of the resource,\nstored in the `oam_type` column (e.g. `workload`, `trait`,\n`scope`).\n",minLength:1,maxLength:255,"x-go-name":"OAMType","x-oapi-codegen-extra-tags":{db:"oam_type"},"x-order":6},deleted:{type:"boolean",description:`Soft-delete marker. Server-managed; rows are flagged rather than
|
|
43
|
+
removed so the design engine can reconcile prior provisions.
|
|
44
|
+
`,default:false,"x-order":7},createdAt:{description:"Timestamp of pattern resource creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last pattern resource modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},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"}}}}}},delete:{"x-internal":["cloud"],tags:["patternResources"],summary:"Delete pattern resource",operationId:"deletePatternResource",description:`Soft-deletes the pattern resource and returns the deleted
|
|
45
|
+
entity. The live meshery-cloud handler responds 200 with the
|
|
46
|
+
deleted resource body (not 204), so the deleted record's
|
|
47
|
+
identity remains available to the caller.
|
|
48
|
+
`,parameters:[{name:"patternResourceId",in:"path",description:"Pattern resource 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:"Deleted pattern resource",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Pattern Resource Schema",description:`Server-returned Meshery pattern resource as persisted by meshery-cloud
|
|
49
|
+
(\`meshery_pattern_resources\` table). A pattern resource records the
|
|
50
|
+
Kubernetes-addressable identity (name, namespace, type, OAM type) of a
|
|
51
|
+
resource provisioned from a design, and is used by the design engine to
|
|
52
|
+
deduplicate provisioned resources. This v1beta3 shape supersedes the
|
|
53
|
+
legacy v1alpha2 snake_case wire form and corrects its \`Namepace\` typo
|
|
54
|
+
to \`namespace\`.
|
|
55
|
+
`,type:"object",additionalProperties:false,required:["id","userId","name","namespace","type","oamType","deleted","createdAt","updatedAt"],properties:{id:{description:"Server-generated pattern resource ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"Owning user ID. Persisted in the `owner` column of the\n`meshery_pattern_resources` table (confirmed against the\nproduction schema dump); the wire identifier stays camelCase\n`userId` per the identifier-naming contract.\n","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255,"x-order":3},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into. Corrects\nthe legacy v1alpha2 `Namepace` typo.\n",minLength:1,maxLength:255,"x-order":4},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255,"x-order":5},oamType:{type:"string",description:"OAM (Open Application Model) categorization of the resource,\nstored in the `oam_type` column (e.g. `workload`, `trait`,\n`scope`).\n",minLength:1,maxLength:255,"x-go-name":"OAMType","x-oapi-codegen-extra-tags":{db:"oam_type"},"x-order":6},deleted:{type:"boolean",description:`Soft-delete marker. Server-managed; rows are flagged rather than
|
|
56
|
+
removed so the design engine can reconcile prior provisions.
|
|
57
|
+
`,default:false,"x-order":7},createdAt:{description:"Timestamp of pattern resource creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last pattern resource modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},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"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{patternResourceId:{name:"patternResourceId",in:"path",description:"Pattern resource 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:"string"}},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 kept for
|
|
58
|
+
the meshery server's remote provider, which still sends the
|
|
59
|
+
lowercase form; canonical \`pageSize\` wins when both are present.
|
|
60
|
+
`,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:{MesheryPatternResource:{$schema:"http://json-schema.org/draft-07/schema#",title:"Pattern Resource Schema",description:`Server-returned Meshery pattern resource as persisted by meshery-cloud
|
|
61
|
+
(\`meshery_pattern_resources\` table). A pattern resource records the
|
|
62
|
+
Kubernetes-addressable identity (name, namespace, type, OAM type) of a
|
|
63
|
+
resource provisioned from a design, and is used by the design engine to
|
|
64
|
+
deduplicate provisioned resources. This v1beta3 shape supersedes the
|
|
65
|
+
legacy v1alpha2 snake_case wire form and corrects its \`Namepace\` typo
|
|
66
|
+
to \`namespace\`.
|
|
67
|
+
`,type:"object",additionalProperties:false,required:["id","userId","name","namespace","type","oamType","deleted","createdAt","updatedAt"],properties:{id:{description:"Server-generated pattern resource ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"Owning user ID. Persisted in the `owner` column of the\n`meshery_pattern_resources` table (confirmed against the\nproduction schema dump); the wire identifier stays camelCase\n`userId` per the identifier-naming contract.\n","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255,"x-order":3},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into. Corrects\nthe legacy v1alpha2 `Namepace` typo.\n",minLength:1,maxLength:255,"x-order":4},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255,"x-order":5},oamType:{type:"string",description:"OAM (Open Application Model) categorization of the resource,\nstored in the `oam_type` column (e.g. `workload`, `trait`,\n`scope`).\n",minLength:1,maxLength:255,"x-go-name":"OAMType","x-oapi-codegen-extra-tags":{db:"oam_type"},"x-order":6},deleted:{type:"boolean",description:`Soft-delete marker. Server-managed; rows are flagged rather than
|
|
68
|
+
removed so the design engine can reconcile prior provisions.
|
|
69
|
+
`,default:false,"x-order":7},createdAt:{description:"Timestamp of pattern resource creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last pattern resource modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},MesheryPatternResourcePayload:{type:"object",description:"Payload for creating or updating a pattern resource via\n`POST /api/content/patterns/resource`. Contains only\nclient-settable fields; the owning `userId` (derived from the\nauthenticated session), the `deleted` marker, and the\nserver-generated `createdAt` / `updatedAt` timestamps are\nintentionally excluded.\n",required:["name","namespace","type","oamType"],properties:{id:{description:"Existing pattern resource ID for updates; omit on create.","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"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into.",minLength:1,maxLength:255},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255},oamType:{type:"string",description:"OAM categorization of the resource (e.g. workload, trait, scope).",minLength:1,maxLength:255,"x-go-name":"OAMType"}}},MesheryPatternResourcePage:{type:"object",description:"Paginated collection of pattern resources.",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},resources:{type:"array",items:{"x-go-type":"MesheryPatternResource",$schema:"http://json-schema.org/draft-07/schema#",title:"Pattern Resource Schema",description:`Server-returned Meshery pattern resource as persisted by meshery-cloud
|
|
70
|
+
(\`meshery_pattern_resources\` table). A pattern resource records the
|
|
71
|
+
Kubernetes-addressable identity (name, namespace, type, OAM type) of a
|
|
72
|
+
resource provisioned from a design, and is used by the design engine to
|
|
73
|
+
deduplicate provisioned resources. This v1beta3 shape supersedes the
|
|
74
|
+
legacy v1alpha2 snake_case wire form and corrects its \`Namepace\` typo
|
|
75
|
+
to \`namespace\`.
|
|
76
|
+
`,type:"object",additionalProperties:false,required:["id","userId","name","namespace","type","oamType","deleted","createdAt","updatedAt"],properties:{id:{description:"Server-generated pattern resource ID.","x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"Owning user ID. Persisted in the `owner` column of the\n`meshery_pattern_resources` table (confirmed against the\nproduction schema dump); the wire identifier stays camelCase\n`userId` per the identifier-naming contract.\n","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the provisioned resource.",minLength:1,maxLength:255,"x-order":3},namespace:{type:"string",description:"Kubernetes namespace the resource was provisioned into. Corrects\nthe legacy v1alpha2 `Namepace` typo.\n",minLength:1,maxLength:255,"x-order":4},type:{type:"string",description:"Resource type discriminator (e.g. the Kubernetes kind).",minLength:1,maxLength:255,"x-order":5},oamType:{type:"string",description:"OAM (Open Application Model) categorization of the resource,\nstored in the `oam_type` column (e.g. `workload`, `trait`,\n`scope`).\n",minLength:1,maxLength:255,"x-go-name":"OAMType","x-oapi-codegen-extra-tags":{db:"oam_type"},"x-order":6},deleted:{type:"boolean",description:`Soft-delete marker. Server-managed; rows are flagged rather than
|
|
77
|
+
removed so the design engine can reconcile prior provisions.
|
|
78
|
+
`,default:false,"x-order":7},createdAt:{description:"Timestamp of pattern resource creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last pattern resource modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},description:"Pattern resources included on this page of results."}}}}}},t=e;export{t as default};
|