This file was auto-generated by openapi-typescript. Do not make direct changes to the file.

interface paths {
    "/authorizations": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        challenge: string;
                        permissions?: (
                            | { permission: "package/publish"; scope: string }
                            | { package: string; permission: "package/publish"; scope: string }
                            | {
                                package: string;
                                permission: "package/publish";
                                scope: string;
                                tarballHash: string;
                                version: string;
                            }
                        )[];
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            code: string;
                            exchangeToken: string;
                            expiresAt: string;
                            pollInterval: number;
                            verificationUrl?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/authorizations/approve/{code}": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { code: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/authorizations/deny/{code}": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { code: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/authorizations/details/{code}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { code: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            code: string;
                            expiresAt: string;
                            permissions: (
                                | { permission: "package/publish"; scope: string }
                                | { package: string; permission: "package/publish"; scope: string }
                                | {
                                    package: string;
                                    permission: "package/publish";
                                    scope: string;
                                    tarballHash: string;
                                    version: string;
                                }
                            )[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/authorizations/exchange": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": { exchangeToken: string; verifier: string };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            token: string;
                            user: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/packages": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: { limit?: number; page?: number; query?: string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            items?: {
                                createdAt: string;
                                description: string;
                                githubRepository?: { name?: ...; owner?: ... };
                                name: string;
                                runtimeCompat?: {
                                    browser?: ...;
                                    bun?: ...;
                                    deno?: ...;
                                    node?: ...;
                                    workerd?: ...;
                                };
                                scope: string;
                                score?: number;
                                updatedAt: string;
                            }[];
                            total?: number;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/publishing_tasks/{id}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            error: null
                            | { code?: string; message?: string };
                            id: string;
                            packageName: string;
                            packageScope: string;
                            packageVersion: string;
                            status:
                                | "pending"
                                | "processing"
                                | "processed"
                                | "success"
                                | "failure";
                            updatedAt: string;
                            userId: never;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/scopes": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: { content: { "application/json": { scope?: string } } };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            creator?: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                            ghActionsVerifyActor?: boolean;
                            quotas?: {
                                newPackagePerWeekLimit?: number;
                                newPackagePerWeekUsage?: number;
                                packageLimit?: number;
                                packageUsage?: number;
                                publishAttemptsPerWeekLimit?: number;
                                publishAttemptsPerWeekUsage?: number;
                            };
                            requirePublishingFromCI?: boolean;
                            scope: string;
                            updatedAt: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/scopes/{scope}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            creator?: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                            ghActionsVerifyActor?: boolean;
                            quotas?: {
                                newPackagePerWeekLimit?: number;
                                newPackagePerWeekUsage?: number;
                                packageLimit?: number;
                                packageUsage?: number;
                                publishAttemptsPerWeekLimit?: number;
                                publishAttemptsPerWeekUsage?: number;
                            };
                            requirePublishingFromCI?: boolean;
                            scope: string;
                            updatedAt: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": | { ghActionsVerifyActor: boolean }
                    | { requirePublishingFromCI: boolean };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            creator?: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                            ghActionsVerifyActor?: boolean;
                            quotas?: {
                                newPackagePerWeekLimit?: number;
                                newPackagePerWeekUsage?: number;
                                packageLimit?: number;
                                packageUsage?: number;
                                publishAttemptsPerWeekLimit?: number;
                                publishAttemptsPerWeekUsage?: number;
                            };
                            requirePublishingFromCI?: boolean;
                            scope: string;
                            updatedAt: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/scopes/{scope}/invites": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            inviter: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                            scope: string;
                            targetUser: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                            updatedAt: string;
                        }[];
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/scopes/{scope}/invites/{userId}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string; userId: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/scopes/{scope}/members": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            isAdmin: boolean;
                            scope: string;
                            updatedAt: string;
                            user: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                        }[];
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string };
                query?: undefined;
            };
            requestBody: { content: { "application/json": { githubLogin: string } } };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            inviter: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                            scope: string;
                            targetUser: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                            updatedAt: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/scopes/{scope}/members/{userId}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string; userId: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string; userId: string };
                query?: undefined;
            };
            requestBody: { content: { "application/json": { isAdmin: boolean } } };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            isAdmin: boolean;
                            scope: string;
                            updatedAt: string;
                            user: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/scopes/{scope}/packages": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string };
                query?: { limit?: number; page?: number };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            items?: {
                                createdAt: string;
                                description: string;
                                githubRepository?: { name?: ...; owner?: ... };
                                name: string;
                                runtimeCompat?: {
                                    browser?: ...;
                                    bun?: ...;
                                    deno?: ...;
                                    node?: ...;
                                    workerd?: ...;
                                };
                                scope: string;
                                score?: number;
                                updatedAt: string;
                            }[];
                            total?: number;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string };
                query?: undefined;
            };
            requestBody: { content: { "application/json": { package: string } } };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            description: string;
                            githubRepository?: { name?: string; owner?: string };
                            name: string;
                            runtimeCompat?: {
                                browser?: null | boolean;
                                bun?: null | boolean;
                                deno?: null | boolean;
                                node?: null | boolean;
                                workerd?: null | boolean;
                            };
                            scope: string;
                            score?: number;
                            updatedAt: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/scopes/{scope}/packages/{package}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { package: string; scope: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { package: string; scope: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            description: string;
                            githubRepository?: { name?: string; owner?: string };
                            name: string;
                            runtimeCompat?: {
                                browser?: null | boolean;
                                bun?: null | boolean;
                                deno?: null | boolean;
                                node?: null | boolean;
                                workerd?: null | boolean;
                            };
                            scope: string;
                            score?: number;
                            updatedAt: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { package: string; scope: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": | { description: string }
                    | { githubRepository: null | { owner: string; repo: string } }
                    | {
                        runtimeCompat: {
                            browser?: null | boolean;
                            bun?: null | boolean;
                            deno?: null | boolean;
                            node?: null | boolean;
                            workerd?: null | boolean;
                        };
                    }
                    | { isArchived: boolean };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            description: string;
                            githubRepository?: { name?: string; owner?: string };
                            name: string;
                            runtimeCompat?: {
                                browser?: null | boolean;
                                bun?: null | boolean;
                                deno?: null | boolean;
                                node?: null | boolean;
                                workerd?: null | boolean;
                            };
                            scope: string;
                            score?: number;
                            updatedAt: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/scopes/{scope}/packages/{package}/dependents": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { package: string; scope: string };
                query?: {
                    limit?: number;
                    page?: number;
                    versions_per_package_limit?: number;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            items?: {
                                name: string;
                                scope: string;
                                totalVersions: number;
                                versions?: (...)[];
                            }[];
                            total?: number;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/scopes/{scope}/packages/{package}/score": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { package: string; scope: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            allEntrypointsDocs: boolean;
                            allFastCheck: boolean;
                            atLeastOneRuntimeCompatible: boolean;
                            hasDescription: boolean;
                            hasProvenance: boolean;
                            hasReadme: boolean;
                            hasReadmeExamples: boolean;
                            multipleRuntimesCompatible: boolean;
                            percentageDocumentedSymbols: number;
                            total?: number;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/scopes/{scope}/packages/{package}/versions": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { package: string; scope: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            package?: string;
                            rekorLogId?: string;
                            scope: string;
                            updatedAt: string;
                            version: string;
                            yanked: boolean;
                        }[];
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/scopes/{scope}/packages/{package}/versions/{version}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { package: string; scope: string; version: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            package?: string;
                            rekorLogId?: string;
                            scope: string;
                            updatedAt: string;
                            version: string;
                            yanked: boolean;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { package: string; scope: string; version: string };
                query?: undefined;
            };
            requestBody: { content: { "application/json": { yanked: boolean } } };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            package?: string;
                            rekorLogId?: string;
                            scope: string;
                            updatedAt: string;
                            version: string;
                            yanked: boolean;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { package: string; scope: string; version: string };
                query: { config: string };
            };
            requestBody: { content: { "application/octet-stream": unknown } };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            error: null | { code?: string; message?: string };
                            id: string;
                            packageName: string;
                            packageScope: string;
                            packageVersion: string;
                            status:
                                | "pending"
                                | "processing"
                                | "processed"
                                | "success"
                                | "failure";
                            updatedAt: string;
                            userId: never;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/scopes/{scope}/packages/{package}/versions/{version}/dependencies": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { package: string; scope: string; version: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            constraint: string;
                            kind: "jsr"
                            | "npm";
                            name: string;
                            path: string;
                        }[];
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/stats": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            featured: {
                                createdAt: string;
                                description: string;
                                githubRepository?: { name?: (...)
                                | (...); owner?: (...) | (...) };
                                name: string;
                                runtimeCompat?: {
                                    browser?: (...) | (...) | (...) | (...);
                                    bun?: (...) | (...) | (...) | (...);
                                    deno?: (...) | (...) | (...) | (...);
                                    node?: (...) | (...) | (...) | (...);
                                    workerd?: (...) | (...) | (...) | (...);
                                };
                                scope: string;
                                score?: number;
                                updatedAt: string;
                            }[];
                            newest: {
                                createdAt: string;
                                description: string;
                                githubRepository?: { name?: (...)
                                | (...); owner?: (...) | (...) };
                                name: string;
                                runtimeCompat?: {
                                    browser?: (...) | (...) | (...) | (...);
                                    bun?: (...) | (...) | (...) | (...);
                                    deno?: (...) | (...) | (...) | (...);
                                    node?: (...) | (...) | (...) | (...);
                                    workerd?: (...) | (...) | (...) | (...);
                                };
                                scope: string;
                                score?: number;
                                updatedAt: string;
                            }[];
                            updated: {
                                createdAt: string;
                                package?: string;
                                rekorLogId?: string;
                                scope: string;
                                updatedAt: string;
                                version: string;
                                yanked: boolean;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/user": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/user/invites": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            inviter: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                            scope: string;
                            targetUser: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                            updatedAt: string;
                        }[];
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/user/invites/{scope}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "204": { content?: undefined; headers: { [name: string]: unknown } };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            isAdmin: boolean;
                            scope: string;
                            updatedAt: string;
                            user: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/user/member/{scope}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { scope: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            isAdmin: boolean;
                            scope: string;
                            updatedAt: string;
                            user: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/user/scopes": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            creator?: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                            ghActionsVerifyActor?: boolean;
                            quotas?: {
                                newPackagePerWeekLimit?: number;
                                newPackagePerWeekUsage?: number;
                                packageLimit?: number;
                                packageUsage?: number;
                                publishAttemptsPerWeekLimit?: number;
                                publishAttemptsPerWeekUsage?: number;
                            };
                            requirePublishingFromCI?: boolean;
                            scope: string;
                            updatedAt: string;
                        }[];
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/users/{id}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/users/{id}/scopes": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            creator?: {
                                avatarUrl: string;
                                createdAt: string;
                                email?: string;
                                githubId?: number;
                                id: string;
                                inviteCount?: number;
                                isBlocked?: boolean;
                                isStaff?: boolean;
                                name: string;
                                scopeLimit?: number;
                                scopeUsage?: number;
                                updatedAt: string;
                            };
                            ghActionsVerifyActor?: boolean;
                            quotas?: {
                                newPackagePerWeekLimit?: number;
                                newPackagePerWeekUsage?: number;
                                packageLimit?: number;
                                packageUsage?: number;
                                publishAttemptsPerWeekLimit?: number;
                                publishAttemptsPerWeekUsage?: number;
                            };
                            requirePublishingFromCI?: boolean;
                            scope: string;
                            updatedAt: string;
                        }[];
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { code: string; message: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
}

