@hideyukimori/nene2-client 0.1.0 → 0.1.2

package/dist/generated/openapi.d.ts

@@ -0,0 +1,877 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Framework smoke endpoint
+         * @description Returns a minimal JSON response that confirms the NENE2 public entry point is working.
+         */
+        get: operations["getFrameworkSmoke"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/health": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Health endpoint
+         * @description Returns a JSON response for operational health checks. When no health checks are configured the response is always 200. When health checks are configured the response includes a `checks` map; if any check fails the status is `degraded` and the HTTP status code is 503.
+         */
+        get: operations["getHealth"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/machine/health": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Protected machine health endpoint
+         * @description Returns health information for machine clients that provide a configured API key.
+         */
+        get: operations["getMachineHealth"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/examples/protected": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Protected example endpoint
+         * @description Demonstrates BearerTokenMiddleware. Returns the authenticated user's JWT claims. Requires NENE2_LOCAL_JWT_SECRET to be set in the environment.
+         */
+        get: operations["getProtected"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/examples/tags": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List example tags
+         * @description Returns a paginated list of tags. Demonstrates the collection endpoint pattern for a second domain entity.
+         */
+        get: operations["listExampleTags"];
+        put?: never;
+        /**
+         * Create example tag
+         * @description Creates a new tag. Demonstrates the POST write path for a second domain entity.
+         */
+        post: operations["createExampleTag"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/examples/tags/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get example tag by ID
+         * @description Returns a single tag by ID. Returns 404 when the tag does not exist.
+         */
+        get: operations["getExampleTagById"];
+        /**
+         * Update example tag
+         * @description Updates a tag by ID. Replaces the name. Returns 200 with the updated tag on success.
+         */
+        put: operations["updateExampleTagById"];
+        post?: never;
+        /**
+         * Delete example tag
+         * @description Deletes a tag by ID. Returns 204 on success, 404 if the tag does not exist.
+         */
+        delete: operations["deleteExampleTagById"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/examples/notes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List example notes
+         * @description Returns a paginated list of notes. Demonstrates the collection endpoint pattern with limit/offset query parameters.
+         */
+        get: operations["listExampleNotes"];
+        put?: never;
+        /**
+         * Create example note
+         * @description Creates a new note. Demonstrates the POST → UseCase → Repository write path with body validation.
+         */
+        post: operations["createExampleNote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/examples/notes/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Example note endpoint
+         * @description Returns a single note by id. Demonstrates the UseCase → Repository → Handler domain layer pattern.
+         */
+        get: operations["getExampleNoteById"];
+        /**
+         * Update example note
+         * @description Updates a note by id. Replaces title and body. Returns 200 with the updated note on success.
+         */
+        put: operations["updateExampleNoteById"];
+        post?: never;
+        /**
+         * Delete example note
+         * @description Deletes a note by id. Returns 204 on success, 404 if the note does not exist.
+         */
+        delete: operations["deleteExampleNoteById"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/examples/ping": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Example ping endpoint
+         * @description Returns a minimal response used to exercise the endpoint scaffold workflow.
+         */
+        get: operations["getExamplePing"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** @description RFC 9457 Problem Details response for NENE2 JSON APIs. */
+        ProblemDetails: {
+            /**
+             * Format: uri
+             * @description Stable problem type URI.
+             * @example https://nene2.dev/problems/not-found
+             */
+            type: string;
+            /**
+             * @description Short, human-readable summary of the problem type.
+             * @example Not Found
+             */
+            title: string;
+            /**
+             * Format: int32
+             * @description HTTP status code for this occurrence.
+             * @example 404
+             */
+            status: number;
+            /**
+             * @description Safe, human-readable detail for this occurrence.
+             * @example The requested resource was not found.
+             */
+            detail?: string;
+            /**
+             * @description Request-specific URI or identifier for this occurrence.
+             * @example /missing
+             */
+            instance?: string;
+        } & {
+            [key: string]: unknown;
+        };
+        ValidationProblemDetails: components["schemas"]["ProblemDetails"] & {
+            errors: components["schemas"]["ValidationError"][];
+        };
+        /** @description A single request validation error. */
+        ValidationError: {
+            /**
+             * @description Field name, parameter name, or JSON pointer.
+             * @example email
+             */
+            field: string;
+            /**
+             * @description Safe, human-readable validation message.
+             * @example Email must be a valid email address.
+             */
+            message: string;
+            /**
+             * @description Stable machine-readable validation code.
+             * @example invalid_email
+             */
+            code: string;
+        };
+        FrameworkSmokeResponse: {
+            /** @example NENE2 */
+            name: string;
+            /** @example JSON APIs first, minimal server HTML, frontend ready, AI-readable. */
+            description: string;
+            /**
+             * @example ok
+             * @enum {string}
+             */
+            status: "ok";
+        };
+        HealthResponse: {
+            /**
+             * @example ok
+             * @enum {string}
+             */
+            status: "ok" | "degraded";
+            /** @example NENE2 */
+            service: string;
+            /**
+             * @description Present only when health checks are configured. Each key is a check name; each value is "ok" or "error".
+             * @example {
+             *       "database": "ok"
+             *     }
+             */
+            checks?: {
+                [key: string]: "ok" | "error";
+            };
+        };
+        MachineHealthResponse: {
+            /**
+             * @example ok
+             * @enum {string}
+             */
+            status: "ok";
+            /** @example NENE2 */
+            service: string;
+            /**
+             * @example api_key
+             * @enum {string}
+             */
+            credential_type: "api_key";
+        };
+        ExamplePingResponse: {
+            /**
+             * @example pong
+             * @enum {string}
+             */
+            message: "pong";
+            /**
+             * @example ok
+             * @enum {string}
+             */
+            status: "ok";
+        };
+        CreateNoteRequest: {
+            /** @example Example Note */
+            title: string;
+            /** @example This is the body of an example note. */
+            body: string;
+        };
+        ExampleNoteResponse: {
+            /**
+             * Format: int64
+             * @example 1
+             */
+            id: number;
+            /** @example Example Note */
+            title: string;
+            /** @example This is the body of an example note. */
+            body: string;
+        };
+        CreateTagRequest: {
+            /** @example php */
+            name: string;
+        };
+        ExampleTagResponse: {
+            /**
+             * Format: int64
+             * @example 1
+             */
+            id: number;
+            /** @example php */
+            name: string;
+        };
+        ExampleTagListResponse: {
+            items: components["schemas"]["ExampleTagResponse"][];
+            /** @example 20 */
+            limit: number;
+            /** @example 0 */
+            offset: number;
+        };
+        ProtectedResponse: {
+            /** @example Welcome, authenticated user. */
+            message: string;
+            /**
+             * @example {
+             *       "sub": "user-42",
+             *       "scope": "read:system"
+             *     }
+             */
+            claims: {
+                [key: string]: unknown;
+            };
+        };
+        ExampleNoteListResponse: {
+            items: components["schemas"]["ExampleNoteResponse"][];
+            /** @example 20 */
+            limit: number;
+            /** @example 0 */
+            offset: number;
+        };
+    };
+    responses: {
+        /** @description Request body is empty, syntactically invalid, or not a JSON object. */
+        InvalidJson: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": components["schemas"]["ProblemDetails"];
+            };
+        };
+        /** @description Rate limit exceeded. */
+        TooManyRequests: {
+            headers: {
+                /** @description Seconds until the rate limit window resets. */
+                "Retry-After"?: number;
+                /** @description Maximum requests allowed in the current window. */
+                "X-RateLimit-Limit"?: number;
+                /** @description Requests remaining in the current window. */
+                "X-RateLimit-Remaining"?: number;
+                /** @description Unix timestamp when the rate limit window resets. */
+                "X-RateLimit-Reset"?: number;
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": components["schemas"]["ProblemDetails"];
+            };
+        };
+        /** @description A valid API key is required for this endpoint. */
+        Unauthorized: {
+            headers: {
+                /** @description API-key challenge for machine clients. */
+                "WWW-Authenticate"?: string;
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": components["schemas"]["ProblemDetails"];
+            };
+        };
+        /** @description The requested resource was not found. */
+        NotFound: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": components["schemas"]["ProblemDetails"];
+            };
+        };
+        /** @description The requested resource does not support this HTTP method. */
+        MethodNotAllowed: {
+            headers: {
+                /** @description Comma-separated list of allowed HTTP methods. */
+                Allow?: string;
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": components["schemas"]["ProblemDetails"];
+            };
+        };
+        /** @description The request body, query, or path parameters contain invalid values. */
+        ValidationFailed: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": components["schemas"]["ValidationProblemDetails"];
+            };
+        };
+        /** @description The request body exceeds the configured size limit. */
+        PayloadTooLarge: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": components["schemas"]["ProblemDetails"];
+            };
+        };
+        /** @description The server encountered an unexpected condition. */
+        InternalServerError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": components["schemas"]["ProblemDetails"];
+            };
+        };
+    };
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    getFrameworkSmoke: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Framework smoke response. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FrameworkSmokeResponse"];
+                };
+            };
+            413: components["responses"]["PayloadTooLarge"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    getHealth: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description All configured checks passed (or no checks configured). */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HealthResponse"];
+                };
+            };
+            413: components["responses"]["PayloadTooLarge"];
+            500: components["responses"]["InternalServerError"];
+            /** @description One or more health checks failed. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HealthResponse"];
+                };
+            };
+        };
+    };
+    getMachineHealth: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Machine health response. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MachineHealthResponse"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            413: components["responses"]["PayloadTooLarge"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    getProtected: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Authenticated response with JWT claims. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProtectedResponse"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    listExampleTags: {
+        parameters: {
+            query?: {
+                /** @description Maximum number of tags to return (1–100). */
+                limit?: number;
+                /** @description Number of tags to skip before returning results. */
+                offset?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description List of tags. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleTagListResponse"];
+                };
+            };
+            422: components["responses"]["ValidationFailed"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    createExampleTag: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateTagRequest"];
+            };
+        };
+        responses: {
+            /** @description Tag created. */
+            201: {
+                headers: {
+                    /** @description URI of the created tag. */
+                    Location?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleTagResponse"];
+                };
+            };
+            400: components["responses"]["InvalidJson"];
+            413: components["responses"]["PayloadTooLarge"];
+            422: components["responses"]["ValidationFailed"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    getExampleTagById: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Tag ID. */
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Tag found. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleTagResponse"];
+                };
+            };
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    updateExampleTagById: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Tag ID. */
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateTagRequest"];
+            };
+        };
+        responses: {
+            /** @description Tag updated. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleTagResponse"];
+                };
+            };
+            400: components["responses"]["InvalidJson"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["ValidationFailed"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    deleteExampleTagById: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Tag ID. */
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Tag deleted. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    listExampleNotes: {
+        parameters: {
+            query?: {
+                /** @description Maximum number of notes to return (1–100). */
+                limit?: number;
+                /** @description Number of notes to skip before returning results. */
+                offset?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description List of notes. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleNoteListResponse"];
+                };
+            };
+            422: components["responses"]["ValidationFailed"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    createExampleNote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateNoteRequest"];
+            };
+        };
+        responses: {
+            /** @description Note created. */
+            201: {
+                headers: {
+                    /** @description URI of the created note. */
+                    Location?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleNoteResponse"];
+                };
+            };
+            400: components["responses"]["InvalidJson"];
+            413: components["responses"]["PayloadTooLarge"];
+            422: components["responses"]["ValidationFailed"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    getExampleNoteById: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /**
+                 * @description Note id.
+                 * @example 1
+                 */
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Note response. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleNoteResponse"];
+                };
+            };
+            404: components["responses"]["NotFound"];
+            413: components["responses"]["PayloadTooLarge"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    updateExampleNoteById: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /**
+                 * @description Note id.
+                 * @example 1
+                 */
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateNoteRequest"];
+            };
+        };
+        responses: {
+            /** @description Note updated. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExampleNoteResponse"];
+                };
+            };
+            400: components["responses"]["InvalidJson"];
+            404: components["responses"]["NotFound"];
+            413: components["responses"]["PayloadTooLarge"];
+            422: components["responses"]["ValidationFailed"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    deleteExampleNoteById: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /**
+                 * @description Note id.
+                 * @example 1
+                 */
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Note deleted. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    getExamplePing: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Example ping response. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ExamplePingResponse"];
+                };
+            };
+            413: components["responses"]["PayloadTooLarge"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+}
+//# sourceMappingURL=openapi.d.ts.map