@meshery/schemas 1.3.28 → 1.3.30
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 +3420 -3186
- package/dist/cloudApi.d.ts +3420 -3186
- package/dist/constructs/v1beta2/academy/Academy.d.ts +2 -2
- package/dist/constructs/v1beta2/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta2/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta2/core/Core.d.ts +2 -2
- package/dist/constructs/v1beta2/core/CoreSchema.js +1 -1
- package/dist/constructs/v1beta2/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta2/credential/Credential.d.ts +4 -4
- package/dist/constructs/v1beta2/credential/CredentialSchema.js +2 -2
- package/dist/constructs/v1beta2/credential/CredentialSchema.mjs +2 -2
- package/dist/constructs/v1beta2/design/Design.d.ts +12 -12
- package/dist/constructs/v1beta2/design/DesignSchema.js +5 -5
- package/dist/constructs/v1beta2/design/DesignSchema.mjs +5 -5
- package/dist/constructs/v1beta2/event/Event.d.ts +10 -10
- package/dist/constructs/v1beta2/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta2/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +2 -2
- package/dist/constructs/v1beta2/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta2/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta2/key/Key.d.ts +6 -6
- package/dist/constructs/v1beta2/key/KeySchema.js +1 -1
- package/dist/constructs/v1beta2/key/KeySchema.mjs +1 -1
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +6 -6
- package/dist/constructs/v1beta2/keychain/KeychainSchema.js +1 -1
- package/dist/constructs/v1beta2/keychain/KeychainSchema.mjs +1 -1
- package/dist/constructs/v1beta2/organization/Organization.d.ts +14 -0
- package/dist/constructs/v1beta2/organization/OrganizationSchema.js +1 -1
- package/dist/constructs/v1beta2/organization/OrganizationSchema.mjs +1 -1
- package/dist/constructs/v1beta2/plan/Plan.d.ts +2 -2
- package/dist/constructs/v1beta2/plan/PlanSchema.js +1 -1
- package/dist/constructs/v1beta2/plan/PlanSchema.mjs +1 -1
- package/dist/constructs/v1beta2/role/Role.d.ts +6 -6
- package/dist/constructs/v1beta2/role/RoleSchema.js +1 -1
- package/dist/constructs/v1beta2/role/RoleSchema.mjs +1 -1
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +4 -4
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.js +2 -2
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.mjs +2 -2
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +4 -4
- package/dist/constructs/v1beta2/subscription/SubscriptionSchema.js +1 -1
- package/dist/constructs/v1beta2/subscription/SubscriptionSchema.mjs +1 -1
- package/dist/constructs/v1beta2/team/Team.d.ts +16 -41
- package/dist/constructs/v1beta2/team/TeamSchema.js +1 -1
- package/dist/constructs/v1beta2/team/TeamSchema.mjs +1 -1
- package/dist/constructs/v1beta2/token/Token.d.ts +4 -4
- 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 +6 -6
- package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
- package/dist/constructs/v1beta2/view/View.d.ts +4 -4
- package/dist/constructs/v1beta2/view/ViewSchema.js +2 -2
- package/dist/constructs/v1beta2/view/ViewSchema.mjs +2 -2
- package/dist/constructs/v1beta3/academy/Academy.d.ts +767 -3
- package/dist/constructs/v1beta3/academy/AcademySchema.js +3 -1
- package/dist/constructs/v1beta3/academy/AcademySchema.mjs +3 -1
- package/dist/constructs/v1beta3/design/Design.d.ts +5 -5
- package/dist/constructs/v1beta3/design/DesignSchema.js +5 -5
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +5 -5
- package/dist/constructs/v1beta3/environment/Environment.d.ts +6 -6
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/event/Event.d.ts +11 -11
- package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta3/filter/Filter.d.ts +2 -2
- package/dist/constructs/v1beta3/filter/FilterSchema.js +2 -2
- package/dist/constructs/v1beta3/filter/FilterSchema.mjs +2 -2
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +4 -4
- 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 +2 -2
- package/dist/constructs/v1beta3/pattern_resource/PatternResourceSchema.js +2 -2
- package/dist/constructs/v1beta3/pattern_resource/PatternResourceSchema.mjs +2 -2
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +4 -4
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.js +1 -1
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.mjs +1 -1
- package/dist/constructs/v1beta3/plan/Plan.d.ts +2 -2
- package/dist/constructs/v1beta3/plan/PlanSchema.js +1 -1
- package/dist/constructs/v1beta3/plan/PlanSchema.mjs +1 -1
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +4 -4
- package/dist/constructs/v1beta3/subscription/SubscriptionSchema.js +1 -1
- package/dist/constructs/v1beta3/subscription/SubscriptionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/token/Token.d.ts +4 -4
- package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +12 -12
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
- package/dist/index.d.mts +14 -8
- package/dist/index.d.ts +14 -8
- package/dist/index.js +6 -6
- package/dist/index.mjs +6 -6
- package/dist/mesheryApi.d.mts +1407 -1399
- package/dist/mesheryApi.d.ts +1407 -1399
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
'use strict';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:"
|
|
1
|
+
'use strict';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:"integer"}},{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:"integer"}},{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
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
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
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:"
|
|
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:"integer"}},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:"integer"}},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
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
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;module.exports=t;
|
|
@@ -1,7 +1,7 @@
|
|
|
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:"
|
|
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:"integer"}},{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:"integer"}},{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
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
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
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:"
|
|
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:"integer"}},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:"integer"}},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
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
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};
|
|
@@ -7903,9 +7903,9 @@ export interface components {
|
|
|
7903
7903
|
/** @description Design (Pattern) ID */
|
|
7904
7904
|
id: string;
|
|
7905
7905
|
/** @description Get responses by page */
|
|
7906
|
-
page:
|
|
7906
|
+
page: number;
|
|
7907
7907
|
/** @description Get responses by pagesize */
|
|
7908
|
-
pagesize:
|
|
7908
|
+
pagesize: number;
|
|
7909
7909
|
/** @description Get responses that match search param value */
|
|
7910
7910
|
search: string;
|
|
7911
7911
|
/** @description Get ordered responses */
|
|
@@ -7962,9 +7962,9 @@ export interface operations {
|
|
|
7962
7962
|
parameters: {
|
|
7963
7963
|
query?: {
|
|
7964
7964
|
/** @description Get responses by page */
|
|
7965
|
-
page?:
|
|
7965
|
+
page?: number;
|
|
7966
7966
|
/** @description Get responses by pagesize */
|
|
7967
|
-
pagesize?:
|
|
7967
|
+
pagesize?: number;
|
|
7968
7968
|
/** @description Get responses that match search param value */
|
|
7969
7969
|
search?: string;
|
|
7970
7970
|
/** @description Get ordered responses */
|
|
@@ -12541,9 +12541,9 @@ export interface operations {
|
|
|
12541
12541
|
parameters: {
|
|
12542
12542
|
query?: {
|
|
12543
12543
|
/** @description Get responses by page */
|
|
12544
|
-
page?:
|
|
12544
|
+
page?: number;
|
|
12545
12545
|
/** @description Get responses by pagesize */
|
|
12546
|
-
pagesize?:
|
|
12546
|
+
pagesize?: number;
|
|
12547
12547
|
/** @description Get responses that match search param value */
|
|
12548
12548
|
search?: string;
|
|
12549
12549
|
/** @description Get ordered responses */
|
|
@@ -15996,9 +15996,9 @@ export interface operations {
|
|
|
15996
15996
|
parameters: {
|
|
15997
15997
|
query?: {
|
|
15998
15998
|
/** @description Get responses by page */
|
|
15999
|
-
page?:
|
|
15999
|
+
page?: number;
|
|
16000
16000
|
/** @description Get responses by pagesize */
|
|
16001
|
-
pagesize?:
|
|
16001
|
+
pagesize?: number;
|
|
16002
16002
|
/** @description Get responses that match search param value */
|
|
16003
16003
|
search?: string;
|
|
16004
16004
|
/** @description Get ordered responses */
|
|
@@ -17685,9 +17685,9 @@ export interface operations {
|
|
|
17685
17685
|
parameters: {
|
|
17686
17686
|
query?: {
|
|
17687
17687
|
/** @description Get responses by page */
|
|
17688
|
-
page?:
|
|
17688
|
+
page?: number;
|
|
17689
17689
|
/** @description Get responses by pagesize */
|
|
17690
|
-
pagesize?:
|
|
17690
|
+
pagesize?: number;
|
|
17691
17691
|
};
|
|
17692
17692
|
header?: never;
|
|
17693
17693
|
path?: never;
|
|
@@ -18196,9 +18196,9 @@ export interface operations {
|
|
|
18196
18196
|
parameters: {
|
|
18197
18197
|
query?: {
|
|
18198
18198
|
/** @description Get responses by page */
|
|
18199
|
-
page?:
|
|
18199
|
+
page?: number;
|
|
18200
18200
|
/** @description Get responses by pagesize */
|
|
18201
|
-
pagesize?:
|
|
18201
|
+
pagesize?: number;
|
|
18202
18202
|
/** @description Get responses that match search param value */
|
|
18203
18203
|
search?: string;
|
|
18204
18204
|
/** @description Get ordered responses */
|