@meshery/schemas 1.3.20 → 1.3.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/dist/cloudApi.d.mts +2087 -1665
  2. package/dist/cloudApi.d.ts +2087 -1665
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta2/credential/Credential.d.ts +16 -6
  6. package/dist/constructs/v1beta2/credential/CredentialSchema.js +5 -5
  7. package/dist/constructs/v1beta2/credential/CredentialSchema.mjs +5 -5
  8. package/dist/constructs/v1beta2/key/Key.d.ts +18 -3
  9. package/dist/constructs/v1beta2/key/KeySchema.js +1 -1
  10. package/dist/constructs/v1beta2/key/KeySchema.mjs +1 -1
  11. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +18 -3
  12. package/dist/constructs/v1beta2/keychain/KeychainSchema.js +1 -1
  13. package/dist/constructs/v1beta2/keychain/KeychainSchema.mjs +1 -1
  14. package/dist/constructs/v1beta2/team/Team.d.ts +36 -16
  15. package/dist/constructs/v1beta2/team/TeamSchema.js +1 -1
  16. package/dist/constructs/v1beta2/team/TeamSchema.mjs +1 -1
  17. package/dist/constructs/v1beta2/view/View.d.ts +12 -2
  18. package/dist/constructs/v1beta2/view/ViewSchema.js +2 -2
  19. package/dist/constructs/v1beta2/view/ViewSchema.mjs +2 -2
  20. package/dist/constructs/v1beta3/academy/Academy.d.ts +10 -0
  21. package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
  22. package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
  23. package/dist/constructs/v1beta3/connection/Connection.d.ts +793 -11
  24. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
  25. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
  26. package/dist/constructs/v1beta3/environment/Environment.d.ts +18 -3
  27. package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
  28. package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
  29. package/dist/constructs/v1beta3/event/Event.d.ts +19 -2
  30. package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
  31. package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
  32. package/dist/constructs/v1beta3/token/Token.d.ts +12 -2
  33. package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
  34. package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
  35. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +36 -6
  36. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
  37. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
  38. package/dist/mesheryApi.d.mts +1137 -733
  39. package/dist/mesheryApi.d.ts +1137 -733
  40. package/dist/mesheryApi.js +1 -1
  41. package/dist/mesheryApi.mjs +1 -1
  42. package/package.json +1 -1
@@ -150,11 +150,11 @@ export interface components {
150
150
  deletedAt?: string;
151
151
  }[];
152
152
  /** @description Total number of credentials across all pages. */
153
- total_count: number;
153
+ totalCount: number;
154
154
  /** @description Current page number (zero-based). */
155
155
  page: number;
156
156
  /** @description Number of credentials per page. */
157
- page_size: number;
157
+ pageSize: number;
158
158
  };
159
159
  };
