/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ /** WithRequired type helpers */ type WithRequired = T & { [P in K]-?: T[P] }; export interface paths { "/v1/me": { /** Get profile information for the current user */ get: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["User"]; }; }; /** @description Unauthorized */ 401: { content: never; }; }; }; }; "/v1/me/likes": { /** Get vals liked by the current user */ get: { parameters: { query?: { offset?: components["parameters"]["offset"]; limit?: components["parameters"]["limit"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ValList"]; }; }; /** @description Unauthorized */ 401: { content: never; }; }; }; }; "/v1/me/comments": { /** Get comments related to current user, either given or received */ get: { parameters: { query?: { offset?: components["parameters"]["offset"]; limit?: components["parameters"]["limit"]; since?: components["parameters"]["comments_since"]; until?: components["parameters"]["comments_until"]; relationship?: components["parameters"]["relationship"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CommentList"]; }; }; /** @description Unauthorized */ 401: { content: never; }; }; }; }; "/v1/me/references": { /** Returns vals that depend on any of the user's vals */ get: { parameters: { query?: { offset?: components["parameters"]["offset"]; limit?: components["parameters"]["limit"]; since?: components["parameters"]["references_since"]; until?: components["parameters"]["references_until"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ReferenceList"]; }; }; /** @description Unauthorized */ 401: { content: never; }; }; }; }; "/v1/vals": { /** Create or update a val by name and code. */ put: { /** @description The JSON to set the val to */ requestBody: { content: { "application/json": { /** @description Name of the val */ name: string; /** @description Code to run for the val */ code: string; }; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BaseVal"]; }; }; /** @description Error */ 400: { content: never; }; /** @description Unauthorized */ 401: { content: never; }; }; }; /** Create a new val */ post: { /** @description Code of the new val to be run. */ requestBody: { content: { "application/json": components["schemas"]["ValInput"]; "text/plain": string; "text/javascript": string; "application/javascript": string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["FullVal"]; }; }; /** @description Unauthorized */ 401: { content: never; }; }; }; }; "/v1/vals/{val_id}": { /** Get val by id */ get: { parameters: { path: { val_id: components["parameters"]["val_id"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["FullVal"]; }; }; /** @description Val not found */ 404: { content: never; }; }; }; /** Update a val's name or privacy */ put: { parameters: { path: { val_id: components["parameters"]["val_id"]; }; }; /** @description Fields to be updated. */ requestBody: { content: { "application/json": components["schemas"]["ValFields"]; }; }; responses: { /** @description No Content */ 204: { content: never; }; /** @description Unauthorized */ 401: { content: never; }; }; }; /** Delete a val */ delete: { parameters: { path: { val_id: components["parameters"]["val_id"]; }; }; responses: { /** @description No Content */ 204: { content: never; }; }; }; }; "/v1/vals/{val_id}/versions": { /** List versions of a val */ get: { parameters: { query?: { offset?: components["parameters"]["offset"]; limit?: components["parameters"]["limit"]; }; path: { val_id: components["parameters"]["val_id"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": ({ data?: ({ /** * Format: uuid * @description Unique identifier for the val. */ val_id?: string; /** @description Version number of the val. */ version?: number; /** * Format: date-time * @deprecated */ runStartAt?: string | null; /** * Format: date-time * @deprecated */ runEndAt?: string | null; })[]; }) & components["schemas"]["PaginatedList"]; }; }; /** @description Val not found */ 404: { content: never; }; }; }; /** Create a new version of a val */ post: { parameters: { path: { val_id: components["parameters"]["val_id"]; }; }; /** @description Code of the new version to be run. */ requestBody: { content: { "application/json": components["schemas"]["ValInput"]; "text/plain": string; "text/javascript": string; "application/javascript": string; }; }; responses: { /** @description Created */ 201: { content: { "application/json": components["schemas"]["FullVal"]; }; }; /** @description Val not found */ 404: { content: never; }; }; }; }; "/v1/vals/{val_id}/versions/{version}": { /** Get a specific version of a val */ get: { parameters: { path: { val_id: components["parameters"]["val_id"]; version: components["parameters"]["version"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["FullVal"]; }; }; /** @description Val or version not found */ 404: { content: never; }; }; }; /** Delete a val version */ delete: { parameters: { path: { val_id: components["parameters"]["val_id"]; version: components["parameters"]["version"]; }; }; responses: { /** @description No Content */ 204: { content: never; }; }; }; }; "/v1/users/{user_id}/vals": { /** List a user's vals */ get: { parameters: { query?: { offset?: components["parameters"]["offset"]; limit?: components["parameters"]["limit"]; }; path: { user_id: components["parameters"]["user_id"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ValList"]; }; }; }; }; }; "/v1/alias/{username}": { /** Get a user profile information by their username */ get: { parameters: { path: { username: components["parameters"]["username"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["User"]; }; }; /** @description Not found */ 404: { content: never; }; }; }; }; "/v1/alias/{username}/{val_name}": { /** Get a val by the author's username and val name */ get: { parameters: { path: { username: components["parameters"]["username"]; val_name: components["parameters"]["val_name"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["FullVal"]; }; }; /** @description Not found */ 404: { content: never; }; }; }; }; "/v1/search/vals": { /** Search for vals across the platform */ get: { parameters: { query: { /** @description Search query */ query: string; offset?: components["parameters"]["offset"]; limit?: components["parameters"]["limit"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ValList"]; }; }; }; }; }; "/v1/eval/{expression}": { /** * Evaluate a JavaScript or TypeScript expression * @description Evaluates the JavaScript or TypeScript `{expression}` and responds with the returned result. * * ### Unauthenticated * Unauthenticated use will have read-only access to public vals. * * ### Authenticated * Authenticated use will have read access to the authenticated user's private vals and secrets, write access to the authenticated user's vals, and the ability to send the authenticated user emails via `console.email`. * * Vals generated via this API will *not* appear in the authenticated user's workspace. */ get: { parameters: { path: { expression: components["parameters"]["expression"]; }; }; responses: { 200: components["responses"]["ExpressionResult"]; /** @description Bad request or Error thrown executing user code */ 400: { content: never; }; /** @description Not found */ 404: { content: never; }; /** @description Internal server error */ 500: { content: never; }; }; }; }; "/v1/eval": { /** * Evaluate a JavaScript or TypeScript expression * @description Evaluates the JavaScript or TypeScript `{expression}` and responds with the returned result. * * ### Unauthenticated * Unauthenticated use will have read-only access to public vals. * * ### Authenticated * Authenticated use will have read access to the authenticated user's private vals and secrets, write access to the authenticated user's vals, and the ability to send the authenticated user emails via `console.email`. * * Vals generated via this API will *not* appear in the authenticated user's workspace. */ post: { /** @description When used as a POST endpoint, the request body must contain the code to be run. */ requestBody: { content: { "application/json": { code: string; args?: components["schemas"]["JSON"][]; }; }; }; responses: { 200: components["responses"]["ExpressionResult"]; /** @description Bad request or Error thrown executing user code */ 400: { content: never; }; /** @description Not found */ 404: { content: never; }; /** @description Internal server error */ 500: { content: never; }; }; }; }; "/v1/sqlite/execute": { /** Execute a SQLite query */ post: { requestBody?: { content: { "application/json": { query: string; }; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; }; "/v1/sqlite/batch": { /** Execute a batch of SQLite queries */ post: { responses: { /** @description OK */ 200: { content: never; }; }; }; }; "/v1/run/{username}.{val_name}": { /** * Run a val as an API * @deprecated * @description This endpoint runs the specified user's val and returns the output. */ get: { parameters: { query?: { /** @description The args query parameter can provide arguments to the given val. The parameter needs to be a JSON-encoded array, in which each item in the array is passed to the val as a function parameter. */ args?: string; }; path: { username: components["parameters"]["username"]; val_name: components["parameters"]["val_name"]; }; }; responses: { 200: components["responses"]["ExpressionResult"]; /** @description Bad request or Error thrown executing user code */ 400: { content: never; }; /** @description Not found */ 404: { content: never; }; /** @description Internal server error */ 500: { content: never; }; }; }; /** * Run a val as an API * @deprecated */ post: { parameters: { path: { username: components["parameters"]["username"]; val_name: components["parameters"]["val_name"]; }; }; /** @description Provide arguments to the given val function by including a post body with your request. */ requestBody?: { content: { "application/json": { args?: components["schemas"]["JSON"][]; }; }; }; responses: { 200: components["responses"]["ExpressionResult"]; /** @description Bad request or Error thrown executing user code */ 400: { content: never; }; /** @description Not found */ 404: { content: never; }; /** @description Internal server error */ 500: { content: never; }; }; }; }; "/": { /** * Run a val as an API (as an Express handler) * @description Runs `@{username}.{val_name}` as an Express handler. * * `@{username}.{val_name}` must be a function. It is passed the Express [`req`](https://expressjs.com/en/4x/api.html#req) and [`res`](https://expressjs.com/en/4x/api.html#res) objects as its arguments. You can use `req` to pull out request data, and `res` to respond with any valid Express response. Learn more at the [Express docs](https://expressjs.com/en/4x/api.html). * * Unlike the other two APIs, the Express API is specified via subdomain and runs at `https://{username}-{val_name}.express.val.run`. * * ### Unauthenticated * Unauthenticated use will only be able to call public vals as Express handlers. * * The val will be executed with `{username}`'s permissions ("API Mode"), so it will be able to read and write to `{username}`'s public and private vals, secrets, and use `console.email`. * * ### Authenticated * Authenticated use is able to call private vals as Express handlers. */ get: { responses: { /** @description Function executed successfully */ 200: { content: { "*/*": string; }; }; /** @description Bad request or Error thrown executing user code */ 400: { content: never; }; /** @description Not found */ 404: { content: never; }; /** @description Internal server error */ 500: { content: never; }; }; }; /** * Run a val as an API (as an Express handler) * @description Runs `@{username}.{val_name}` as an Express handler. * * `@{username}.{val_name}` must be a function. It is passed the Express [`req`](https://expressjs.com/en/4x/api.html#req) and [`res`](https://expressjs.com/en/4x/api.html#res) objects as its arguments. You can use `req` to pull out request data, and `res` to respond with any valid Express response. Learn more at the [Express docs](https://expressjs.com/en/4x/api.html). * * ### Unauthenticated * Unauthenticated use will only be able to call public vals as Express handlers. * * The val will be executed with `{username}`'s permissions ("API Mode"), so it will be able to read and write to `{username}`'s public and private vals, secrets, and use `console.email`. * * ### Authenticated * Authenticated use is able to call private vals as Express handlers. */ post: { /** @description The request body will be accessible to the val Express handler under the first argument, commonly called `req`, as `req.body`. */ requestBody?: { content: { "application/json": components["schemas"]["JSON"]; }; }; responses: { /** @description Function executed successfully */ 200: { content: { "*/*": string; }; }; /** @description Bad request or Error thrown executing user code */ 400: { content: never; }; /** @description Not found */ 404: { content: never; }; /** @description Internal server error */ 500: { content: never; }; }; }; }; } export type webhooks = Record; export interface components { schemas: { /** @description Can be anything: string, number, array, object, etc., including `null` */ JSON: string | number | Record | unknown[] | boolean; /** @enum {string} */ Relationship: "received" | "given" | "any"; /** @enum {string} */ Privacy: "public" | "unlisted" | "private"; Author: { /** * Format: uuid * @description The user's id */ id: string; /** @description The user's username */ username: string; }; User: WithRequired<({ /** @description The user's bio */ bio: string | null; /** @description The url for the user's profile picture */ profileImageUrl: string | null; }) & components["schemas"]["Author"], "bio" | "profileImageUrl">; BaseVal: { /** Format: uuid */ id: string; author: components["schemas"]["Author"]; name: string; code: string; /** @deprecated */ public: boolean; privacy: components["schemas"]["Privacy"]; /** Format: int32 */ version: number; /** * Format: date-time * @deprecated */ runEndAt?: string | null; /** * Format: date-time * @deprecated */ runStartAt?: string | null; }; FullVal: WithRequired<{ logs: unknown[]; output: Record; exported: Record; error: Record; readme: string; likeCount: number; referenceCount: number; } & components["schemas"]["BaseVal"], "logs" | "output" | "exported" | "error" | "readme" | "likeCount" | "referenceCount">; ValFields: { name?: string; privacy?: components["schemas"]["Privacy"]; readme?: string | null; }; ValInput: { code?: string; } & components["schemas"]["ValFields"]; PaginatedList: { data: unknown[]; links: { /** * Format: uri * @description The URL of the current page of results */ self: string; /** * Format: uri * @description The URL of the next page of results */ next?: string; /** * Format: uri * @description The URL of the previous page of results */ prev?: string; }; }; ValList: WithRequired<{ data: components["schemas"]["BaseVal"][]; } & components["schemas"]["PaginatedList"], "data">; BaseValRef: { /** @description The id of the val */ id?: string; /** @description The name of the val */ name?: string; author?: components["schemas"]["Author"]; /** * @deprecated * @description The id of the val's author */ author_id?: string; /** * @deprecated * @description The username of the val's author */ username?: string; }; ValRef: WithRequired<{ /** @deprecated */ public: boolean; privacy: components["schemas"]["Privacy"]; /** Format: int32 */ version: number; } & components["schemas"]["BaseValRef"], "public" | "privacy" | "version">; BaseRun: { /** Format: uuid */ id?: string; error?: unknown; /** Format: uuid */ parentId?: string; /** * Format: date-time * @deprecated */ runEndAt?: string | null; /** * Format: date-time * @deprecated */ runStartAt?: string | null; val?: components["schemas"]["ValRef"]; }; FullRun: { emails?: unknown[]; logs?: unknown[]; returnValue?: unknown; args?: unknown[]; } & components["schemas"]["BaseRun"]; RunList: { data?: components["schemas"]["BaseRun"][]; } & components["schemas"]["PaginatedList"]; Comment: { /** Format: uuid */ id: string; author: components["schemas"]["Author"]; /** @description The contents of the comment */ comment: string; /** Format: date-time */ createdAt: string; val: components["schemas"]["ValRef"]; }; Reference: { /** Format: date-time */ referencedAt: string; reference: components["schemas"]["BaseValRef"]; dependsOn: components["schemas"]["BaseValRef"]; }; CommentList: WithRequired<{ data: components["schemas"]["Comment"][]; } & components["schemas"]["PaginatedList"], "data">; ReferenceList: WithRequired<{ data: components["schemas"]["Reference"][]; } & components["schemas"]["PaginatedList"], "data">; }; responses: { /** @description The returned result of executing the passed expression successfully. The result can be of any JSON type. It will not include any logs that were generated during execution. */ ExpressionResult: { content: { "application/json": string | number | Record | unknown[] | boolean; }; }; }; parameters: { /** * @description The JavaScript or TypeScript expression to be evaluated. * This should be a single expression, like a single function * call, assignment operation, or calculation. If you need * to execute multiple expressions, wrap them in a function. */ expression: string; /** @description id of the user */ user_id: string; /** @description The username of the val owner, *not* including the `@` symbol. */ username: string; /** @description id of the val */ val_id: string; /** @description The name of the val. */ val_name: string; /** @description val version */ version: number; /** @description id of the log */ run_id: string; /** @description Pagination offset */ offset?: number; /** @description Pagination limit */ limit?: number; /** @description Return comments where `createdAt > since` (non-inclusive) */ comments_since?: string; /** @description Return comments where `createdAt <= until` (inclusive) */ comments_until?: string; /** @description Return references where `referencedAt > since` (non-inclusive) */ references_since?: string; /** @description Return references where `referencedAt <= until` (inclusive) */ references_until?: string; relationship?: components["schemas"]["Relationship"]; }; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export type external = Record; export type operations = Record;

openapi_schema

Version 0