@meshery/schemas 1.3.22 → 1.3.24
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 +5467 -3043
- package/dist/cloudApi.d.ts +5467 -3043
- 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 +919 -51
- 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 +3279 -1916
- 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/user/User.d.ts +527 -0
- package/dist/constructs/v1beta3/user/User.js +1 -0
- package/dist/constructs/v1beta3/user/User.mjs +0 -0
- package/dist/constructs/v1beta3/user/UserSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/user/UserSchema.js +2 -0
- package/dist/constructs/v1beta3/user/UserSchema.mjs +2 -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 +423 -44
- package/dist/mesheryApi.d.ts +423 -44
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
var e={openapi:"3.0.0",info:{title:"credential",description:"Documentation for Meshery Cloud REST APIs for Credentials",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"},version:"v1beta2"},servers:[{url:"https://cloud.meshery.io",description:"Meshery Cloud production server URL"},{url:"https://staging-cloud.meshery.io",description:"Meshery Cloud staging server URL"},{url:"http://localhost:9876",description:"Meshery Cloud development server URL"}],security:[{jwt:[]}],tags:[{name:"credentials",description:"Operations related to integration credentials"}],paths:{"/api/integrations/credentials":{get:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Get credentials",operationId:"getUserCredentials",description:"Retrieves all credentials belonging to the authenticated user.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"string"}},{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"}}],responses:{200:{description:"Credentials response",content:{"application/json":{schema:{type:"object",description:"A paginated list of credentials.",required:["credentials","totalCount","page","pageSize"],properties:{credentials:{type:"array",items:{"x-go-type":"Credential",type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
2
|
-
`,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"
|
|
3
|
-
`,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"
|
|
4
|
-
`,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"
|
|
5
|
-
`,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"
|
|
6
|
-
`,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"
|
|
7
|
-
`,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"
|
|
2
|
+
`,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"owner"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the credential was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was soft-deleted.","x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"}}}},"x-order":1,description:"The credentials returned on the current page."},totalCount:{type:"integer",description:"Total number of credentials across all pages.","x-order":2,minimum:0},page:{type:"integer",description:"Current page number (zero-based).","x-order":3,minimum:0},pageSize:{type:"integer",description:"Number of credentials per page.","x-order":4,minimum:1}}}}}},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","meshery"],tags:["credentials"],summary:"Save credential",operationId:"saveUserCredential",description:"Saves a new credential for the authenticated user.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a credential.",required:["name","type"],properties:{id:{description:"Existing credential ID for updates; omit on create.","x-order":1,"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:"Human-readable name for the credential.","x-order":2,minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true}}}}}},responses:{201:{description:"Credential saved",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
3
|
+
`,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"owner"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the credential was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was soft-deleted.","x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"}}}}}}},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"}}}}}},put:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Update credential",operationId:"updateUserCredential",description:"Updates an existing credential for the authenticated user.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a credential.",required:["name","type"],properties:{id:{description:"Existing credential ID for updates; omit on create.","x-order":1,"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:"Human-readable name for the credential.","x-order":2,minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true}}}}}},responses:{200:{description:"Credential updated",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
4
|
+
`,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"owner"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the credential was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was soft-deleted.","x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"}}}}}}},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","meshery"],tags:["credentials"],summary:"Delete credential",operationId:"deleteUserCredential",description:"Deletes a credential belonging to the authenticated user.",parameters:[{name:"credentialId",in:"query",description:"Credential ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Credential 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"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/integrations/credentials/{credentialId}":{get:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Get credential by ID",operationId:"getCredentialById",description:"Retrieves a specific credential by its ID.",parameters:[{name:"credentialId",in:"path",description:"Credential 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:"Credential response",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
5
|
+
`,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"owner"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the credential was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was soft-deleted.","x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"}}}}}}},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:{credentialId:{name:"credentialId",in:"path",description:"Credential 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"}}},credentialIdQuery:{name:"credentialId",in:"query",description:"Credential 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 responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"string"}},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:{Credential:{type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
6
|
+
`,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"owner"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the credential was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was soft-deleted.","x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"}}}},CredentialPayload:{type:"object",description:"Payload for creating or updating a credential.",required:["name","type"],properties:{id:{description:"Existing credential ID for updates; omit on create.","x-order":1,"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:"Human-readable name for the credential.","x-order":2,minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true}}},CredentialPage:{type:"object",description:"A paginated list of credentials.",required:["credentials","totalCount","page","pageSize"],properties:{credentials:{type:"array",items:{"x-go-type":"Credential",type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
7
|
+
`,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"owner"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the credential was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was soft-deleted.","x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"}}}},"x-order":1,description:"The credentials returned on the current page."},totalCount:{type:"integer",description:"Total number of credentials across all pages.","x-order":2,minimum:0},page:{type:"integer",description:"Current page number (zero-based).","x-order":3,minimum:0},pageSize:{type:"integer",description:"Number of credentials per page.","x-order":4,minimum:1}}}}}},t=e;export{t as default};
|