160
160
  responses: {
@@ -202,7 +202,12 @@ export interface components {
202
202
  credentialIdQuery: string;
203
203
  /** @description Get responses by page */
204
204
  page: string;
205
- /** @description Get responses by pagesize */
205
+ /** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
206
+ pageSize: number;
207
+ /**
208
+ * @deprecated
209
+ * @description Get responses by pagesize. Deprecated alias of pageSize.
210
+ */
206
211
  pagesize: string;
207
212
  /** @description Get responses that match search param value */
208
213
  search: string;
@@ -220,7 +225,12 @@ export interface operations {
220
225
  query?: {
221
226
  /** @description Get responses by page */
222
227
  page?: string;
223
- /** @description Get responses by pagesize */
228
+ /** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
229
+ pageSize?: number;
230
+ /**
231
+ * @deprecated
232
+ * @description Get responses by pagesize. Deprecated alias of pageSize.
233
+ */
224
234
  pagesize?: string;
225
235
  /** @description Get responses that match search param value */
226
236
  search?: string;
@@ -275,11 +285,11 @@ export interface operations {
275
285
  deletedAt?: string;
276
286
  }[];
277
287
  /** @description Total number of credentials across all pages. */
278
- total_count: number;
288
+ totalCount: number;
279
289
  /** @description Current page number (zero-based). */
280
290
  page: number;
281
291
  /** @description Number of credentials per page. */
282
- page_size: number;
292
+ pageSize: number;
283
293
  };
284
294
  };
285
295
  };
@@ -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:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",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","total_count","page","page_size"],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:"user_id"},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."},total_count:{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},page_size:{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.
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:"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:"user_id"},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:"user_id"},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:"user_id"},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:"user_id"},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:"Get responses by pagesize",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:"user_id"},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","total_count","page","page_size"],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:"user_id"},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."},total_count:{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},page_size:{type:"integer",description:"Number of credentials per page.","x-order":4,minimum:1}}}}}},t=e;module.exports=t;
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:"user_id"},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:"user_id"},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:"user_id"},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:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",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","total_count","page","page_size"],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:"user_id"},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."},total_count:{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},page_size:{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.
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:"user_id"},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:"user_id"},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:"user_id"},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:"user_id"},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:"Get responses by pagesize",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:"user_id"},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","total_count","page","page_size"],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:"user_id"},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."},total_count:{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},page_size:{type:"integer",description:"Number of credentials per page.","x-order":4,minimum:1}}}}}},t=e;export{t as default};
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:"user_id"},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:"user_id"},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:"user_id"},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};
@@ -207,7 +207,12 @@ export interface components {
207
207
  keyId: string;
208
208
  /** @description Get responses by page */
209
209
  page: string;
210
- /** @description Get responses by pagesize */
210
+ /** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
211
+ pageSize: number;
212
+ /**
213
+ * @deprecated
214
+ * @description Get responses by pagesize. Deprecated alias of pageSize.
215
+ */
211
216
  pagesize: string;
212
217
  /** @description Get ordered responses */
213
218
  order: string;
@@ -225,7 +230,12 @@ export interface operations {
225
230
  query?: {
226
231
  /** @description Get responses by page */
227
232
  page?: string;
228
- /** @description Get responses by pagesize */
233
+ /** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
234
+ pageSize?: number;
235
+ /**
236
+ * @deprecated
237
+ * @description Get responses by pagesize. Deprecated alias of pageSize.
238
+ */
229
239
  pagesize?: string;
230
240
  };
231
241
  header?: never;
@@ -323,7 +333,12 @@ export interface operations {
323
333
  query?: {
324
334
  /** @description Get responses by page */
325
335
  page?: string;
326
- /** @description Get responses by pagesize */
336
+ /** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
337
+ pageSize?: number;
338
+ /**
339
+ * @deprecated
340
+ * @description Get responses by pagesize. Deprecated alias of pageSize.
341
+ */
327
342
  pagesize?: string;
328
343
  /** @description Get responses that match search param value */
329
344
  search?: string;
@@ -1,2 +1,2 @@
1
- 'use strict';var e={openapi:"3.0.0",info:{title:"Key",description:"OpenAPI schema for authorization key management in Meshery.",version:"v1beta2",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"Key",description:"Operations related to authorization keys"},{name:"users",description:"Operations related to users and their authorization keys"}],paths:{"/api/identity/orgs/{orgId}/users/keys":{get:{"x-internal":["cloud","meshery"],tags:["users"],operationId:"getUserKeys",summary:"Get User Keys",description:"Get all keys based on roles assigned to user",parameters:[{name:"orgId",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}}],responses:{200:{description:"Returns user keys based on roles assigned to user",content:{"application/json":{schema:{type:"object",description:"A paginated list of authorization keys.",required:["page","pageSize","totalCount","keys"],properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":1},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-order":2,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":3,"x-oapi-codegen-extra-tags":{json:"totalCount"}},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],properties:{id:{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"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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"},"x-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},"x-order":4,description:"Keys returned on the current page."}}}}}},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/auth/keys":{get:{"x-internal":["cloud"],tags:["Key"],summary:"List key",operationId:"getKeys",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",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:"Keys fetched",content:{"application/json":{schema:{type:"object",description:"A paginated list of authorization keys.",required:["page","pageSize","totalCount","keys"],properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":1},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-order":2,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":3,"x-oapi-codegen-extra-tags":{json:"totalCount"}},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],properties:{id:{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"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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"},"x-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},"x-order":4,description:"Keys returned on the current page."}}}}}},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"}}}}}},post:{"x-internal":["cloud"],tags:["Key"],summary:"Create or update a key",operationId:"upsertKey",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a key.",properties:{id:{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"},"x-order":1,"x-oapi-codegen-extra-tags":{json:"id,omitempty"}},function:{type:"string",description:"Operation permitted by the key.","x-order":2,maxLength:500},category:{type:"string",description:"Category for the key.","x-order":3,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-order":4,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-order":5,maxLength:5e3}}}}}},responses:{200:{description:"Key upserted",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],properties:{id:{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"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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"},"x-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/auth/key/{keyId}":{get:{"x-internal":["cloud"],tags:["Key"],summary:"Get key by ID",operationId:"getKeyById",parameters:[{name:"keyId",in:"path",description:"Key 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:"Key response",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],properties:{id:{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"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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"},"x-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["Key"],summary:"Delete key",operationId:"deleteKey",parameters:[{name:"keyId",in:"path",description:"Key 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:"Key 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"}}}}}}}},components:{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:{orgId:{name:"orgId",in:"path",description:"Organization 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"}}},keyId:{name:"keyId",in:"path",description:"Key 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:"Get responses by pagesize",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{Key:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],properties:{id:{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"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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"},"x-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},KeyPayload:{type:"object",description:"Payload for creating or updating a key.",properties:{id:{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"},"x-order":1,"x-oapi-codegen-extra-tags":{json:"id,omitempty"}},function:{type:"string",description:"Operation permitted by the key.","x-order":2,maxLength:500},category:{type:"string",description:"Category for the key.","x-order":3,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-order":4,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-order":5,maxLength:5e3}}},KeyPage:{type:"object",description:"A paginated list of authorization keys.",required:["page","pageSize","totalCount","keys"],properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":1},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-order":2,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":3,"x-oapi-codegen-extra-tags":{json:"totalCount"}},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],properties:{id:{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"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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"},"x-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},"x-order":4,description:"Keys returned on the current page."}}}}}},t=e;
1
+ 'use strict';var e={openapi:"3.0.0",info:{title:"Key",description:"OpenAPI schema for authorization key management in Meshery.",version:"v1beta2",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"Key",description:"Operations related to authorization keys"},{name:"users",description:"Operations related to users and their authorization keys"}],paths:{"/api/identity/orgs/{orgId}/users/keys":{get:{"x-internal":["cloud","meshery"],tags:["users"],operationId:"getUserKeys",summary:"Get User Keys",description:"Get all keys based on roles assigned to user",parameters:[{name:"orgId",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"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"}}],responses:{200:{description:"Returns user keys based on roles assigned to user",content:{"application/json":{schema:{type:"object",description:"A paginated list of authorization keys.",required:["page","pageSize","totalCount","keys"],properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":1},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-order":2,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":3,"x-oapi-codegen-extra-tags":{json:"totalCount"}},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],properties:{id:{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"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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"},"x-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},"x-order":4,description:"Keys returned on the current page."}}}}}},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/auth/keys":{get:{"x-internal":["cloud"],tags:["Key"],summary:"List key",operationId:"getKeys",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:"Keys fetched",content:{"application/json":{schema:{type:"object",description:"A paginated list of authorization keys.",required:["page","pageSize","totalCount","keys"],properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":1},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-order":2,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":3,"x-oapi-codegen-extra-tags":{json:"totalCount"}},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],properties:{id:{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"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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"},"x-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},"x-order":4,description:"Keys returned on the current page."}}}}}},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"}}}}}},post:{"x-internal":["cloud"],tags:["Key"],summary:"Create or update a key",operationId:"upsertKey",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a key.",properties:{id:{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"},"x-order":1,"x-oapi-codegen-extra-tags":{json:"id,omitempty"}},function:{type:"string",description:"Operation permitted by the key.","x-order":2,maxLength:500},category:{type:"string",description:"Category for the key.","x-order":3,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-order":4,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-order":5,maxLength:5e3}}}}}},responses:{200:{description:"Key upserted",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],properties:{id:{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"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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"},"x-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/auth/key/{keyId}":{get:{"x-internal":["cloud"],tags:["Key"],summary:"Get key by ID",operationId:"getKeyById",parameters:[{name:"keyId",in:"path",description:"Key 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:"Key response",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],properties:{id:{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"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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"},"x-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["Key"],summary:"Delete key",operationId:"deleteKey",parameters:[{name:"keyId",in:"path",description:"Key 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:"Key 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"}}}}}}}},components:{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:{orgId:{name:"orgId",in:"path",description:"Organization 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"}}},keyId:{name:"keyId",in:"path",description:"Key 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"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{Key:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],properties:{id:{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"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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"},"x-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},KeyPayload:{type:"object",description:"Payload for creating or updating a key.",properties:{id:{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"},"x-order":1,"x-oapi-codegen-extra-tags":{json:"id,omitempty"}},function:{type:"string",description:"Operation permitted by the key.","x-order":2,maxLength:500},category:{type:"string",description:"Category for the key.","x-order":3,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-order":4,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-order":5,maxLength:5e3}}},KeyPage:{type:"object",description:"A paginated list of authorization keys.",required:["page","pageSize","totalCount","keys"],properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":1},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-order":2,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":3,"x-oapi-codegen-extra-tags":{json:"totalCount"}},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],properties:{id:{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"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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"},"x-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},"x-order":4,description:"Keys returned on the current page."}}}}}},t=e;
2
2
  module.exports=t;