Properties

"/authorizations": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    challenge: string;
                    permissions?: (
                        | { permission: "package/publish"; scope: string }
                        | { package: string; permission: "package/publish"; scope: string }
                        | {
                            package: string;
                            permission: "package/publish";
                            scope: string;
                            tarballHash: string;
                            version: string;
                        }
                    )[];
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        code: string;
                        exchangeToken: string;
                        expiresAt: string;
                        pollInterval: number;
                        verificationUrl?: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    challenge: string;
                    permissions?: (
                        | { permission: "package/publish"; scope: string }
                        | { package: string; permission: "package/publish"; scope: string }
                        | {
                            package: string;
                            permission: "package/publish";
                            scope: string;
                            tarballHash: string;
                            version: string;
                        }
                    )[];
                };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        code: string;
                        exchangeToken: string;
                        expiresAt: string;
                        pollInterval: number;
                        verificationUrl?: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create authorization

    Starts an authorization flow

    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • requestBody: {
          content: {
              "application/json": {
                  challenge: string;
                  permissions?: (
                      | { permission: "package/publish"; scope: string }
                      | { package: string; permission: "package/publish"; scope: string }
                      | {
                          package: string;
                          permission: "package/publish";
                          scope: string;
                          tarballHash: string;
                          version: string;
                      }
                  )[];
              };
          };
      }

      Authorization properties

    • responses: {
          "200": {
              content: {
                  "application/json": {
                      code: string;
                      exchangeToken: string;
                      expiresAt: string;
                      pollInterval: number;
                      verificationUrl?: string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    code: string;
                    exchangeToken: string;
                    expiresAt: string;
                    pollInterval: number;
                    verificationUrl?: string;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/authorizations/approve/{code}": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { code: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { code: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Approve authorization

    Approves an authorization

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { code: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { code: string }
        • code: string

          The code of the authorization

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        OK, no content

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Authorization not found

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/authorizations/deny/{code}": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { code: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { code: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Deny authorization

    Denies an authorization

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { code: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { code: string }
        • code: string

          The code of the authorization

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        OK, no content

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Authorization not found

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/authorizations/details/{code}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { code: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        code: string;
                        expiresAt: string;
                        permissions: (
                            | { permission: "package/publish"; scope: string }
                            | { package: string; permission: "package/publish"; scope: string }
                            | {
                                package: string;
                                permission: "package/publish";
                                scope: string;
                                tarballHash: string;
                                version: string;
                            }
                        )[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { code: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        code: string;
                        expiresAt: string;
                        permissions: (
                            | { permission: "package/publish"; scope: string }
                            | { package: string; permission: "package/publish"; scope: string }
                            | {
                                package: string;
                                permission: "package/publish";
                                scope: string;
                                tarballHash: string;
                                version: string;
                            }
                        )[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get authorization details

    Returns details of an authorization

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { code: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { code: string }
        • code: string

          The code of the authorization

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      code: string;
                      expiresAt: string;
                      permissions: (
                          | { permission: "package/publish"; scope: string }
                          | { package: string; permission: "package/publish"; scope: string }
                          | {
                              package: string;
                              permission: "package/publish";
                              scope: string;
                              tarballHash: string;
                              version: string;
                          }
                      )[];
                  };
              };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    code: string;
                    expiresAt: string;
                    permissions: (
                        | { permission: "package/publish"; scope: string }
                        | { package: string; permission: "package/publish"; scope: string }
                        | {
                            package: string;
                            permission: "package/publish";
                            scope: string;
                            tarballHash: string;
                            version: string;
                        }
                    )[];
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Authorization not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/authorizations/exchange": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": { exchangeToken: string; verifier: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        token: string;
                        user: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": { exchangeToken: string; verifier: string };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        token: string;
                        user: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Exchange authorization code for access token

    Exchanges an authorization code for an access token

    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • requestBody: { content: { "application/json": { exchangeToken: string; verifier: string } } }
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      token: string;
                      user: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    token: string;
                    user: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/packages": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { limit?: number; page?: number; query?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        items?: {
                            createdAt: string;
                            description: string;
                            githubRepository?: { name?: ...; owner?: ... };
                            name: string;
                            runtimeCompat?: {
                                browser?: ...;
                                bun?: ...;
                                deno?: ...;
                                node?: ...;
                                workerd?: ...;
                            };
                            scope: string;
                            score?: number;
                            updatedAt: string;
                        }[];
                        total?: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { limit?: number; page?: number; query?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        items?: {
                            createdAt: string;
                            description: string;
                            githubRepository?: { name?: ...; owner?: ... };
                            name: string;
                            runtimeCompat?: {
                                browser?: ...;
                                bun?: ...;
                                deno?: ...;
                                node?: ...;
                                workerd?: ...;
                            };
                            scope: string;
                            score?: number;
                            updatedAt: string;
                        }[];
                        total?: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    List packages

    Returns a list of packages

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path?: undefined;
          query?: { limit?: number; page?: number; query?: string };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • Optionalpath?: undefined
      • Optionalquery?: { limit?: number; page?: number; query?: string }
        • Optionallimit?: number

          The maximum number of packages to return

        • Optionalpage?: number

          The page number of packages to return

        • Optionalquery?: string

          The search query

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      items?: {
                          createdAt: string;
                          description: string;
                          githubRepository?: { name?: ...; owner?: ... };
                          name: string;
                          runtimeCompat?: {
                              browser?: ...;
                              bun?: ...;
                              deno?: ...;
                              node?: ...;
                              workerd?: ...;
                          };
                          scope: string;
                          score?: number;
                          updatedAt: string;
                      }[];
                      total?: number;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    items?: {
                        createdAt: string;
                        description: string;
                        githubRepository?: { name?: ...; owner?: ... };
                        name: string;
                        runtimeCompat?: {
                            browser?: ...;
                            bun?: ...;
                            deno?: ...;
                            node?: ...;
                            workerd?: ...;
                        };
                        scope: string;
                        score?: number;
                        updatedAt: string;
                    }[];
                    total?: number;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/publishing_tasks/{id}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        error: null
                        | { code?: string; message?: string };
                        id: string;
                        packageName: string;
                        packageScope: string;
                        packageVersion: string;
                        status: "pending" | "processing" | "processed" | "success" | "failure";
                        updatedAt: string;
                        userId: never;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        error: null
                        | { code?: string; message?: string };
                        id: string;
                        packageName: string;
                        packageScope: string;
                        packageVersion: string;
                        status: "pending" | "processing" | "processed" | "success" | "failure";
                        updatedAt: string;
                        userId: never;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get publishing task details

    Returns details of a publishing task

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { id: string }
        • id: string

          The ID of the publishing task

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      error: null | { code?: string; message?: string };
                      id: string;
                      packageName: string;
                      packageScope: string;
                      packageVersion: string;
                      status: "pending" | "processing" | "processed" | "success" | "failure";
                      updatedAt: string;
                      userId: never;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    error: null | { code?: string; message?: string };
                    id: string;
                    packageName: string;
                    packageScope: string;
                    packageVersion: string;
                    status: "pending" | "processing" | "processed" | "success" | "failure";
                    updatedAt: string;
                    userId: never;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Publishing task not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: { content: { "application/json": { scope?: string } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        creator?: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        ghActionsVerifyActor?: boolean;
                        quotas?: {
                            newPackagePerWeekLimit?: number;
                            newPackagePerWeekUsage?: number;
                            packageLimit?: number;
                            packageUsage?: number;
                            publishAttemptsPerWeekLimit?: number;
                            publishAttemptsPerWeekUsage?: number;
                        };
                        requirePublishingFromCI?: boolean;
                        scope: string;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: { content: { "application/json": { scope?: string } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        creator?: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        ghActionsVerifyActor?: boolean;
                        quotas?: {
                            newPackagePerWeekLimit?: number;
                            newPackagePerWeekUsage?: number;
                            packageLimit?: number;
                            packageUsage?: number;
                            publishAttemptsPerWeekLimit?: number;
                            publishAttemptsPerWeekUsage?: number;
                        };
                        requirePublishingFromCI?: boolean;
                        scope: string;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create a new scope

    Creates a new scope

    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • requestBody: { content: { "application/json": { scope?: string } } }

      Scope properties

    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      creator?: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                      ghActionsVerifyActor?: boolean;
                      quotas?: {
                          newPackagePerWeekLimit?: number;
                          newPackagePerWeekUsage?: number;
                          packageLimit?: number;
                          packageUsage?: number;
                          publishAttemptsPerWeekLimit?: number;
                          publishAttemptsPerWeekUsage?: number;
                      };
                      requirePublishingFromCI?: boolean;
                      scope: string;
                      updatedAt: string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    creator?: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                    ghActionsVerifyActor?: boolean;
                    quotas?: {
                        newPackagePerWeekLimit?: number;
                        newPackagePerWeekUsage?: number;
                        packageLimit?: number;
                        packageUsage?: number;
                        publishAttemptsPerWeekLimit?: number;
                        publishAttemptsPerWeekUsage?: number;
                    };
                    requirePublishingFromCI?: boolean;
                    scope: string;
                    updatedAt: string;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes/{scope}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        creator?: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        ghActionsVerifyActor?: boolean;
                        quotas?: {
                            newPackagePerWeekLimit?: number;
                            newPackagePerWeekUsage?: number;
                            packageLimit?: number;
                            packageUsage?: number;
                            publishAttemptsPerWeekLimit?: number;
                            publishAttemptsPerWeekUsage?: number;
                        };
                        requirePublishingFromCI?: boolean;
                        scope: string;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": | { ghActionsVerifyActor: boolean }
                | { requirePublishingFromCI: boolean };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        creator?: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        ghActionsVerifyActor?: boolean;
                        quotas?: {
                            newPackagePerWeekLimit?: number;
                            newPackagePerWeekUsage?: number;
                            packageLimit?: number;
                            packageUsage?: number;
                            publishAttemptsPerWeekLimit?: number;
                            publishAttemptsPerWeekUsage?: number;
                        };
                        requirePublishingFromCI?: boolean;
                        scope: string;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Delete scope

    Deletes a scope if the scope has no packages

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string }
        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        OK, no content

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request / Scope has packages

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 403: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User is not scope admin

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope not found

  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        creator?: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        ghActionsVerifyActor?: boolean;
                        quotas?: {
                            newPackagePerWeekLimit?: number;
                            newPackagePerWeekUsage?: number;
                            packageLimit?: number;
                            packageUsage?: number;
                            publishAttemptsPerWeekLimit?: number;
                            publishAttemptsPerWeekUsage?: number;
                        };
                        requirePublishingFromCI?: boolean;
                        scope: string;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get scope details

    Returns details of a scope

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string }
        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      creator?: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                      ghActionsVerifyActor?: boolean;
                      quotas?: {
                          newPackagePerWeekLimit?: number;
                          newPackagePerWeekUsage?: number;
                          packageLimit?: number;
                          packageUsage?: number;
                          publishAttemptsPerWeekLimit?: number;
                          publishAttemptsPerWeekUsage?: number;
                      };
                      requirePublishingFromCI?: boolean;
                      scope: string;
                      updatedAt: string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    creator?: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                    ghActionsVerifyActor?: boolean;
                    quotas?: {
                        newPackagePerWeekLimit?: number;
                        newPackagePerWeekUsage?: number;
                        packageLimit?: number;
                        packageUsage?: number;
                        publishAttemptsPerWeekLimit?: number;
                        publishAttemptsPerWeekUsage?: number;
                    };
                    requirePublishingFromCI?: boolean;
                    scope: string;
                    updatedAt: string;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": | { ghActionsVerifyActor: boolean }
                | { requirePublishingFromCI: boolean };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        creator?: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        ghActionsVerifyActor?: boolean;
                        quotas?: {
                            newPackagePerWeekLimit?: number;
                            newPackagePerWeekUsage?: number;
                            packageLimit?: number;
                            packageUsage?: number;
                            publishAttemptsPerWeekLimit?: number;
                            publishAttemptsPerWeekUsage?: number;
                        };
                        requirePublishingFromCI?: boolean;
                        scope: string;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Update scope

    Updates the details of a scope

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string }
        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • requestBody: {
          content: {
              "application/json":
                  | { ghActionsVerifyActor: boolean }
                  | { requirePublishingFromCI: boolean };
          };
      }

      Scope properties

    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      creator?: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                      ghActionsVerifyActor?: boolean;
                      quotas?: {
                          newPackagePerWeekLimit?: number;
                          newPackagePerWeekUsage?: number;
                          packageLimit?: number;
                          packageUsage?: number;
                          publishAttemptsPerWeekLimit?: number;
                          publishAttemptsPerWeekUsage?: number;
                      };
                      requirePublishingFromCI?: boolean;
                      scope: string;
                      updatedAt: string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    creator?: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                    ghActionsVerifyActor?: boolean;
                    quotas?: {
                        newPackagePerWeekLimit?: number;
                        newPackagePerWeekUsage?: number;
                        packageLimit?: number;
                        packageUsage?: number;
                        publishAttemptsPerWeekLimit?: number;
                        publishAttemptsPerWeekUsage?: number;
                    };
                    requirePublishingFromCI?: boolean;
                    scope: string;
                    updatedAt: string;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 403: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User is not scope admin

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope not found

  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes/{scope}/invites": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        inviter: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        scope: string;
                        targetUser: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        updatedAt: string;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        inviter: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        scope: string;
                        targetUser: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        updatedAt: string;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    List scope invites

    Returns a list of invites to a scope

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string }
        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      inviter: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                      scope: string;
                      targetUser: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                      updatedAt: string;
                  }[];
              };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    inviter: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                    scope: string;
                    targetUser: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                    updatedAt: string;
                }[];
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 403: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User is not a scope admin

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes/{scope}/invites/{userId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string; userId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string; userId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Delete scope invite

    Deletes an invite to a scope

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string; userId: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string; userId: string }
        • scope: string

          The name of the scope

        • userId: string

          The ID of the user

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        OK, no content

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 403: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User is not a scope admin

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope or scope invite not found

  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes/{scope}/members": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        isAdmin: boolean;
                        scope: string;
                        updatedAt: string;
                        user: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody: { content: { "application/json": { githubLogin: string } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        inviter: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        scope: string;
                        targetUser: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        isAdmin: boolean;
                        scope: string;
                        updatedAt: string;
                        user: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    List scope members

    Returns a list of members of a scope

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string }
        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      isAdmin: boolean;
                      scope: string;
                      updatedAt: string;
                      user: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                  }[];
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    isAdmin: boolean;
                    scope: string;
                    updatedAt: string;
                    user: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                }[];
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody: { content: { "application/json": { githubLogin: string } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        inviter: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        scope: string;
                        targetUser: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Add scope member

    Invites a user to a scope

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string }
        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • requestBody: { content: { "application/json": { githubLogin: string } } }

      Scope member properties

    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      inviter: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                      scope: string;
                      targetUser: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                      updatedAt: string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    inviter: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                    scope: string;
                    targetUser: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                    updatedAt: string;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 403: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User is not scope admin

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope not found

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes/{scope}/members/{userId}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string; userId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string; userId: string };
            query?: undefined;
        };
        requestBody: { content: { "application/json": { isAdmin: boolean } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        isAdmin: boolean;
                        scope: string;
                        updatedAt: string;
                        user: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string; userId: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Remove scope member

    Removes a member from a scope

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string; userId: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string; userId: string }
        • scope: string

          The name of the scope

        • userId: string

          The ID of the user

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        OK, no content

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request / Can not remove last scope admin

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 403: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User is not a scope admin

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope or scope member not found

  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string; userId: string };
            query?: undefined;
        };
        requestBody: { content: { "application/json": { isAdmin: boolean } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        isAdmin: boolean;
                        scope: string;
                        updatedAt: string;
                        user: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Update scope member

    Updates the roles of a scope member

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string; userId: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string; userId: string }
        • scope: string

          The name of the scope

        • userId: string

          The ID of the user

      • Optionalquery?: undefined
    • requestBody: { content: { "application/json": { isAdmin: boolean } } }

      Scope member properties

    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      isAdmin: boolean;
                      scope: string;
                      updatedAt: string;
                      user: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    isAdmin: boolean;
                    scope: string;
                    updatedAt: string;
                    user: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request / Can not remove last scope admin

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 403: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User is not a scope admin

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope or scope member not found

  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes/{scope}/packages": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: { limit?: number; page?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        items?: {
                            createdAt: string;
                            description: string;
                            githubRepository?: { name?: ...; owner?: ... };
                            name: string;
                            runtimeCompat?: {
                                browser?: ...;
                                bun?: ...;
                                deno?: ...;
                                node?: ...;
                                workerd?: ...;
                            };
                            scope: string;
                            score?: number;
                            updatedAt: string;
                        }[];
                        total?: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody: { content: { "application/json": { package: string } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        description: string;
                        githubRepository?: { name?: string; owner?: string };
                        name: string;
                        runtimeCompat?: {
                            browser?: null | boolean;
                            bun?: null | boolean;
                            deno?: null | boolean;
                            node?: null | boolean;
                            workerd?: null | boolean;
                        };
                        scope: string;
                        score?: number;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: { limit?: number; page?: number };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        items?: {
                            createdAt: string;
                            description: string;
                            githubRepository?: { name?: ...; owner?: ... };
                            name: string;
                            runtimeCompat?: {
                                browser?: ...;
                                bun?: ...;
                                deno?: ...;
                                node?: ...;
                                workerd?: ...;
                            };
                            scope: string;
                            score?: number;
                            updatedAt: string;
                        }[];
                        total?: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    List scope packages

    Returns a list of packages in a scope

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string };
          query?: { limit?: number; page?: number };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string }
        • scope: string

          The name of the scope

      • Optionalquery?: { limit?: number; page?: number }
        • Optionallimit?: number

          The maximum number of packages to return

        • Optionalpage?: number

          The page number of packages to return

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      items?: {
                          createdAt: string;
                          description: string;
                          githubRepository?: { name?: ...; owner?: ... };
                          name: string;
                          runtimeCompat?: {
                              browser?: ...;
                              bun?: ...;
                              deno?: ...;
                              node?: ...;
                              workerd?: ...;
                          };
                          scope: string;
                          score?: number;
                          updatedAt: string;
                      }[];
                      total?: number;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    items?: {
                        createdAt: string;
                        description: string;
                        githubRepository?: { name?: ...; owner?: ... };
                        name: string;
                        runtimeCompat?: {
                            browser?: ...;
                            bun?: ...;
                            deno?: ...;
                            node?: ...;
                            workerd?: ...;
                        };
                        scope: string;
                        score?: number;
                        updatedAt: string;
                    }[];
                    total?: number;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody: { content: { "application/json": { package: string } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        description: string;
                        githubRepository?: { name?: string; owner?: string };
                        name: string;
                        runtimeCompat?: {
                            browser?: null | boolean;
                            bun?: null | boolean;
                            deno?: null | boolean;
                            node?: null | boolean;
                            workerd?: null | boolean;
                        };
                        scope: string;
                        score?: number;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create a new package

    Creates a new package in a scope

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string }
        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • requestBody: { content: { "application/json": { package: string } } }

      Package properties

    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      description: string;
                      githubRepository?: { name?: string; owner?: string };
                      name: string;
                      runtimeCompat?: {
                          browser?: null | boolean;
                          bun?: null | boolean;
                          deno?: null | boolean;
                          node?: null | boolean;
                          workerd?: null | boolean;
                      };
                      scope: string;
                      score?: number;
                      updatedAt: string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    description: string;
                    githubRepository?: { name?: string; owner?: string };
                    name: string;
                    runtimeCompat?: {
                        browser?: null | boolean;
                        bun?: null | boolean;
                        deno?: null | boolean;
                        node?: null | boolean;
                        workerd?: null | boolean;
                    };
                    scope: string;
                    score?: number;
                    updatedAt: string;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 403: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User is not a scope member

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope not found

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes/{scope}/packages/{package}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        description: string;
                        githubRepository?: { name?: string; owner?: string };
                        name: string;
                        runtimeCompat?: {
                            browser?: null | boolean;
                            bun?: null | boolean;
                            deno?: null | boolean;
                            node?: null | boolean;
                            workerd?: null | boolean;
                        };
                        scope: string;
                        score?: number;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": | { description: string }
                | { githubRepository: null | { owner: string; repo: string } }
                | {
                    runtimeCompat: {
                        browser?: null | boolean;
                        bun?: null | boolean;
                        deno?: null | boolean;
                        node?: null | boolean;
                        workerd?: null | boolean;
                    };
                }
                | { isArchived: boolean };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        description: string;
                        githubRepository?: { name?: string; owner?: string };
                        name: string;
                        runtimeCompat?: {
                            browser?: null | boolean;
                            bun?: null | boolean;
                            deno?: null | boolean;
                            node?: null | boolean;
                            workerd?: null | boolean;
                        };
                        scope: string;
                        score?: number;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Delete package

    Deletes a package if the package has no versions

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { package: string; scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { package: string; scope: string }
        • package: string

          The name of the package

        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        OK, no content

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request / Package has versions

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 403: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User is not a scope admin

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Package not found

  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        description: string;
                        githubRepository?: { name?: string; owner?: string };
                        name: string;
                        runtimeCompat?: {
                            browser?: null | boolean;
                            bun?: null | boolean;
                            deno?: null | boolean;
                            node?: null | boolean;
                            workerd?: null | boolean;
                        };
                        scope: string;
                        score?: number;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get package details

    Returns details of a package

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { package: string; scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { package: string; scope: string }
        • package: string

          The name of the package

        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      description: string;
                      githubRepository?: { name?: string; owner?: string };
                      name: string;
                      runtimeCompat?: {
                          browser?: null | boolean;
                          bun?: null | boolean;
                          deno?: null | boolean;
                          node?: null | boolean;
                          workerd?: null | boolean;
                      };
                      scope: string;
                      score?: number;
                      updatedAt: string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    description: string;
                    githubRepository?: { name?: string; owner?: string };
                    name: string;
                    runtimeCompat?: {
                        browser?: null | boolean;
                        bun?: null | boolean;
                        deno?: null | boolean;
                        node?: null | boolean;
                        workerd?: null | boolean;
                    };
                    scope: string;
                    score?: number;
                    updatedAt: string;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Package not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string };
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": | { description: string }
                | { githubRepository: null | { owner: string; repo: string } }
                | {
                    runtimeCompat: {
                        browser?: null | boolean;
                        bun?: null | boolean;
                        deno?: null | boolean;
                        node?: null | boolean;
                        workerd?: null | boolean;
                    };
                }
                | { isArchived: boolean };
            };
        };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        description: string;
                        githubRepository?: { name?: string; owner?: string };
                        name: string;
                        runtimeCompat?: {
                            browser?: null | boolean;
                            bun?: null | boolean;
                            deno?: null | boolean;
                            node?: null | boolean;
                            workerd?: null | boolean;
                        };
                        scope: string;
                        score?: number;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Update package

    Updates the details of a package

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { package: string; scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { package: string; scope: string }
        • package: string

          The name of the package

        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • requestBody: {
          content: {
              "application/json":
                  | { description: string }
                  | { githubRepository: null | { owner: string; repo: string } }
                  | {
                      runtimeCompat: {
                          browser?: null | boolean;
                          bun?: null | boolean;
                          deno?: null | boolean;
                          node?: null | boolean;
                          workerd?: null | boolean;
                      };
                  }
                  | { isArchived: boolean };
          };
      }

      Package properties

    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      description: string;
                      githubRepository?: { name?: string; owner?: string };
                      name: string;
                      runtimeCompat?: {
                          browser?: null | boolean;
                          bun?: null | boolean;
                          deno?: null | boolean;
                          node?: null | boolean;
                          workerd?: null | boolean;
                      };
                      scope: string;
                      score?: number;
                      updatedAt: string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    description: string;
                    githubRepository?: { name?: string; owner?: string };
                    name: string;
                    runtimeCompat?: {
                        browser?: null | boolean;
                        bun?: null | boolean;
                        deno?: null | boolean;
                        node?: null | boolean;
                        workerd?: null | boolean;
                    };
                    scope: string;
                    score?: number;
                    updatedAt: string;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 403: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User is not a scope member / User is not a scope admin

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Package not found

  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes/{scope}/packages/{package}/dependents": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string };
            query?: {
                limit?: number;
                page?: number;
                versions_per_package_limit?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        items?: {
                            name: string;
                            scope: string;
                            totalVersions: number;
                            versions?: (...)[];
                        }[];
                        total?: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string };
            query?: {
                limit?: number;
                page?: number;
                versions_per_package_limit?: number;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        items?: {
                            name: string;
                            scope: string;
                            totalVersions: number;
                            versions?: (...)[];
                        }[];
                        total?: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    List package dependents

    Returns a list of packages that depend on a package

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { package: string; scope: string };
          query?: {
              limit?: number;
              page?: number;
              versions_per_package_limit?: number;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { package: string; scope: string }
        • package: string

          The name of the package

        • scope: string

          The name of the scope

      • Optionalquery?: { limit?: number; page?: number; versions_per_package_limit?: number }
        • Optionallimit?: number

          The maximum number of dependents to return

        • Optionalpage?: number

          The page number of dependents to return

        • Optionalversions_per_package_limit?: number

          The maximum number of versions per package to return

    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      items?: {
                          name: string;
                          scope: string;
                          totalVersions: number;
                          versions?: (...)[];
                      }[];
                      total?: number;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    items?: {
                        name: string;
                        scope: string;
                        totalVersions: number;
                        versions?: (...)[];
                    }[];
                    total?: number;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Package not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes/{scope}/packages/{package}/score": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        allEntrypointsDocs: boolean;
                        allFastCheck: boolean;
                        atLeastOneRuntimeCompatible: boolean;
                        hasDescription: boolean;
                        hasProvenance: boolean;
                        hasReadme: boolean;
                        hasReadmeExamples: boolean;
                        multipleRuntimesCompatible: boolean;
                        percentageDocumentedSymbols: number;
                        total?: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        allEntrypointsDocs: boolean;
                        allFastCheck: boolean;
                        atLeastOneRuntimeCompatible: boolean;
                        hasDescription: boolean;
                        hasProvenance: boolean;
                        hasReadme: boolean;
                        hasReadmeExamples: boolean;
                        multipleRuntimesCompatible: boolean;
                        percentageDocumentedSymbols: number;
                        total?: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get package score

    Returns the package score details

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { package: string; scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { package: string; scope: string }
        • package: string

          The name of the package

        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      allEntrypointsDocs: boolean;
                      allFastCheck: boolean;
                      atLeastOneRuntimeCompatible: boolean;
                      hasDescription: boolean;
                      hasProvenance: boolean;
                      hasReadme: boolean;
                      hasReadmeExamples: boolean;
                      multipleRuntimesCompatible: boolean;
                      percentageDocumentedSymbols: number;
                      total?: number;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    allEntrypointsDocs: boolean;
                    allFastCheck: boolean;
                    atLeastOneRuntimeCompatible: boolean;
                    hasDescription: boolean;
                    hasProvenance: boolean;
                    hasReadme: boolean;
                    hasReadmeExamples: boolean;
                    multipleRuntimesCompatible: boolean;
                    percentageDocumentedSymbols: number;
                    total?: number;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Package not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes/{scope}/packages/{package}/versions": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        package?: string;
                        rekorLogId?: string;
                        scope: string;
                        updatedAt: string;
                        version: string;
                        yanked: boolean;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        package?: string;
                        rekorLogId?: string;
                        scope: string;
                        updatedAt: string;
                        version: string;
                        yanked: boolean;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    List package versions

    Returns a list of versions of a package

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { package: string; scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { package: string; scope: string }
        • package: string

          The name of the package

        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      package?: string;
                      rekorLogId?: string;
                      scope: string;
                      updatedAt: string;
                      version: string;
                      yanked: boolean;
                  }[];
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    package?: string;
                    rekorLogId?: string;
                    scope: string;
                    updatedAt: string;
                    version: string;
                    yanked: boolean;
                }[];
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Package not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes/{scope}/packages/{package}/versions/{version}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string; version: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        package?: string;
                        rekorLogId?: string;
                        scope: string;
                        updatedAt: string;
                        version: string;
                        yanked: boolean;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string; version: string };
            query?: undefined;
        };
        requestBody: { content: { "application/json": { yanked: boolean } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        package?: string;
                        rekorLogId?: string;
                        scope: string;
                        updatedAt: string;
                        version: string;
                        yanked: boolean;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string; version: string };
            query: { config: string };
        };
        requestBody: { content: { "application/octet-stream": unknown } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        error: null | { code?: string; message?: string };
                        id: string;
                        packageName: string;
                        packageScope: string;
                        packageVersion: string;
                        status: "pending" | "processing" | "processed" | "success" | "failure";
                        updatedAt: string;
                        userId: never;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string; version: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        package?: string;
                        rekorLogId?: string;
                        scope: string;
                        updatedAt: string;
                        version: string;
                        yanked: boolean;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get package version details

    Returns details of a package version

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { package: string; scope: string; version: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { package: string; scope: string; version: string }
        • package: string

          The name of the package

        • scope: string

          The name of the scope

        • version: string

          The version of the package

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      package?: string;
                      rekorLogId?: string;
                      scope: string;
                      updatedAt: string;
                      version: string;
                      yanked: boolean;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    package?: string;
                    rekorLogId?: string;
                    scope: string;
                    updatedAt: string;
                    version: string;
                    yanked: boolean;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Package version not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string; version: string };
            query?: undefined;
        };
        requestBody: { content: { "application/json": { yanked: boolean } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        package?: string;
                        rekorLogId?: string;
                        scope: string;
                        updatedAt: string;
                        version: string;
                        yanked: boolean;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Update package version

    Updates the details of a package version

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { package: string; scope: string; version: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { package: string; scope: string; version: string }
        • package: string

          The name of the package

        • scope: string

          The name of the scope

        • version: string

          The version of the package

      • Optionalquery?: undefined
    • requestBody: { content: { "application/json": { yanked: boolean } } }

      Package version properties

    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      package?: string;
                      rekorLogId?: string;
                      scope: string;
                      updatedAt: string;
                      version: string;
                      yanked: boolean;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    package?: string;
                    rekorLogId?: string;
                    scope: string;
                    updatedAt: string;
                    version: string;
                    yanked: boolean;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request / Package version already exists

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized / User is not a scope member

      • 403: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User is not a scope member

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Package not found

  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string; version: string };
            query: { config: string };
        };
        requestBody: { content: { "application/octet-stream": unknown } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        error: null | { code?: string; message?: string };
                        id: string;
                        packageName: string;
                        packageScope: string;
                        packageVersion: string;
                        status: "pending" | "processing" | "processed" | "success" | "failure";
                        updatedAt: string;
                        userId: never;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Create a new package version

    Creates a new version of a package

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { package: string; scope: string; version: string };
          query: { config: string };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { package: string; scope: string; version: string }
        • package: string

          The name of the package

        • scope: string

          The name of the scope

        • version: string

          The version of the package

      • query: { config: string }
        • config: string

          The path to the config file

    • requestBody: { content: { "application/octet-stream": unknown } }

      A gzipped tarball containing all files in the package version

    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      error: null | { code?: string; message?: string };
                      id: string;
                      packageName: string;
                      packageScope: string;
                      packageVersion: string;
                      status: "pending" | "processing" | "processed" | "success" | "failure";
                      updatedAt: string;
                      userId: never;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "403": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    error: null | { code?: string; message?: string };
                    id: string;
                    packageName: string;
                    packageScope: string;
                    packageVersion: string;
                    status: "pending" | "processing" | "processed" | "success" | "failure";
                    updatedAt: string;
                    userId: never;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request / Package version already exists

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized / User is not a scope member

      • 403: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User is not a scope member

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Package not found

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/scopes/{scope}/packages/{package}/versions/{version}/dependencies": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string; version: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        constraint: string;
                        kind: "jsr"
                        | "npm";
                        name: string;
                        path: string;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { package: string; scope: string; version: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        constraint: string;
                        kind: "jsr"
                        | "npm";
                        name: string;
                        path: string;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    List the dependencies of a package version

    Returns a list of dependencies of a package

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { package: string; scope: string; version: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { package: string; scope: string; version: string }
        • package: string

          The name of the package

        • scope: string

          The name of the scope

        • version: string

          The version of the package

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      constraint: string;
                      kind: "jsr" | "npm";
                      name: string;
                      path: string;
                  }[];
              };
              headers: { [name: string]: unknown };
          };
          "400": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    constraint: string;
                    kind: "jsr" | "npm";
                    name: string;
                    path: string;
                }[];
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 400: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Invalid request

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Package not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/stats": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        featured: {
                            createdAt: string;
                            description: string;
                            githubRepository?: { name?: (...)
                            | (...); owner?: (...) | (...) };
                            name: string;
                            runtimeCompat?: {
                                browser?: (...) | (...) | (...) | (...);
                                bun?: (...) | (...) | (...) | (...);
                                deno?: (...) | (...) | (...) | (...);
                                node?: (...) | (...) | (...) | (...);
                                workerd?: (...) | (...) | (...) | (...);
                            };
                            scope: string;
                            score?: number;
                            updatedAt: string;
                        }[];
                        newest: {
                            createdAt: string;
                            description: string;
                            githubRepository?: { name?: (...)
                            | (...); owner?: (...) | (...) };
                            name: string;
                            runtimeCompat?: {
                                browser?: (...) | (...) | (...) | (...);
                                bun?: (...) | (...) | (...) | (...);
                                deno?: (...) | (...) | (...) | (...);
                                node?: (...) | (...) | (...) | (...);
                                workerd?: (...) | (...) | (...) | (...);
                            };
                            scope: string;
                            score?: number;
                            updatedAt: string;
                        }[];
                        updated: {
                            createdAt: string;
                            package?: string;
                            rekorLogId?: string;
                            scope: string;
                            updatedAt: string;
                            version: string;
                            yanked: boolean;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        featured: {
                            createdAt: string;
                            description: string;
                            githubRepository?: { name?: (...)
                            | (...); owner?: (...) | (...) };
                            name: string;
                            runtimeCompat?: {
                                browser?: (...) | (...) | (...) | (...);
                                bun?: (...) | (...) | (...) | (...);
                                deno?: (...) | (...) | (...) | (...);
                                node?: (...) | (...) | (...) | (...);
                                workerd?: (...) | (...) | (...) | (...);
                            };
                            scope: string;
                            score?: number;
                            updatedAt: string;
                        }[];
                        newest: {
                            createdAt: string;
                            description: string;
                            githubRepository?: { name?: (...)
                            | (...); owner?: (...) | (...) };
                            name: string;
                            runtimeCompat?: {
                                browser?: (...) | (...) | (...) | (...);
                                bun?: (...) | (...) | (...) | (...);
                                deno?: (...) | (...) | (...) | (...);
                                node?: (...) | (...) | (...) | (...);
                                workerd?: (...) | (...) | (...) | (...);
                            };
                            scope: string;
                            score?: number;
                            updatedAt: string;
                        }[];
                        updated: {
                            createdAt: string;
                            package?: string;
                            rekorLogId?: string;
                            scope: string;
                            updatedAt: string;
                            version: string;
                            yanked: boolean;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get stats

    Returns stats about the registry

    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      featured: {
                          createdAt: string;
                          description: string;
                          githubRepository?: { name?: (...) | (...); owner?: (...) | (...) };
                          name: string;
                          runtimeCompat?: {
                              browser?: (...) | (...) | (...) | (...);
                              bun?: (...) | (...) | (...) | (...);
                              deno?: (...) | (...) | (...) | (...);
                              node?: (...) | (...) | (...) | (...);
                              workerd?: (...) | (...) | (...) | (...);
                          };
                          scope: string;
                          score?: number;
                          updatedAt: string;
                      }[];
                      newest: {
                          createdAt: string;
                          description: string;
                          githubRepository?: { name?: (...)
                          | (...); owner?: (...) | (...) };
                          name: string;
                          runtimeCompat?: {
                              browser?: (...) | (...) | (...) | (...);
                              bun?: (...) | (...) | (...) | (...);
                              deno?: (...) | (...) | (...) | (...);
                              node?: (...) | (...) | (...) | (...);
                              workerd?: (...) | (...) | (...) | (...);
                          };
                          scope: string;
                          score?: number;
                          updatedAt: string;
                      }[];
                      updated: {
                          createdAt: string;
                          package?: string;
                          rekorLogId?: string;
                          scope: string;
                          updatedAt: string;
                          version: string;
                          yanked: boolean;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    featured: {
                        createdAt: string;
                        description: string;
                        githubRepository?: { name?: (...) | (...); owner?: (...) | (...) };
                        name: string;
                        runtimeCompat?: {
                            browser?: (...) | (...) | (...) | (...);
                            bun?: (...) | (...) | (...) | (...);
                            deno?: (...) | (...) | (...) | (...);
                            node?: (...) | (...) | (...) | (...);
                            workerd?: (...) | (...) | (...) | (...);
                        };
                        scope: string;
                        score?: number;
                        updatedAt: string;
                    }[];
                    newest: {
                        createdAt: string;
                        description: string;
                        githubRepository?: { name?: (...)
                        | (...); owner?: (...) | (...) };
                        name: string;
                        runtimeCompat?: {
                            browser?: (...) | (...) | (...) | (...);
                            bun?: (...) | (...) | (...) | (...);
                            deno?: (...) | (...) | (...) | (...);
                            node?: (...) | (...) | (...) | (...);
                            workerd?: (...) | (...) | (...) | (...);
                        };
                        scope: string;
                        score?: number;
                        updatedAt: string;
                    }[];
                    updated: {
                        createdAt: string;
                        package?: string;
                        rekorLogId?: string;
                        scope: string;
                        updatedAt: string;
                        version: string;
                        yanked: boolean;
                    }[];
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/user": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get authenticated user's details

    Returns details of the authenticated user

    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      avatarUrl: string;
                      createdAt: string;
                      email?: string;
                      githubId?: number;
                      id: string;
                      inviteCount?: number;
                      isBlocked?: boolean;
                      isStaff?: boolean;
                      name: string;
                      scopeLimit?: number;
                      scopeUsage?: number;
                      updatedAt: string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    avatarUrl: string;
                    createdAt: string;
                    email?: string;
                    githubId?: number;
                    id: string;
                    inviteCount?: number;
                    isBlocked?: boolean;
                    isStaff?: boolean;
                    name: string;
                    scopeLimit?: number;
                    scopeUsage?: number;
                    updatedAt: string;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/user/invites": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        inviter: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        scope: string;
                        targetUser: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        updatedAt: string;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        inviter: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        scope: string;
                        targetUser: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        updatedAt: string;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    List authenticated user's scope invites

    Returns a list of invites to scopes that the authenticated user has received

    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      inviter: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                      scope: string;
                      targetUser: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                      updatedAt: string;
                  }[];
              };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    inviter: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                    scope: string;
                    targetUser: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                    updatedAt: string;
                }[];
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/user/invites/{scope}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        isAdmin: boolean;
                        scope: string;
                        updatedAt: string;
                        user: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "204": { content?: undefined; headers: { [name: string]: unknown } };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Decline scope invite

    Declines an invite to a scope

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string }
        • scope: string

          The name of the scope to decline the invite for

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "204": { content?: undefined; headers: { [name: string]: unknown } };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 204: { content?: undefined; headers: { [name: string]: unknown } }

        OK, no content

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope invite not found

  • Optionalget?: undefined
  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        isAdmin: boolean;
                        scope: string;
                        updatedAt: string;
                        user: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Accept scope invite

    Accepts an invite to a scope

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string }
        • scope: string

          The name of the scope to accept the invite for

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      isAdmin: boolean;
                      scope: string;
                      updatedAt: string;
                      user: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    isAdmin: boolean;
                    scope: string;
                    updatedAt: string;
                    user: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Scope invite not found

  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/user/member/{scope}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        isAdmin: boolean;
                        scope: string;
                        updatedAt: string;
                        user: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { scope: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        isAdmin: boolean;
                        scope: string;
                        updatedAt: string;
                        user: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get authenticated user's scope member details

    Returns details of the authenticated user's membership of a scope

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { scope: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { scope: string }
        • scope: string

          The name of the scope

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      isAdmin: boolean;
                      scope: string;
                      updatedAt: string;
                      user: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    isAdmin: boolean;
                    scope: string;
                    updatedAt: string;
                    user: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/user/scopes": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        creator?: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        ghActionsVerifyActor?: boolean;
                        quotas?: {
                            newPackagePerWeekLimit?: number;
                            newPackagePerWeekUsage?: number;
                            packageLimit?: number;
                            packageUsage?: number;
                            publishAttemptsPerWeekLimit?: number;
                            publishAttemptsPerWeekUsage?: number;
                        };
                        requirePublishingFromCI?: boolean;
                        scope: string;
                        updatedAt: string;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        creator?: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        ghActionsVerifyActor?: boolean;
                        quotas?: {
                            newPackagePerWeekLimit?: number;
                            newPackagePerWeekUsage?: number;
                            packageLimit?: number;
                            packageUsage?: number;
                            publishAttemptsPerWeekLimit?: number;
                            publishAttemptsPerWeekUsage?: number;
                        };
                        requirePublishingFromCI?: boolean;
                        scope: string;
                        updatedAt: string;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    List authenticated user's scopes

    Returns a list of scopes that the authenticated user is a member of

    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      creator?: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                      ghActionsVerifyActor?: boolean;
                      quotas?: {
                          newPackagePerWeekLimit?: number;
                          newPackagePerWeekUsage?: number;
                          packageLimit?: number;
                          packageUsage?: number;
                          publishAttemptsPerWeekLimit?: number;
                          publishAttemptsPerWeekUsage?: number;
                      };
                      requirePublishingFromCI?: boolean;
                      scope: string;
                      updatedAt: string;
                  }[];
              };
              headers: { [name: string]: unknown };
          };
          "401": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    creator?: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                    ghActionsVerifyActor?: boolean;
                    quotas?: {
                        newPackagePerWeekLimit?: number;
                        newPackagePerWeekUsage?: number;
                        packageLimit?: number;
                        packageUsage?: number;
                        publishAttemptsPerWeekLimit?: number;
                        publishAttemptsPerWeekUsage?: number;
                    };
                    requirePublishingFromCI?: boolean;
                    scope: string;
                    updatedAt: string;
                }[];
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 401: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        Unauthorized

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/users/{id}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    Get user details

    Returns details of a user

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { id: string }
        • id: string

          The ID of the user

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      avatarUrl: string;
                      createdAt: string;
                      email?: string;
                      githubId?: number;
                      id: string;
                      inviteCount?: number;
                      isBlocked?: boolean;
                      isStaff?: boolean;
                      name: string;
                      scopeLimit?: number;
                      scopeUsage?: number;
                      updatedAt: string;
                  };
              };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    avatarUrl: string;
                    createdAt: string;
                    email?: string;
                    githubId?: number;
                    id: string;
                    inviteCount?: number;
                    isBlocked?: boolean;
                    isStaff?: boolean;
                    name: string;
                    scopeLimit?: number;
                    scopeUsage?: number;
                    updatedAt: string;
                };
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined
"/users/{id}/scopes": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        creator?: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        ghActionsVerifyActor?: boolean;
                        quotas?: {
                            newPackagePerWeekLimit?: number;
                            newPackagePerWeekUsage?: number;
                            packageLimit?: number;
                            packageUsage?: number;
                            publishAttemptsPerWeekLimit?: number;
                            publishAttemptsPerWeekUsage?: number;
                        };
                        requirePublishingFromCI?: boolean;
                        scope: string;
                        updatedAt: string;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

  • Optionaldelete?: undefined
  • get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        creator?: {
                            avatarUrl: string;
                            createdAt: string;
                            email?: string;
                            githubId?: number;
                            id: string;
                            inviteCount?: number;
                            isBlocked?: boolean;
                            isStaff?: boolean;
                            name: string;
                            scopeLimit?: number;
                            scopeUsage?: number;
                            updatedAt: string;
                        };
                        ghActionsVerifyActor?: boolean;
                        quotas?: {
                            newPackagePerWeekLimit?: number;
                            newPackagePerWeekUsage?: number;
                            packageLimit?: number;
                            packageUsage?: number;
                            publishAttemptsPerWeekLimit?: number;
                            publishAttemptsPerWeekUsage?: number;
                        };
                        requirePublishingFromCI?: boolean;
                        scope: string;
                        updatedAt: string;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { code: string; message: string } };
                headers: { [name: string]: unknown };
            };
        };
    }

    List user's scopes

    Returns a list of scopes that a user is a member of

    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { id: string }
        • id: string

          The ID of the user

      • Optionalquery?: undefined
    • OptionalrequestBody?: undefined
    • responses: {
          "200": {
              content: {
                  "application/json": {
                      createdAt: string;
                      creator?: {
                          avatarUrl: string;
                          createdAt: string;
                          email?: string;
                          githubId?: number;
                          id: string;
                          inviteCount?: number;
                          isBlocked?: boolean;
                          isStaff?: boolean;
                          name: string;
                          scopeLimit?: number;
                          scopeUsage?: number;
                          updatedAt: string;
                      };
                      ghActionsVerifyActor?: boolean;
                      quotas?: {
                          newPackagePerWeekLimit?: number;
                          newPackagePerWeekUsage?: number;
                          packageLimit?: number;
                          packageUsage?: number;
                          publishAttemptsPerWeekLimit?: number;
                          publishAttemptsPerWeekUsage?: number;
                      };
                      requirePublishingFromCI?: boolean;
                      scope: string;
                      updatedAt: string;
                  }[];
              };
              headers: { [name: string]: unknown };
          };
          "404": {
              content: { "application/json": { code: string; message: string } };
              headers: { [name: string]: unknown };
          };
      }
      • 200: {
            content: {
                "application/json": {
                    createdAt: string;
                    creator?: {
                        avatarUrl: string;
                        createdAt: string;
                        email?: string;
                        githubId?: number;
                        id: string;
                        inviteCount?: number;
                        isBlocked?: boolean;
                        isStaff?: boolean;
                        name: string;
                        scopeLimit?: number;
                        scopeUsage?: number;
                        updatedAt: string;
                    };
                    ghActionsVerifyActor?: boolean;
                    quotas?: {
                        newPackagePerWeekLimit?: number;
                        newPackagePerWeekUsage?: number;
                        packageLimit?: number;
                        packageUsage?: number;
                        publishAttemptsPerWeekLimit?: number;
                        publishAttemptsPerWeekUsage?: number;
                    };
                    requirePublishingFromCI?: boolean;
                    scope: string;
                    updatedAt: string;
                }[];
            };
            headers: { [name: string]: unknown };
        }

        OK

      • 404: {
            content: { "application/json": { code: string; message: string } };
            headers: { [name: string]: unknown };
        }

        User not found

  • Optionalhead?: undefined
  • Optionaloptions?: undefined
  • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
  • Optionalpatch?: undefined
  • Optionalpost?: undefined
  • Optionalput?: undefined
  • Optionaltrace?: undefined