@meshery/schemas 1.3.60 → 1.3.61

package/dist/constructs/v1beta3/blowhorn_content/BlowhornContent.d.ts

@@ -0,0 +1,719 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/api/blowhorn/content": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List Blowhorn content
+         * @description Returns a paginated list of Blowhorn content rows in the organization of the authenticated session.
+         */
+        get: operations["listBlowhornContent"];
+        put?: never;
+        /**
+         * Insert Blowhorn content
+         * @description Inserts a new Blowhorn content row. Insert-only: any supplied
+         *     `id` and `expectedFingerprint` are ignored; existing rows change
+         *     only through the conditional `updateBlowhornContent`. The
+         *     `fingerprint` is server-computed.
+         */
+        post: operations["insertBlowhornContent"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/blowhorn/content/{blowhornContentId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get Blowhorn content by ID */
+        get: operations["getBlowhornContent"];
+        /**
+         * Update Blowhorn content
+         * @description Conditionally updates the Blowhorn content row. When
+         *     `expectedFingerprint` is supplied and stale, the update is
+         *     refused with a 409.
+         */
+        put: operations["updateBlowhornContent"];
+        post?: never;
+        /**
+         * Delete Blowhorn content
+         * @description Soft-deletes the Blowhorn content row.
+         */
+        delete: operations["deleteBlowhornContent"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /**
+         * Blowhorn Content Schema
+         * @description Server-returned Blowhorn content row as persisted by meshery-cloud.
+         *     Content rows carry a row number and a server-computed fingerprint over
+         *     their canonical values; updates are conditional on the fingerprint the
+         *     writer read, so stale writes are refused rather than silently applied.
+         */
+        BlowhornContent: {
+            /**
+             * Format: uuid
+             * @description Server-generated Blowhorn content ID.
+             */
+            id: string;
+            /**
+             * Format: uuid
+             * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+             */
+            organizationId: string;
+            /** @description Subject of the owning Blowhorn profile. */
+            profile: string;
+            /** @description Row number of the content within the owning profile. */
+            rowNumber: number;
+            /** @description Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates. */
+            fingerprint: string;
+            /** @description Content values, stored as a JSON blob. */
+            data?: Record<string, never>;
+            /**
+             * Format: date-time
+             * @description Timestamp of Blowhorn content creation.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp of last Blowhorn content modification.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the Blowhorn content was soft-deleted.
+             */
+            deletedAt?: string | null;
+        };
+        /**
+         * @description Payload for inserting or updating a Blowhorn content row.
+         *     Contains only client-settable fields; the owning
+         *     `organizationId` (derived from the authenticated session), the
+         *     server-computed `fingerprint` and the server-generated
+         *     `createdAt` / `updatedAt` timestamps are intentionally excluded.
+         */
+        BlowhornContentPayload: {
+            /**
+             * Format: uuid
+             * @description Existing Blowhorn content ID for updates; ignored on insert.
+             */
+            id?: string;
+            /** @description Subject of the owning Blowhorn profile. */
+            profile: string;
+            /** @description Row number of the content within the owning profile. */
+            rowNumber: number;
+            /** @description Content values, stored as a JSON blob. */
+            data?: Record<string, never>;
+            /**
+             * @description Optimistic-concurrency precondition for update: when supplied,
+             *     the update applies only when the stored fingerprint still
+             *     matches, and is refused with a 409 otherwise. Ignored on
+             *     insert.
+             */
+            expectedFingerprint?: string;
+        };
+        /** @description Paginated collection of Blowhorn content rows. */
+        BlowhornContentPage: {
+            /** @description Current page number of the result set. */
+            page?: number;
+            /** @description Number of items per page. */
+            pageSize?: number;
+            /** @description Total number of items available. */
+            totalCount?: number;
+            /** @description Blowhorn content rows included on this page of results. */
+            blowhornContent?: {
+                /**
+                 * Format: uuid
+                 * @description Server-generated Blowhorn content ID.
+                 */
+                id: string;
+                /**
+                 * Format: uuid
+                 * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                 */
+                organizationId: string;
+                /** @description Subject of the owning Blowhorn profile. */
+                profile: string;
+                /** @description Row number of the content within the owning profile. */
+                rowNumber: number;
+                /** @description Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates. */
+                fingerprint: string;
+                /** @description Content values, stored as a JSON blob. */
+                data?: Record<string, never>;
+                /**
+                 * Format: date-time
+                 * @description Timestamp of Blowhorn content creation.
+                 */
+                createdAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp of last Blowhorn content modification.
+                 */
+                updatedAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the Blowhorn content was soft-deleted.
+                 */
+                deletedAt?: string | null;
+            }[];
+        };
+    };
+    responses: {
+        /** @description Invalid request body or request param */
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Expired JWT token used or insufficient privilege */
+        401: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Result not found */
+        404: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint */
+        409: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** @description Internal server error */
+        500: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "text/plain": string;
+            };
+        };
+    };
+    parameters: {
+        /** @description Blowhorn content ID */
+        blowhornContentId: string;
+        /** @description Get responses by page */
+        page: number;
+        /** @description Number of items per page (canonical camelCase form). */
+        pageSize: number;
+        /**
+         * @deprecated
+         * @description Number of items per page. Deprecated alias of pageSize;
+         *     canonical `pageSize` wins when both are present.
+         */
+        pagesize: number;
+        /** @description Get responses that match search param value */
+        search: string;
+        /** @description Get ordered responses */
+        order: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    listBlowhornContent: {
+        parameters: {
+            query?: {
+                /** @description Get responses by page */
+                page?: number;
+                /** @description Number of items per page (canonical camelCase form). */
+                pageSize?: number;
+                /**
+                 * @deprecated
+                 * @description Number of items per page. Deprecated alias of pageSize;
+                 *     canonical `pageSize` wins when both are present.
+                 */
+                pagesize?: number;
+                /** @description Get responses that match search param value */
+                search?: string;
+                /** @description Get ordered responses */
+                order?: string;
+                /** @description Filter by owning profile subject. */
+                profile?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Blowhorn content page */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Current page number of the result set. */
+                        page?: number;
+                        /** @description Number of items per page. */
+                        pageSize?: number;
+                        /** @description Total number of items available. */
+                        totalCount?: number;
+                        /** @description Blowhorn content rows included on this page of results. */
+                        blowhornContent?: {
+                            /**
+                             * Format: uuid
+                             * @description Server-generated Blowhorn content ID.
+                             */
+                            id: string;
+                            /**
+                             * Format: uuid
+                             * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                             */
+                            organizationId: string;
+                            /** @description Subject of the owning Blowhorn profile. */
+                            profile: string;
+                            /** @description Row number of the content within the owning profile. */
+                            rowNumber: number;
+                            /** @description Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates. */
+                            fingerprint: string;
+                            /** @description Content values, stored as a JSON blob. */
+                            data?: Record<string, never>;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp of Blowhorn content creation.
+                             */
+                            createdAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp of last Blowhorn content modification.
+                             */
+                            updatedAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the Blowhorn content was soft-deleted.
+                             */
+                            deletedAt?: string | null;
+                        }[];
+                    };
+                };
+            };
+            /** @description Expired JWT token used or insufficient privilege */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    insertBlowhornContent: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: uuid
+                     * @description Existing Blowhorn content ID for updates; ignored on insert.
+                     */
+                    id?: string;
+                    /** @description Subject of the owning Blowhorn profile. */
+                    profile: string;
+                    /** @description Row number of the content within the owning profile. */
+                    rowNumber: number;
+                    /** @description Content values, stored as a JSON blob. */
+                    data?: Record<string, never>;
+                    /**
+                     * @description Optimistic-concurrency precondition for update: when supplied,
+                     *     the update applies only when the stored fingerprint still
+                     *     matches, and is refused with a 409 otherwise. Ignored on
+                     *     insert.
+                     */
+                    expectedFingerprint?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Blowhorn content created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Server-generated Blowhorn content ID.
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                         */
+                        organizationId: string;
+                        /** @description Subject of the owning Blowhorn profile. */
+                        profile: string;
+                        /** @description Row number of the content within the owning profile. */
+                        rowNumber: number;
+                        /** @description Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates. */
+                        fingerprint: string;
+                        /** @description Content values, stored as a JSON blob. */
+                        data?: Record<string, never>;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of Blowhorn content creation.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of last Blowhorn content modification.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the Blowhorn content was soft-deleted.
+                         */
+                        deletedAt?: string | null;
+                    };
+                };
+            };
+            /** @description Invalid request body or request param */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Expired JWT token used or insufficient privilege */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    getBlowhornContent: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Blowhorn content ID */
+                blowhornContentId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Blowhorn content response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Server-generated Blowhorn content ID.
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                         */
+                        organizationId: string;
+                        /** @description Subject of the owning Blowhorn profile. */
+                        profile: string;
+                        /** @description Row number of the content within the owning profile. */
+                        rowNumber: number;
+                        /** @description Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates. */
+                        fingerprint: string;
+                        /** @description Content values, stored as a JSON blob. */
+                        data?: Record<string, never>;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of Blowhorn content creation.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of last Blowhorn content modification.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the Blowhorn content was soft-deleted.
+                         */
+                        deletedAt?: string | null;
+                    };
+                };
+            };
+            /** @description Invalid request body or request param */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Expired JWT token used or insufficient privilege */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Result not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    updateBlowhornContent: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Blowhorn content ID */
+                blowhornContentId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: uuid
+                     * @description Existing Blowhorn content ID for updates; ignored on insert.
+                     */
+                    id?: string;
+                    /** @description Subject of the owning Blowhorn profile. */
+                    profile: string;
+                    /** @description Row number of the content within the owning profile. */
+                    rowNumber: number;
+                    /** @description Content values, stored as a JSON blob. */
+                    data?: Record<string, never>;
+                    /**
+                     * @description Optimistic-concurrency precondition for update: when supplied,
+                     *     the update applies only when the stored fingerprint still
+                     *     matches, and is refused with a 409 otherwise. Ignored on
+                     *     insert.
+                     */
+                    expectedFingerprint?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Blowhorn content updated */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Server-generated Blowhorn content ID.
+                         */
+                        id: string;
+                        /**
+                         * Format: uuid
+                         * @description Owning organization ID. Derived from the authenticated session, never client-settable.
+                         */
+                        organizationId: string;
+                        /** @description Subject of the owning Blowhorn profile. */
+                        profile: string;
+                        /** @description Row number of the content within the owning profile. */
+                        rowNumber: number;
+                        /** @description Hex digest over the canonical content values, typed so null, empty string, zero and false differ. Server-computed; used for conditional updates. */
+                        fingerprint: string;
+                        /** @description Content values, stored as a JSON blob. */
+                        data?: Record<string, never>;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of Blowhorn content creation.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of last Blowhorn content modification.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the Blowhorn content was soft-deleted.
+                         */
+                        deletedAt?: string | null;
+                    };
+                };
+            };
+            /** @description Invalid request body or request param */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Expired JWT token used or insufficient privilege */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Result not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Conflict - the stale expectedFingerprint precondition no longer matches the stored content fingerprint */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    deleteBlowhornContent: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Blowhorn content ID */
+                blowhornContentId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Blowhorn content deleted */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Expired JWT token used or insufficient privilege */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Result not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+}