@meshery/schemas 0.8.107 → 0.8.108

package/dist/constructs/v1beta1/organization/OrganizationSchema.d.mts

@@ -0,0 +1,765 @@
+/**
+ * This file was automatically generated from OpenAPI schema.
+ * Do not manually modify this file.
+ */
+declare const OrganizationSchema: {
+    readonly openapi: "3.0.0";
+    readonly info: {
+        readonly title: "Organization";
+        readonly version: "1.0.0";
+    };
+    readonly paths: {
+        readonly "/api/identity/orgs/by-domain": {
+            readonly get: {
+                readonly summary: "Get organization by domain";
+                readonly operationId: "getOrgByDomain";
+                readonly parameters: readonly [{
+                    readonly name: "domain";
+                    readonly in: "query";
+                    readonly required: true;
+                    readonly schema: {
+                        readonly type: "string";
+                    };
+                }];
+                readonly responses: {
+                    readonly "200": {
+                        readonly description: "Successful response";
+                        readonly content: {
+                            readonly "application/json": {
+                                readonly schema: {
+                                    readonly type: "object";
+                                    readonly required: readonly ["id", "name", "country", "region", "description", "owner", "metadata", "created_at", "updated_at"];
+                                    readonly properties: {
+                                        readonly id: {
+                                            readonly "x-oapi-codegen-extra-tags": {
+                                                readonly db: "id";
+                                            };
+                                            readonly type: "string";
+                                            readonly format: "uuid";
+                                            readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
+                                            readonly "x-go-type": "uuid.UUID";
+                                            readonly "x-go-type-import": {
+                                                readonly path: "github.com/gofrs/uuid";
+                                            };
+                                        };
+                                        readonly name: {
+                                            readonly type: "string";
+                                            readonly "x-oapi-codegen-extra-tags": {
+                                                readonly db: "name";
+                                            };
+                                        };
+                                        readonly country: {
+                                            readonly type: "string";
+                                            readonly "x-oapi-codegen-extra-tags": {
+                                                readonly db: "country";
+                                            };
+                                        };
+                                        readonly region: {
+                                            readonly type: "string";
+                                            readonly "x-oapi-codegen-extra-tags": {
+                                                readonly db: "region";
+                                            };
+                                        };
+                                        readonly description: {
+                                            readonly type: "string";
+                                            readonly "x-oapi-codegen-extra-tags": {
+                                                readonly db: "description";
+                                            };
+                                        };
+                                        readonly owner: {
+                                            readonly "x-oapi-codegen-extra-tags": {
+                                                readonly db: "owner";
+                                            };
+                                            readonly type: "string";
+                                            readonly format: "uuid";
+                                            readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
+                                            readonly "x-go-type": "uuid.UUID";
+                                            readonly "x-go-type-import": {
+                                                readonly path: "github.com/gofrs/uuid";
+                                            };
+                                        };
+                                        readonly metadata: {
+                                            readonly "x-go-type": "OrgMetadata";
+                                            readonly "x-oapi-codegen-extra-tags": {
+                                                readonly db: "metadata";
+                                            };
+                                            readonly type: "object";
+                                            readonly required: readonly ["preferences"];
+                                            readonly properties: {
+                                                readonly preferences: {
+                                                    readonly "x-go-type": "Preferences";
+                                                    readonly type: "object";
+                                                    readonly required: readonly ["theme", "dashboard"];
+                                                    readonly properties: {
+                                                        readonly theme: {
+                                                            readonly "x-go-type": "Theme";
+                                                            readonly type: "object";
+                                                            readonly required: readonly ["id", "logo"];
+                                                            readonly properties: {
+                                                                readonly id: {
+                                                                    readonly type: "string";
+                                                                };
+                                                                readonly logo: {
+                                                                    readonly "x-go-type": "Logo";
+                                                                    readonly type: "object";
+                                                                    readonly required: readonly ["desktop_view", "mobile_view", "dark_desktop_view", "dark_mobile_view"];
+                                                                    readonly properties: {
+                                                                        readonly desktop_view: {
+                                                                            readonly "x-go-type": "Location";
+                                                                            readonly type: "object";
+                                                                            readonly required: readonly ["svg", "location"];
+                                                                            readonly properties: {
+                                                                                readonly svg: {
+                                                                                    readonly type: "string";
+                                                                                };
+                                                                                readonly location: {
+                                                                                    readonly type: "string";
+                                                                                };
+                                                                            };
+                                                                        };
+                                                                        readonly mobile_view: {
+                                                                            readonly "x-go-type": "Location";
+                                                                            readonly type: "object";
+                                                                            readonly required: readonly ["svg", "location"];
+                                                                            readonly properties: {
+                                                                                readonly svg: {
+                                                                                    readonly type: "string";
+                                                                                };
+                                                                                readonly location: {
+                                                                                    readonly type: "string";
+                                                                                };
+                                                                            };
+                                                                        };
+                                                                        readonly dark_desktop_view: {
+                                                                            readonly "x-go-type": "Location";
+                                                                            readonly type: "object";
+                                                                            readonly required: readonly ["svg", "location"];
+                                                                            readonly properties: {
+                                                                                readonly svg: {
+                                                                                    readonly type: "string";
+                                                                                };
+                                                                                readonly location: {
+                                                                                    readonly type: "string";
+                                                                                };
+                                                                            };
+                                                                        };
+                                                                        readonly dark_mobile_view: {
+                                                                            readonly "x-go-type": "Location";
+                                                                            readonly type: "object";
+                                                                            readonly required: readonly ["svg", "location"];
+                                                                            readonly properties: {
+                                                                                readonly svg: {
+                                                                                    readonly type: "string";
+                                                                                };
+                                                                                readonly location: {
+                                                                                    readonly type: "string";
+                                                                                };
+                                                                            };
+                                                                        };
+                                                                    };
+                                                                };
+                                                                readonly vars: {
+                                                                    readonly type: "object";
+                                                                    readonly additionalProperties: true;
+                                                                };
+                                                            };
+                                                        };
+                                                        readonly dashboard: {
+                                                            readonly "x-go-type": "DashboardPrefs";
+                                                            readonly type: "object";
+                                                            readonly description: "Preferences specific to dashboard behavior";
+                                                            readonly additionalProperties: true;
+                                                        };
+                                                    };
+                                                };
+                                            };
+                                        };
+                                        readonly created_at: {
+                                            readonly "x-oapi-codegen-extra-tags": {
+                                                readonly db: "created_at";
+                                            };
+                                            readonly type: "string";
+                                            readonly format: "date-time";
+                                            readonly "x-go-type-skip-optional-pointer": true;
+                                        };
+                                        readonly updated_at: {
+                                            readonly "x-oapi-codegen-extra-tags": {
+                                                readonly db: "updated_at";
+                                            };
+                                            readonly type: "string";
+                                            readonly format: "date-time";
+                                            readonly "x-go-type-skip-optional-pointer": true;
+                                        };
+                                        readonly deleted_at: {
+                                            readonly "x-oapi-codegen-extra-tags": {
+                                                readonly db: "deleted_at";
+                                            };
+                                            readonly type: "string";
+                                            readonly format: "date-time";
+                                            readonly "x-go-type": "sql.NullTime";
+                                            readonly "x-go-type-import": {
+                                                readonly path: "database/sql";
+                                            };
+                                            readonly "x-go-type-skip-optional-pointer": true;
+                                        };
+                                        readonly domain: {
+                                            readonly type: "string";
+                                            readonly nullable: true;
+                                            readonly "x-oapi-codegen-extra-tags": {
+                                                readonly db: "domain";
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    readonly "404": {
+                        readonly description: "Organization not found";
+                    };
+                    readonly "500": {
+                        readonly description: "Internal server error";
+                    };
+                };
+            };
+        };
+    };
+    readonly components: {
+        readonly schemas: {
+            readonly UUID: {
+                readonly type: "string";
+                readonly format: "uuid";
+                readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
+                readonly "x-go-type": "uuid.UUID";
+                readonly "x-go-type-import": {
+                    readonly path: "github.com/gofrs/uuid";
+                };
+            };
+            readonly NullableTime: {
+                readonly type: "string";
+                readonly format: "date-time";
+                readonly "x-go-type": "sql.NullTime";
+                readonly "x-go-type-import": {
+                    readonly path: "database/sql";
+                };
+                readonly "x-go-type-skip-optional-pointer": true;
+            };
+            readonly Time: {
+                readonly type: "string";
+                readonly format: "date-time";
+                readonly "x-go-type-skip-optional-pointer": true;
+            };
+            readonly Location: {
+                readonly type: "object";
+                readonly required: readonly ["svg", "location"];
+                readonly properties: {
+                    readonly svg: {
+                        readonly type: "string";
+                    };
+                    readonly location: {
+                        readonly type: "string";
+                    };
+                };
+            };
+            readonly Logo: {
+                readonly type: "object";
+                readonly required: readonly ["desktop_view", "mobile_view", "dark_desktop_view", "dark_mobile_view"];
+                readonly properties: {
+                    readonly desktop_view: {
+                        readonly "x-go-type": "Location";
+                        readonly type: "object";
+                        readonly required: readonly ["svg", "location"];
+                        readonly properties: {
+                            readonly svg: {
+                                readonly type: "string";
+                            };
+                            readonly location: {
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                    readonly mobile_view: {
+                        readonly "x-go-type": "Location";
+                        readonly type: "object";
+                        readonly required: readonly ["svg", "location"];
+                        readonly properties: {
+                            readonly svg: {
+                                readonly type: "string";
+                            };
+                            readonly location: {
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                    readonly dark_desktop_view: {
+                        readonly "x-go-type": "Location";
+                        readonly type: "object";
+                        readonly required: readonly ["svg", "location"];
+                        readonly properties: {
+                            readonly svg: {
+                                readonly type: "string";
+                            };
+                            readonly location: {
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                    readonly dark_mobile_view: {
+                        readonly "x-go-type": "Location";
+                        readonly type: "object";
+                        readonly required: readonly ["svg", "location"];
+                        readonly properties: {
+                            readonly svg: {
+                                readonly type: "string";
+                            };
+                            readonly location: {
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                };
+            };
+            readonly Theme: {
+                readonly type: "object";
+                readonly required: readonly ["id", "logo"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                    };
+                    readonly logo: {
+                        readonly "x-go-type": "Logo";
+                        readonly type: "object";
+                        readonly required: readonly ["desktop_view", "mobile_view", "dark_desktop_view", "dark_mobile_view"];
+                        readonly properties: {
+                            readonly desktop_view: {
+                                readonly "x-go-type": "Location";
+                                readonly type: "object";
+                                readonly required: readonly ["svg", "location"];
+                                readonly properties: {
+                                    readonly svg: {
+                                        readonly type: "string";
+                                    };
+                                    readonly location: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                            readonly mobile_view: {
+                                readonly "x-go-type": "Location";
+                                readonly type: "object";
+                                readonly required: readonly ["svg", "location"];
+                                readonly properties: {
+                                    readonly svg: {
+                                        readonly type: "string";
+                                    };
+                                    readonly location: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                            readonly dark_desktop_view: {
+                                readonly "x-go-type": "Location";
+                                readonly type: "object";
+                                readonly required: readonly ["svg", "location"];
+                                readonly properties: {
+                                    readonly svg: {
+                                        readonly type: "string";
+                                    };
+                                    readonly location: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                            readonly dark_mobile_view: {
+                                readonly "x-go-type": "Location";
+                                readonly type: "object";
+                                readonly required: readonly ["svg", "location"];
+                                readonly properties: {
+                                    readonly svg: {
+                                        readonly type: "string";
+                                    };
+                                    readonly location: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    readonly vars: {
+                        readonly type: "object";
+                        readonly additionalProperties: true;
+                    };
+                };
+            };
+            readonly DashboardPrefs: {
+                readonly type: "object";
+                readonly description: "Preferences specific to dashboard behavior";
+                readonly additionalProperties: true;
+            };
+            readonly Preferences: {
+                readonly type: "object";
+                readonly required: readonly ["theme", "dashboard"];
+                readonly properties: {
+                    readonly theme: {
+                        readonly "x-go-type": "Theme";
+                        readonly type: "object";
+                        readonly required: readonly ["id", "logo"];
+                        readonly properties: {
+                            readonly id: {
+                                readonly type: "string";
+                            };
+                            readonly logo: {
+                                readonly "x-go-type": "Logo";
+                                readonly type: "object";
+                                readonly required: readonly ["desktop_view", "mobile_view", "dark_desktop_view", "dark_mobile_view"];
+                                readonly properties: {
+                                    readonly desktop_view: {
+                                        readonly "x-go-type": "Location";
+                                        readonly type: "object";
+                                        readonly required: readonly ["svg", "location"];
+                                        readonly properties: {
+                                            readonly svg: {
+                                                readonly type: "string";
+                                            };
+                                            readonly location: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly mobile_view: {
+                                        readonly "x-go-type": "Location";
+                                        readonly type: "object";
+                                        readonly required: readonly ["svg", "location"];
+                                        readonly properties: {
+                                            readonly svg: {
+                                                readonly type: "string";
+                                            };
+                                            readonly location: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly dark_desktop_view: {
+                                        readonly "x-go-type": "Location";
+                                        readonly type: "object";
+                                        readonly required: readonly ["svg", "location"];
+                                        readonly properties: {
+                                            readonly svg: {
+                                                readonly type: "string";
+                                            };
+                                            readonly location: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly dark_mobile_view: {
+                                        readonly "x-go-type": "Location";
+                                        readonly type: "object";
+                                        readonly required: readonly ["svg", "location"];
+                                        readonly properties: {
+                                            readonly svg: {
+                                                readonly type: "string";
+                                            };
+                                            readonly location: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                            readonly vars: {
+                                readonly type: "object";
+                                readonly additionalProperties: true;
+                            };
+                        };
+                    };
+                    readonly dashboard: {
+                        readonly "x-go-type": "DashboardPrefs";
+                        readonly type: "object";
+                        readonly description: "Preferences specific to dashboard behavior";
+                        readonly additionalProperties: true;
+                    };
+                };
+            };
+            readonly OrgMetadata: {
+                readonly type: "object";
+                readonly required: readonly ["preferences"];
+                readonly properties: {
+                    readonly preferences: {
+                        readonly "x-go-type": "Preferences";
+                        readonly type: "object";
+                        readonly required: readonly ["theme", "dashboard"];
+                        readonly properties: {
+                            readonly theme: {
+                                readonly "x-go-type": "Theme";
+                                readonly type: "object";
+                                readonly required: readonly ["id", "logo"];
+                                readonly properties: {
+                                    readonly id: {
+                                        readonly type: "string";
+                                    };
+                                    readonly logo: {
+                                        readonly "x-go-type": "Logo";
+                                        readonly type: "object";
+                                        readonly required: readonly ["desktop_view", "mobile_view", "dark_desktop_view", "dark_mobile_view"];
+                                        readonly properties: {
+                                            readonly desktop_view: {
+                                                readonly "x-go-type": "Location";
+                                                readonly type: "object";
+                                                readonly required: readonly ["svg", "location"];
+                                                readonly properties: {
+                                                    readonly svg: {
+                                                        readonly type: "string";
+                                                    };
+                                                    readonly location: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly mobile_view: {
+                                                readonly "x-go-type": "Location";
+                                                readonly type: "object";
+                                                readonly required: readonly ["svg", "location"];
+                                                readonly properties: {
+                                                    readonly svg: {
+                                                        readonly type: "string";
+                                                    };
+                                                    readonly location: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly dark_desktop_view: {
+                                                readonly "x-go-type": "Location";
+                                                readonly type: "object";
+                                                readonly required: readonly ["svg", "location"];
+                                                readonly properties: {
+                                                    readonly svg: {
+                                                        readonly type: "string";
+                                                    };
+                                                    readonly location: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly dark_mobile_view: {
+                                                readonly "x-go-type": "Location";
+                                                readonly type: "object";
+                                                readonly required: readonly ["svg", "location"];
+                                                readonly properties: {
+                                                    readonly svg: {
+                                                        readonly type: "string";
+                                                    };
+                                                    readonly location: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                        };
+                                    };
+                                    readonly vars: {
+                                        readonly type: "object";
+                                        readonly additionalProperties: true;
+                                    };
+                                };
+                            };
+                            readonly dashboard: {
+                                readonly "x-go-type": "DashboardPrefs";
+                                readonly type: "object";
+                                readonly description: "Preferences specific to dashboard behavior";
+                                readonly additionalProperties: true;
+                            };
+                        };
+                    };
+                };
+            };
+            readonly Organization: {
+                readonly type: "object";
+                readonly required: readonly ["id", "name", "country", "region", "description", "owner", "metadata", "created_at", "updated_at"];
+                readonly properties: {
+                    readonly id: {
+                        readonly "x-oapi-codegen-extra-tags": {
+                            readonly db: "id";
+                        };
+                        readonly type: "string";
+                        readonly format: "uuid";
+                        readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
+                        readonly "x-go-type": "uuid.UUID";
+                        readonly "x-go-type-import": {
+                            readonly path: "github.com/gofrs/uuid";
+                        };
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                        readonly "x-oapi-codegen-extra-tags": {
+                            readonly db: "name";
+                        };
+                    };
+                    readonly country: {
+                        readonly type: "string";
+                        readonly "x-oapi-codegen-extra-tags": {
+                            readonly db: "country";
+                        };
+                    };
+                    readonly region: {
+                        readonly type: "string";
+                        readonly "x-oapi-codegen-extra-tags": {
+                            readonly db: "region";
+                        };
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly "x-oapi-codegen-extra-tags": {
+                            readonly db: "description";
+                        };
+                    };
+                    readonly owner: {
+                        readonly "x-oapi-codegen-extra-tags": {
+                            readonly db: "owner";
+                        };
+                        readonly type: "string";
+                        readonly format: "uuid";
+                        readonly description: "A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.";
+                        readonly "x-go-type": "uuid.UUID";
+                        readonly "x-go-type-import": {
+                            readonly path: "github.com/gofrs/uuid";
+                        };
+                    };
+                    readonly metadata: {
+                        readonly "x-go-type": "OrgMetadata";
+                        readonly "x-oapi-codegen-extra-tags": {
+                            readonly db: "metadata";
+                        };
+                        readonly type: "object";
+                        readonly required: readonly ["preferences"];
+                        readonly properties: {
+                            readonly preferences: {
+                                readonly "x-go-type": "Preferences";
+                                readonly type: "object";
+                                readonly required: readonly ["theme", "dashboard"];
+                                readonly properties: {
+                                    readonly theme: {
+                                        readonly "x-go-type": "Theme";
+                                        readonly type: "object";
+                                        readonly required: readonly ["id", "logo"];
+                                        readonly properties: {
+                                            readonly id: {
+                                                readonly type: "string";
+                                            };
+                                            readonly logo: {
+                                                readonly "x-go-type": "Logo";
+                                                readonly type: "object";
+                                                readonly required: readonly ["desktop_view", "mobile_view", "dark_desktop_view", "dark_mobile_view"];
+                                                readonly properties: {
+                                                    readonly desktop_view: {
+                                                        readonly "x-go-type": "Location";
+                                                        readonly type: "object";
+                                                        readonly required: readonly ["svg", "location"];
+                                                        readonly properties: {
+                                                            readonly svg: {
+                                                                readonly type: "string";
+                                                            };
+                                                            readonly location: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly mobile_view: {
+                                                        readonly "x-go-type": "Location";
+                                                        readonly type: "object";
+                                                        readonly required: readonly ["svg", "location"];
+                                                        readonly properties: {
+                                                            readonly svg: {
+                                                                readonly type: "string";
+                                                            };
+                                                            readonly location: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly dark_desktop_view: {
+                                                        readonly "x-go-type": "Location";
+                                                        readonly type: "object";
+                                                        readonly required: readonly ["svg", "location"];
+                                                        readonly properties: {
+                                                            readonly svg: {
+                                                                readonly type: "string";
+                                                            };
+                                                            readonly location: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly dark_mobile_view: {
+                                                        readonly "x-go-type": "Location";
+                                                        readonly type: "object";
+                                                        readonly required: readonly ["svg", "location"];
+                                                        readonly properties: {
+                                                            readonly svg: {
+                                                                readonly type: "string";
+                                                            };
+                                                            readonly location: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                    };
+                                                };
+                                            };
+                                            readonly vars: {
+                                                readonly type: "object";
+                                                readonly additionalProperties: true;
+                                            };
+                                        };
+                                    };
+                                    readonly dashboard: {
+                                        readonly "x-go-type": "DashboardPrefs";
+                                        readonly type: "object";
+                                        readonly description: "Preferences specific to dashboard behavior";
+                                        readonly additionalProperties: true;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    readonly created_at: {
+                        readonly "x-oapi-codegen-extra-tags": {
+                            readonly db: "created_at";
+                        };
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly "x-go-type-skip-optional-pointer": true;
+                    };
+                    readonly updated_at: {
+                        readonly "x-oapi-codegen-extra-tags": {
+                            readonly db: "updated_at";
+                        };
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly "x-go-type-skip-optional-pointer": true;
+                    };
+                    readonly deleted_at: {
+                        readonly "x-oapi-codegen-extra-tags": {
+                            readonly db: "deleted_at";
+                        };
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly "x-go-type": "sql.NullTime";
+                        readonly "x-go-type-import": {
+                            readonly path: "database/sql";
+                        };
+                        readonly "x-go-type-skip-optional-pointer": true;
+                    };
+                    readonly domain: {
+                        readonly type: "string";
+                        readonly nullable: true;
+                        readonly "x-oapi-codegen-extra-tags": {
+                            readonly db: "domain";
+                        };
+                    };
+                };
+            };
+        };
+    };
+};
+
+export { OrganizationSchema as default };