@meshery/schemas 1.3.40 → 1.3.42
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +53 -53
- package/dist/cloudApi.d.ts +53 -53
- package/dist/constructs/v1beta1/badge/BadgeSchema.js +1 -1
- package/dist/constructs/v1beta1/badge/BadgeSchema.mjs +1 -1
- package/dist/constructs/v1beta1/console/Console.d.ts +458 -0
- package/dist/constructs/v1beta1/console/Console.js +1 -0
- package/dist/constructs/v1beta1/console/Console.mjs +0 -0
- package/dist/constructs/v1beta1/console/ConsoleSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/console/ConsoleSchema.js +4 -0
- package/dist/constructs/v1beta1/console/ConsoleSchema.mjs +4 -0
- package/dist/constructs/v1beta1/credential/CredentialSchema.js +1 -1
- package/dist/constructs/v1beta1/credential/CredentialSchema.mjs +1 -1
- package/dist/constructs/v1beta1/key/KeySchema.js +1 -1
- package/dist/constructs/v1beta1/key/KeySchema.mjs +1 -1
- package/dist/constructs/v1beta1/keychain/KeychainSchema.js +1 -1
- package/dist/constructs/v1beta1/keychain/KeychainSchema.mjs +1 -1
- package/dist/constructs/v1beta1/view/ViewSchema.js +1 -1
- package/dist/constructs/v1beta1/view/ViewSchema.mjs +1 -1
- package/dist/constructs/v1beta2/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta2/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta2/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta2/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta2/plan/PlanSchema.js +1 -1
- package/dist/constructs/v1beta2/plan/PlanSchema.mjs +1 -1
- package/dist/constructs/v1beta2/subscription/SubscriptionSchema.js +1 -1
- package/dist/constructs/v1beta2/subscription/SubscriptionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/academy/Academy.d.ts +265 -265
- package/dist/constructs/v1beta3/academy/AcademySchema.js +3 -3
- package/dist/constructs/v1beta3/academy/AcademySchema.mjs +3 -3
- package/dist/index.js +2 -2
- package/dist/index.mjs +2 -2
- package/dist/mesheryApi.d.mts +3245 -2073
- package/dist/mesheryApi.d.ts +3245 -2073
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Console API",description:'OpenAPI schema for interactive consoles against the resources reachable through a Meshery connection: an interactive terminal, and a log tail.\n"Console" rather than "session": a Meshery session already means a user\'s authenticated session, and the two were read for one another.\nConsoles are deliberately connection-scoped and resource-agnostic. A console driver is registered per connection kind ("kubernetes" today; a container runtime, a managed database, or a remote host tomorrow), so support for a new resource universe is additive and none of the shapes below are Kubernetes-specific. `ConsoleTarget.resource` names a driver-specific resource type, and `namespace`/`container` are optional qualifiers a driver interprets for itself.\nTwo of the three endpoints are WebSockets. They are documented here because this file is the wire contract, but they must be consumed with a native WebSocket client rather than a generated RTK hook \u2014 the same way the Server-Sent Events endpoints in the System API are consumed with a native EventSource. The frame protocol they speak is described on ConsoleControlMessage.',version:"v1beta1",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:"Console",description:"Interactive terminal and log consoles against a connection's resources."}],paths:{"/api/integrations/connections/{connectionId}/console/capabilities":{get:{"x-internal":["meshery"],tags:["Console"],operationId:"getConsoleCapabilities",summary:"Report which console kinds a resource supports",description:"Resolve what the connection's console driver can do with the addressed resource, against live state rather than a static table: whether a resource admits a terminal generally depends on its current status. Used by a client to decide whether to offer a terminal or a log tail before opening a socket, and which containers the user may choose between.",parameters:[{name:"connectionId",in:"path",required:true,description:"The connection whose resources the console addresses.",schema:{type:"string",format:"uuid"}},{name:"resource",in:"query",required:true,description:"The driver-specific resource type, e.g. `pod` for a kubernetes connection.",schema:{type:"string",maxLength:253}},{name:"name",in:"query",required:true,description:"The resource's name within its scope.",schema:{type:"string",maxLength:253}},{name:"namespace",in:"query",required:false,description:"The resource's parent scope, where it has one. Required for namespaced Kubernetes resources.",schema:{type:"string",maxLength:253}},{name:"container",in:"query",required:false,description:"A sub-target within the resource, e.g. a container within a pod. The driver's default sub-target is used when omitted.",schema:{type:"string",maxLength:253}}],responses:{200:{description:"The console kinds the target admits.",content:{"application/json":{schema:{type:"object",description:"What a driver can do with one specific target. Resolved against live state rather than a static table, because whether a target admits a terminal generally depends on its current status.",additionalProperties:false,required:["terminal","logs"],properties:{terminal:{type:"boolean",description:"Whether an interactive terminal can be opened.","x-oapi-codegen-extra-tags":{json:"terminal"}},logs:{type:"boolean",description:"Whether a log stream can be opened.","x-oapi-codegen-extra-tags":{json:"logs"}},containers:{type:"array",description:"The addressable sub-targets, if the resource has any.",maxItems:256,items:{type:"string",maxLength:253},"x-oapi-codegen-extra-tags":{json:"containers,omitempty"},"x-go-type-skip-optional-pointer":true},defaultContainer:{type:"string",description:"The sub-target used when ConsoleTarget.container is empty.",maxLength:253,"x-oapi-codegen-extra-tags":{json:"defaultContainer,omitempty"},"x-go-type-skip-optional-pointer":true},reason:{type:"string",description:"Explains, for a human, why an unsupported console kind is unsupported \u2014 e.g. that the pod is not running.",maxLength:1024,"x-oapi-codegen-extra-tags":{json:"reason,omitempty"},"x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/integrations/connections/{connectionId}/console/terminal":{get:{"x-internal":["meshery"],tags:["Console"],operationId:"openTerminalConsole",summary:"Open an interactive terminal over a WebSocket",description:`Upgrade to a WebSocket carrying an interactive, TTY-backed shell in the target resource. Consume with a native WebSocket client, not a generated RTK hook.
|
|
2
|
+
Everything that can fail with a useful HTTP status \u2014 an unknown target, an unsupported console kind, an exhausted per-user console budget \u2014 is settled before the upgrade, so those failures arrive as ordinary HTTP responses rather than as a socket that opens and immediately closes. The handshake enforces a same-origin check: it is authenticated by an ambient session cookie, so accepting any Origin would let any page the user visits open a shell as them.
|
|
3
|
+
The console runs with the requesting user's own credential, so the target's native authorization (Kubernetes RBAC, for a kubernetes connection) governs it unchanged.
|
|
4
|
+
See ConsoleControlMessage for the frame protocol.`,parameters:[{name:"connectionId",in:"path",required:true,description:"The connection whose resources the console addresses.",schema:{type:"string",format:"uuid"}},{name:"resource",in:"query",required:true,description:"The driver-specific resource type, e.g. `pod` for a kubernetes connection.",schema:{type:"string",maxLength:253}},{name:"name",in:"query",required:true,description:"The resource's name within its scope.",schema:{type:"string",maxLength:253}},{name:"namespace",in:"query",required:false,description:"The resource's parent scope, where it has one. Required for namespaced Kubernetes resources.",schema:{type:"string",maxLength:253}},{name:"container",in:"query",required:false,description:"A sub-target within the resource, e.g. a container within a pod. The driver's default sub-target is used when omitted.",schema:{type:"string",maxLength:253}},{name:"command",in:"query",description:"The argv to execute, one query parameter per element. When omitted the driver picks a sensible interactive shell for the target.",required:false,schema:{type:"array",maxItems:64,items:{type:"string",maxLength:4096}}}],responses:{101:{description:"Switching Protocols. The connection becomes a console WebSocket speaking the frame protocol on ConsoleControlMessage."},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"The WebSocket handshake carried an Origin that is neither the server's own nor in its configured allow-list."},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"The user already holds the maximum number of concurrent consoles."},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/integrations/connections/{connectionId}/console/logs":{get:{"x-internal":["meshery"],tags:["Console"],operationId:"openLogConsole",summary:"Stream a resource's logs over a WebSocket",description:"Upgrade to a WebSocket carrying the target resource's log output. With `follow=true` the socket stays open until the client leaves; otherwise it closes once the available history has been sent. Consume with a native WebSocket client, not a generated RTK hook.\nThe stream parameters below are fixed when the remote log stream is created and cannot be renegotiated on a live socket: changing any of them means opening a new console.\nSee ConsoleControlMessage for the frame protocol.",parameters:[{name:"connectionId",in:"path",required:true,description:"The connection whose resources the console addresses.",schema:{type:"string",format:"uuid"}},{name:"resource",in:"query",required:true,description:"The driver-specific resource type, e.g. `pod` for a kubernetes connection.",schema:{type:"string",maxLength:253}},{name:"name",in:"query",required:true,description:"The resource's name within its scope.",schema:{type:"string",maxLength:253}},{name:"namespace",in:"query",required:false,description:"The resource's parent scope, where it has one. Required for namespaced Kubernetes resources.",schema:{type:"string",maxLength:253}},{name:"container",in:"query",required:false,description:"A sub-target within the resource, e.g. a container within a pod. The driver's default sub-target is used when omitted.",schema:{type:"string",maxLength:253}},{name:"follow",in:"query",description:"Keep the stream open and append new output as it is produced.",required:false,schema:{type:"boolean",default:false}},{name:"previous",in:"query",description:"Return the logs of the target's prior instance, if any.",required:false,schema:{type:"boolean",default:false}},{name:"timestamps",in:"query",description:"Prefix each line with an RFC 3339 timestamp.",required:false,schema:{type:"boolean",default:false}},{name:"tailLines",in:"query",description:"Cap how many lines of history are replayed before following. Omit for no limit.",required:false,schema:{type:"integer",format:"int64",minimum:0}},{name:"sinceSeconds",in:"query",description:"Bound history to output produced within the last N seconds. Omit for no bound; a value of 0 is treated as omitted.",required:false,schema:{type:"integer",format:"int64",minimum:0}}],responses:{101:{description:"Switching Protocols. The connection becomes a console WebSocket speaking the frame protocol on ConsoleControlMessage."},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"The WebSocket handshake carried an Origin that is neither the server's own nor in its configured allow-list."},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"The user already holds the maximum number of concurrent consoles."},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"}}}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},parameters:{connectionId:{name:"connectionId",in:"path",required:true,description:"The connection whose resources the console addresses.",schema:{type:"string",format:"uuid"}},resource:{name:"resource",in:"query",required:true,description:"The driver-specific resource type, e.g. `pod` for a kubernetes connection.",schema:{type:"string",maxLength:253}},name:{name:"name",in:"query",required:true,description:"The resource's name within its scope.",schema:{type:"string",maxLength:253}},namespace:{name:"namespace",in:"query",required:false,description:"The resource's parent scope, where it has one. Required for namespaced Kubernetes resources.",schema:{type:"string",maxLength:253}},container:{name:"container",in:"query",required:false,description:"A sub-target within the resource, e.g. a container within a pod. The driver's default sub-target is used when omitted.",schema:{type:"string",maxLength:253}}},schemas:{ConsoleKind:{type:"string",description:"The kinds of console a driver may support for a given target.",enum:["terminal","logs"]},ConsoleTarget:{type:"object",description:"Addresses the resource a console attaches to, within the universe of a single connection. The field names read Kubernetes-ish because that is the first driver, but each driver interprets them for itself: `namespace` is any parent scope, `container` is any sub-target within `name`. A driver ignores the fields it has no use for.",additionalProperties:false,required:["resource","name"],properties:{resource:{type:"string",description:'The driver-specific resource type, e.g. "pod".',maxLength:253,"x-oapi-codegen-extra-tags":{json:"resource"}},namespace:{type:"string",description:"The parent scope of the resource, if it has one.",maxLength:253,"x-oapi-codegen-extra-tags":{json:"namespace,omitempty"},"x-go-type-skip-optional-pointer":true},name:{type:"string",description:"Identifies the resource within its scope.",maxLength:253,"x-oapi-codegen-extra-tags":{json:"name"}},container:{type:"string",description:"Selects a sub-target within the resource, if it has any.",maxLength:253,"x-oapi-codegen-extra-tags":{json:"container,omitempty"},"x-go-type-skip-optional-pointer":true}}},ConsoleCapabilities:{type:"object",description:"What a driver can do with one specific target. Resolved against live state rather than a static table, because whether a target admits a terminal generally depends on its current status.",additionalProperties:false,required:["terminal","logs"],properties:{terminal:{type:"boolean",description:"Whether an interactive terminal can be opened.","x-oapi-codegen-extra-tags":{json:"terminal"}},logs:{type:"boolean",description:"Whether a log stream can be opened.","x-oapi-codegen-extra-tags":{json:"logs"}},containers:{type:"array",description:"The addressable sub-targets, if the resource has any.",maxItems:256,items:{type:"string",maxLength:253},"x-oapi-codegen-extra-tags":{json:"containers,omitempty"},"x-go-type-skip-optional-pointer":true},defaultContainer:{type:"string",description:"The sub-target used when ConsoleTarget.container is empty.",maxLength:253,"x-oapi-codegen-extra-tags":{json:"defaultContainer,omitempty"},"x-go-type-skip-optional-pointer":true},reason:{type:"string",description:"Explains, for a human, why an unsupported console kind is unsupported \u2014 e.g. that the pod is not running.",maxLength:1024,"x-oapi-codegen-extra-tags":{json:"reason,omitempty"},"x-go-type-skip-optional-pointer":true}}},ConsoleControlType:{type:"string",description:"Identifies a console control frame. `resize` travels client-to-server; the rest travel server-to-client. A receiver ignores an unknown or wrong-direction type, so a newer peer can send frames an older one does not know about without breaking the console.",enum:["ready","resize","error","exit","eof"]},ConsoleControlMessage:{type:"object",description:"The JSON payload of a console WebSocket's text frames.\nA console socket carries two interleaved channels, distinguished by WebSocket opcode rather than by an envelope field. Binary frames carry raw payload bytes: stdin keystrokes from the client (terminal consoles only), and stdout or log bytes to the client. Text frames carry one of these JSON control messages.\nSplitting on opcode keeps the hot path allocation-light and avoids base64-inflating every keystroke and every log line by a third. It is also required for correctness: terminal output is not valid UTF-8 in general \u2014 it carries escape sequences, and arbitrary octets from a program writing raw bytes \u2014 so a text frame could not carry it faithfully.\nEvery console ends with exactly one terminal control frame (`error`, `exit`, or `eof`) before the socket is closed, so a client never has to infer why a stream stopped from the close code alone. The close code is 4000 when the console ended as intended and 4001 when it failed; both sit in the private-use range RFC 6455 \xA77.4.2 reserves for applications.\nFields not relevant to a given `type` are omitted.",additionalProperties:false,required:["type"],properties:{type:{type:"string",description:"Identifies a console control frame. `resize` travels client-to-server; the rest travel server-to-client. A receiver ignores an unknown or wrong-direction type, so a newer peer can send frames an older one does not know about without breaking the console.",enum:["ready","resize","error","exit","eof"]},cols:{type:"integer",description:"Terminal width in character cells. Carried by `resize`.",minimum:0,maximum:65535,"x-oapi-codegen-extra-tags":{json:"cols,omitempty"},"x-go-type-skip-optional-pointer":true},rows:{type:"integer",description:"Terminal height in character cells. Carried by `resize`.",minimum:0,maximum:65535,"x-oapi-codegen-extra-tags":{json:"rows,omitempty"},"x-go-type-skip-optional-pointer":true},capabilities:{allOf:[{type:"object",description:"What a driver can do with one specific target. Resolved against live state rather than a static table, because whether a target admits a terminal generally depends on its current status.",additionalProperties:false,required:["terminal","logs"],properties:{terminal:{type:"boolean",description:"Whether an interactive terminal can be opened.","x-oapi-codegen-extra-tags":{json:"terminal"}},logs:{type:"boolean",description:"Whether a log stream can be opened.","x-oapi-codegen-extra-tags":{json:"logs"}},containers:{type:"array",description:"The addressable sub-targets, if the resource has any.",maxItems:256,items:{type:"string",maxLength:253},"x-oapi-codegen-extra-tags":{json:"containers,omitempty"},"x-go-type-skip-optional-pointer":true},defaultContainer:{type:"string",description:"The sub-target used when ConsoleTarget.container is empty.",maxLength:253,"x-oapi-codegen-extra-tags":{json:"defaultContainer,omitempty"},"x-go-type-skip-optional-pointer":true},reason:{type:"string",description:"Explains, for a human, why an unsupported console kind is unsupported \u2014 e.g. that the pod is not running.",maxLength:1024,"x-oapi-codegen-extra-tags":{json:"reason,omitempty"},"x-go-type-skip-optional-pointer":true}}}],description:"The resolved target capabilities. Carried by `ready`, which the server sends once, after it has attached to the target. It lets a client render the sub-target it actually attached to when the request left `container` unspecified.\nDeliberately left as a pointer in Go: `omitempty` does not elide an empty struct, so a value type would stamp an empty capabilities object onto every `error` and `exit` frame.","x-oapi-codegen-extra-tags":{json:"capabilities,omitempty"}},code:{type:"string",description:'The MeshKit error code of an `error` frame, e.g. "meshery-server-1447". Lets a client branch on the failure without parsing prose.',maxLength:64,"x-oapi-codegen-extra-tags":{json:"code,omitempty"},"x-go-type-skip-optional-pointer":true},message:{type:"string",description:"The human-readable description of an `error` frame.",maxLength:4096,"x-oapi-codegen-extra-tags":{json:"message,omitempty"},"x-go-type-skip-optional-pointer":true},exitCode:{type:"integer",description:"The remote command's status. Carried by `exit`.","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"exitCode"}}}}}}},t=e;export{t as default};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
'use strict';var e={openapi:"3.0.0",info:{title:"credential","x-deprecated":true,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:"v1beta1"},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",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","x-deprecated":true,"x-superseded-by":"v1beta2",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:"v1beta1"},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",description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
2
2
|
`,required:["name","type"],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},user_id:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"owner"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the credential was soft-deleted.","x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":1,description:"The credentials of the credentialpage."},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:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
3
3
|
`,required:["name","type"],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},user_id:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"owner"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the credential was soft-deleted.","x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},responses:{201:{description:"Credential saved",content:{"application/json":{schema:{type:"object",description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
4
4
|
`,required:["name","type"],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},user_id:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"owner"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the credential was soft-deleted.","x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},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:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
var e={openapi:"3.0.0",info:{title:"credential","x-deprecated":true,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:"v1beta1"},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",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","x-deprecated":true,"x-superseded-by":"v1beta2",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:"v1beta1"},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",description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
2
2
|
`,required:["name","type"],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},user_id:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"owner"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the credential was soft-deleted.","x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":1,description:"The credentials of the credentialpage."},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:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
3
3
|
`,required:["name","type"],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},user_id:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"owner"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the credential was soft-deleted.","x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},responses:{201:{description:"Credential saved",content:{"application/json":{schema:{type:"object",description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
4
4
|
`,required:["name","type"],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},user_id:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"owner"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the credential was soft-deleted.","x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},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:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
'use strict';var e={openapi:"3.0.0",info:{title:"Key","x-deprecated":true,description:"OpenAPI schema for authorization key management in Meshery.",version:"v1beta1",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",required:["page","page_size","total_count","keys"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keys of the keypage."}}}}}},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",required:["page","page_size","total_count","keys"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keys of the keypage."}}}}}},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},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","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/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","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["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","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},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},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",required:["page","page_size","total_count","keys"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keys of the keypage."}}}}}},t=e;
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"Key","x-deprecated":true,"x-superseded-by":"v1beta2",description:"OpenAPI schema for authorization key management in Meshery.",version:"v1beta1",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",required:["page","page_size","total_count","keys"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keys of the keypage."}}}}}},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",required:["page","page_size","total_count","keys"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keys of the keypage."}}}}}},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},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","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/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","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["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","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},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},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",required:["page","page_size","total_count","keys"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keys of the keypage."}}}}}},t=e;
|
|
2
2
|
module.exports=t;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var e={openapi:"3.0.0",info:{title:"Key","x-deprecated":true,description:"OpenAPI schema for authorization key management in Meshery.",version:"v1beta1",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",required:["page","page_size","total_count","keys"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keys of the keypage."}}}}}},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",required:["page","page_size","total_count","keys"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keys of the keypage."}}}}}},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},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","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/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","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["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","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},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},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",required:["page","page_size","total_count","keys"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keys of the keypage."}}}}}},t=e;
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Key","x-deprecated":true,"x-superseded-by":"v1beta2",description:"OpenAPI schema for authorization key management in Meshery.",version:"v1beta1",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",required:["page","page_size","total_count","keys"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keys of the keypage."}}}}}},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",required:["page","page_size","total_count","keys"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keys of the keypage."}}}}}},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},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","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/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","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["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","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},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},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",required:["page","page_size","total_count","keys"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","created_at","updated_at"],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"},"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"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description"},"x-order":6,maxLength:5e3},created_at:{"x-order":7,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":8,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":9,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keys of the keypage."}}}}}},t=e;
|
|
2
2
|
export{t as default};
|